The AWS Availability Zone where this DevEndpoint is located.
The Amazon Web Services Availability Zone where this DevEndpoint is located.
The AWS Availability Zone where this DevEndpoint is located.
The Amazon Web Services Availability Zone where this DevEndpoint is located.
Retrieves all the development endpoints in this AWS account.
\nWhen you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address\n and the public IP address field is not populated. When you create a non-VPC development\n endpoint, Glue returns only a public IP address.
\nRetrieves all the development endpoints in this Amazon Web Services account.
\nWhen you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address\n and the public IP address field is not populated. When you create a non-VPC development\n endpoint, Glue returns only a public IP address.
\nReturns information on a job bookmark entry.
" + "smithy.api#documentation": "Returns information on a job bookmark entry.
\n\t\n\tFor more information about enabling and using job bookmarks, see:
\n\t\n\t\n Job structure\n
\nResets a bookmark entry.
" + "smithy.api#documentation": "Resets a bookmark entry.
\n\t\n\tFor more information about enabling and using job bookmarks, see:
\n\t\n\t\n Job structure\n
\nThe subject of the issuer certificate.
" + } + }, + "issuerId": { + "target": "com.amazonaws.iot#IssuerId", + "traits": { + "smithy.api#documentation": "The issuer ID.
" + } + }, + "issuerCertificateSerialNumber": { + "target": "com.amazonaws.iot#IssuerCertificateSerialNumber", + "traits": { + "smithy.api#documentation": "The issuer certificate serial number.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The certificate issuer indentifier.
" + } + }, + "com.amazonaws.iot#IssuerCertificateSerialNumber": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + }, + "smithy.api#pattern": "^[a-fA-F0-9:]+$" + } + }, + "com.amazonaws.iot#IssuerCertificateSubject": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^[\\p{Graph}\\x20]*$" + } + }, + "com.amazonaws.iot#IssuerId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^(0x)?[a-fA-F0-9]+$" + } + }, "com.amazonaws.iot#Job": { "type": "structure", "members": { @@ -21805,6 +21864,81 @@ } } }, + "com.amazonaws.iot#ListRelatedResourcesForAuditFinding": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#ListRelatedResourcesForAuditFindingRequest" + }, + "output": { + "target": "com.amazonaws.iot#ListRelatedResourcesForAuditFindingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "The related resources of an Audit finding. \n The following resources can be returned from calling this API:
\nDEVICE_CERTIFICATE
\nCA_CERTIFICATE
\nIOT_POLICY
\nCOGNITO_IDENTITY_POOL
\nCLIENT_ID
\nACCOUNT_SETTINGS
\nROLE_ALIAS
\nIAM_ROLE
\nISSUER_CERTIFICATE
\nThis API is similar to DescribeAuditFinding's RelatedResources \n but provides pagination and is not limited to 10 resources. \n When calling DescribeAuditFinding for the intermediate CA revoked for \n active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.
\nThe finding Id.
", + "smithy.api#httpQuery": "findingId", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "A token that can be used to retrieve the next set of results, \n or null if there are no additional results.
The maximum number of results to return at one time.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iot#ListRelatedResourcesForAuditFindingResponse": { + "type": "structure", + "members": { + "relatedResources": { + "target": "com.amazonaws.iot#RelatedResources", + "traits": { + "smithy.api#documentation": "The related resources.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "A token that can be used to retrieve the next set of results, \n or null for the first API call.
Lists your things. Use the attributeName and\n\t\t\t\tattributeValue parameters to filter your things.\n\t\t\tFor example, calling ListThings with attributeName=Color and\n\t\t\tattributeValue=Red retrieves all things in the registry that contain an attribute\n\t\t\t\tColor with the value Red.
Requires permission to access the ListThings action.
\n\t\t\n\t\tYou will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.
Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example,\n\t\t\tcalling ListThings with attributeName=Color and attributeValue=Red\n\t\t\tretrieves all things in the registry that contain an attribute Color with the value Red. For more\n\t\t\tinformation, see List Things from the Amazon Web Services IoT Core Developer\n\t\t\t\tGuide.
Requires permission to access the ListThings action.
\n\t\t\n\t\tYou will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.
The ARN of the role alias that has overly permissive actions.
" } + }, + "issuerCertificateIdentifier": { + "target": "com.amazonaws.iot#IssuerCertificateIdentifier", + "traits": { + "smithy.api#documentation": "The issuer certificate identifier.
" + } + }, + "deviceCertificateArn": { + "target": "com.amazonaws.iot#CertificateArn", + "traits": { + "smithy.api#documentation": "The ARN of the identified device certificate.
" + } } }, "traits": { @@ -26720,6 +26866,12 @@ "traits": { "smithy.api#enumValue": "IAM_ROLE" } + }, + "ISSUER_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISSUER_CERTIFICATE" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/license-manager.json b/codegen/sdk-codegen/aws-models/license-manager.json index a7eeb16f2fb..13ef9479ea7 100644 --- a/codegen/sdk-codegen/aws-models/license-manager.json +++ b/codegen/sdk-codegen/aws-models/license-manager.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -141,9 +141,15 @@ { "target": "com.amazonaws.licensemanager#ListReceivedGrants" }, + { + "target": "com.amazonaws.licensemanager#ListReceivedGrantsForOrganization" + }, { "target": "com.amazonaws.licensemanager#ListReceivedLicenses" }, + { + "target": "com.amazonaws.licensemanager#ListReceivedLicensesForOrganization" + }, { "target": "com.amazonaws.licensemanager#ListResourceInventory" }, @@ -194,6 +200,1812 @@ "smithy.api#title": "AWS License Manager", "smithy.api#xmlNamespace": { "uri": "https://license-manager.amazonaws.com/doc/2018_08_01" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://license-manager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://license-manager-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://license-manager.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://license-manager.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.eu-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "af-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "af-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.af-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "af-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.af-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "af-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-northeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "me-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.me-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.me-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "me-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "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": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "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": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-southeast-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-3", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-3", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://license-manager.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "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": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "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": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://license-manager.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" } } }, @@ -285,38 +2097,50 @@ } }, "com.amazonaws.licensemanager#AllowedOperation": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CreateGrant", - "name": "CREATE_GRANT" - }, - { - "value": "CheckoutLicense", - "name": "CHECKOUT_LICENSE" - }, - { - "value": "CheckoutBorrowLicense", - "name": "CHECKOUT_BORROW_LICENSE" - }, - { - "value": "CheckInLicense", - "name": "CHECK_IN_LICENSE" - }, - { - "value": "ExtendConsumptionLicense", - "name": "EXTEND_CONSUMPTION_LICENSE" - }, - { - "value": "ListPurchasedLicenses", - "name": "LIST_PURCHASED_LICENSES" - }, - { - "value": "CreateToken", - "name": "CREATE_TOKEN" + "type": "enum", + "members": { + "CREATE_GRANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateGrant" + } + }, + "CHECKOUT_LICENSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CheckoutLicense" + } + }, + "CHECKOUT_BORROW_LICENSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CheckoutBorrowLicense" + } + }, + "CHECK_IN_LICENSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CheckInLicense" + } + }, + "EXTEND_CONSUMPTION_LICENSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExtendConsumptionLicense" + } + }, + "LIST_PURCHASED_LICENSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ListPurchasedLicenses" + } + }, + "CREATE_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateToken" } - ] + } } }, "com.amazonaws.licensemanager#AllowedOperationList": { @@ -379,7 +2203,10 @@ } }, "com.amazonaws.licensemanager#Boolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.licensemanager#BorrowConfiguration": { "type": "structure", @@ -404,22 +2231,13 @@ } }, "com.amazonaws.licensemanager#BoxBoolean": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.licensemanager#BoxInteger": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.licensemanager#BoxLong": { - "type": "long", - "traits": { - "smithy.api#box": {} - } + "type": "long" }, "com.amazonaws.licensemanager#CheckInLicense": { "type": "operation", @@ -667,7 +2485,7 @@ } ], "traits": { - "smithy.api#documentation": "Checks out the specified license.
" + "smithy.api#documentation": "Checks out the specified license.
\nIf the account that created the license is the same that is performing the check out, you must\n specify the account as the beneficiary.
\nThe grant principals.
", + "smithy.api#documentation": "The grant principals. This value should be specified as an Amazon Resource Name (ARN).
", "smithy.api#required": {} } }, @@ -1274,14 +3094,14 @@ "SourceLicenseContext": { "target": "com.amazonaws.licensemanager#LicenseConversionContext", "traits": { - "smithy.api#documentation": "Information that identifies the license type you are converting from. \n For the structure of the source license, see Convert a license type using the AWS CLI in the License Manager User Guide.
", + "smithy.api#documentation": "Information that identifies the license type you are converting from. \n\n For the structure of the source license, see Convert a license type using the Amazon Web Services CLI in the License Manager User Guide.
", "smithy.api#required": {} } }, "DestinationLicenseContext": { "target": "com.amazonaws.licensemanager#LicenseConversionContext", "traits": { - "smithy.api#documentation": "Information that identifies the license type you are converting to. For the structure of the destination license, see Convert a license type using the AWS CLI in the License Manager User Guide.
", + "smithy.api#documentation": "Information that identifies the license type you are converting to. For the structure of the destination license, see Convert a license type using the Amazon Web Services CLI in the License Manager User Guide.
", "smithy.api#required": {} } } @@ -2081,14 +3901,14 @@ "members": {} }, "com.amazonaws.licensemanager#DigitalSignatureMethod": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "JWT_PS384", - "name": "JWT_PS384" + "type": "enum", + "members": { + "JWT_PS384": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JWT_PS384" } - ] + } } }, "com.amazonaws.licensemanager#Entitlement": { @@ -2172,118 +3992,170 @@ } }, "com.amazonaws.licensemanager#EntitlementDataUnit": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Count", - "name": "COUNT" - }, - { - "value": "None", - "name": "NONE" - }, - { - "value": "Seconds", - "name": "SECONDS" - }, - { - "value": "Microseconds", - "name": "MICROSECONDS" - }, - { - "value": "Milliseconds", - "name": "MILLISECONDS" - }, - { - "value": "Bytes", - "name": "BYTES" - }, - { - "value": "Kilobytes", - "name": "KILOBYTES" - }, - { - "value": "Megabytes", - "name": "MEGABYTES" - }, - { - "value": "Gigabytes", - "name": "GIGABYTES" - }, - { - "value": "Terabytes", - "name": "TERABYTES" - }, - { - "value": "Bits", - "name": "BITS" - }, - { - "value": "Kilobits", - "name": "KILOBITS" - }, - { - "value": "Megabits", - "name": "MEGABITS" - }, - { - "value": "Gigabits", - "name": "GIGABITS" - }, - { - "value": "Terabits", - "name": "TERABITS" - }, - { - "value": "Percent", - "name": "PERCENT" - }, - { - "value": "Bytes/Second", - "name": "BYTES_PER_SECOND" - }, - { - "value": "Kilobytes/Second", - "name": "KILOBYTES_PER_SECOND" - }, - { - "value": "Megabytes/Second", - "name": "MEGABYTES_PER_SECOND" - }, - { - "value": "Gigabytes/Second", - "name": "GIGABYTES_PER_SECOND" - }, - { - "value": "Terabytes/Second", - "name": "TERABYTES_PER_SECOND" - }, - { - "value": "Bits/Second", - "name": "BITS_PER_SECOND" - }, - { - "value": "Kilobits/Second", - "name": "KILOBITS_PER_SECOND" - }, - { - "value": "Megabits/Second", - "name": "MEGABITS_PER_SECOND" - }, - { - "value": "Gigabits/Second", - "name": "GIGABITS_PER_SECOND" - }, - { - "value": "Terabits/Second", - "name": "TERABITS_PER_SECOND" - }, - { - "value": "Count/Second", - "name": "COUNT_PER_SECOND" + "type": "enum", + "members": { + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "SECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Seconds" + } + }, + "MICROSECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Microseconds" + } + }, + "MILLISECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Milliseconds" + } + }, + "BYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes" + } + }, + "KILOBYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes" + } + }, + "MEGABYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes" + } + }, + "GIGABYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes" + } + }, + "TERABYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes" + } + }, + "BITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits" + } + }, + "KILOBITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits" + } + }, + "MEGABITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits" } - ] + }, + "GIGABITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits" + } + }, + "TERABITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits" + } + }, + "PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Percent" + } + }, + "BYTES_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes/Second" + } + }, + "KILOBYTES_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes/Second" + } + }, + "MEGABYTES_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes/Second" + } + }, + "GIGABYTES_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes/Second" + } + }, + "TERABYTES_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes/Second" + } + }, + "BITS_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits/Second" + } + }, + "KILOBITS_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits/Second" + } + }, + "MEGABITS_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits/Second" + } + }, + "GIGABITS_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits/Second" + } + }, + "TERABITS_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits/Second" + } + }, + "COUNT_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count/Second" + } + } } }, "com.amazonaws.licensemanager#EntitlementList": { @@ -2306,184 +4178,236 @@ } }, "com.amazonaws.licensemanager#EntitlementUnit": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Count", - "name": "COUNT" - }, - { - "value": "None", - "name": "NONE" - }, - { - "value": "Seconds", - "name": "SECONDS" - }, - { - "value": "Microseconds", - "name": "MICROSECONDS" - }, - { - "value": "Milliseconds", - "name": "MILLISECONDS" - }, - { - "value": "Bytes", - "name": "BYTES" - }, - { - "value": "Kilobytes", - "name": "KILOBYTES" - }, - { - "value": "Megabytes", - "name": "MEGABYTES" - }, - { - "value": "Gigabytes", - "name": "GIGABYTES" - }, - { - "value": "Terabytes", - "name": "TERABYTES" - }, - { - "value": "Bits", - "name": "BITS" - }, - { - "value": "Kilobits", - "name": "KILOBITS" - }, - { - "value": "Megabits", - "name": "MEGABITS" - }, - { - "value": "Gigabits", - "name": "GIGABITS" - }, - { - "value": "Terabits", - "name": "TERABITS" - }, - { - "value": "Percent", - "name": "PERCENT" - }, - { - "value": "Bytes/Second", - "name": "BYTES_PER_SECOND" - }, - { - "value": "Kilobytes/Second", - "name": "KILOBYTES_PER_SECOND" - }, - { - "value": "Megabytes/Second", - "name": "MEGABYTES_PER_SECOND" - }, - { - "value": "Gigabytes/Second", - "name": "GIGABYTES_PER_SECOND" - }, - { - "value": "Terabytes/Second", - "name": "TERABYTES_PER_SECOND" - }, - { - "value": "Bits/Second", - "name": "BITS_PER_SECOND" - }, - { - "value": "Kilobits/Second", - "name": "KILOBITS_PER_SECOND" - }, - { - "value": "Megabits/Second", - "name": "MEGABITS_PER_SECOND" - }, - { - "value": "Gigabits/Second", - "name": "GIGABITS_PER_SECOND" - }, - { - "value": "Terabits/Second", - "name": "TERABITS_PER_SECOND" - }, - { - "value": "Count/Second", - "name": "COUNT_PER_SECOND" - } - ] - } - }, - "com.amazonaws.licensemanager#EntitlementUsage": { - "type": "structure", + "type": "enum", "members": { - "Name": { - "target": "com.amazonaws.licensemanager#String", + "COUNT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Entitlement usage name.
", - "smithy.api#required": {} + "smithy.api#enumValue": "Count" } }, - "ConsumedValue": { - "target": "com.amazonaws.licensemanager#String", + "NONE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Resource usage consumed.
", - "smithy.api#required": {} + "smithy.api#enumValue": "None" } }, - "MaxCount": { - "target": "com.amazonaws.licensemanager#String", + "SECONDS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Maximum entitlement usage count.
" + "smithy.api#enumValue": "Seconds" } }, - "Unit": { - "target": "com.amazonaws.licensemanager#EntitlementDataUnit", + "MICROSECONDS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Entitlement usage unit.
", - "smithy.api#required": {} + "smithy.api#enumValue": "Microseconds" } - } - }, - "traits": { - "smithy.api#documentation": "Usage associated with an entitlement resource.
" - } - }, - "com.amazonaws.licensemanager#EntitlementUsageList": { - "type": "list", - "member": { - "target": "com.amazonaws.licensemanager#EntitlementUsage" - } - }, - "com.amazonaws.licensemanager#ExtendLicenseConsumption": { - "type": "operation", - "input": { - "target": "com.amazonaws.licensemanager#ExtendLicenseConsumptionRequest" - }, - "output": { - "target": "com.amazonaws.licensemanager#ExtendLicenseConsumptionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.licensemanager#AccessDeniedException" }, - { - "target": "com.amazonaws.licensemanager#AuthorizationException" + "MILLISECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Milliseconds" + } }, - { - "target": "com.amazonaws.licensemanager#InvalidParameterValueException" + "BYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes" + } }, - { - "target": "com.amazonaws.licensemanager#RateLimitExceededException" + "KILOBYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes" + } }, - { - "target": "com.amazonaws.licensemanager#ResourceNotFoundException" + "MEGABYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes" + } + }, + "GIGABYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes" + } + }, + "TERABYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes" + } + }, + "BITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits" + } + }, + "KILOBITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits" + } + }, + "MEGABITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits" + } + }, + "GIGABITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits" + } + }, + "TERABITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits" + } + }, + "PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Percent" + } + }, + "BYTES_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes/Second" + } + }, + "KILOBYTES_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes/Second" + } + }, + "MEGABYTES_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes/Second" + } + }, + "GIGABYTES_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes/Second" + } + }, + "TERABYTES_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes/Second" + } + }, + "BITS_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits/Second" + } + }, + "KILOBITS_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits/Second" + } + }, + "MEGABITS_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits/Second" + } + }, + "GIGABITS_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits/Second" + } + }, + "TERABITS_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits/Second" + } + }, + "COUNT_PER_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count/Second" + } + } + } + }, + "com.amazonaws.licensemanager#EntitlementUsage": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "Entitlement usage name.
", + "smithy.api#required": {} + } + }, + "ConsumedValue": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "Resource usage consumed.
", + "smithy.api#required": {} + } + }, + "MaxCount": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "Maximum entitlement usage count.
" + } + }, + "Unit": { + "target": "com.amazonaws.licensemanager#EntitlementDataUnit", + "traits": { + "smithy.api#documentation": "Entitlement usage unit.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Usage associated with an entitlement resource.
" + } + }, + "com.amazonaws.licensemanager#EntitlementUsageList": { + "type": "list", + "member": { + "target": "com.amazonaws.licensemanager#EntitlementUsage" + } + }, + "com.amazonaws.licensemanager#ExtendLicenseConsumption": { + "type": "operation", + "input": { + "target": "com.amazonaws.licensemanager#ExtendLicenseConsumptionRequest" + }, + "output": { + "target": "com.amazonaws.licensemanager#ExtendLicenseConsumptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.licensemanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.licensemanager#AuthorizationException" + }, + { + "target": "com.amazonaws.licensemanager#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.licensemanager#RateLimitExceededException" + }, + { + "target": "com.amazonaws.licensemanager#ResourceNotFoundException" }, { "target": "com.amazonaws.licensemanager#ServerInternalException" @@ -2509,6 +4433,7 @@ "DryRun": { "target": "com.amazonaws.licensemanager#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request. Provides an error response if you do not have the required permissions.
" } } @@ -3314,46 +5239,62 @@ } }, "com.amazonaws.licensemanager#GrantStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_WORKFLOW", - "name": "PENDING_WORKFLOW" - }, - { - "value": "PENDING_ACCEPT", - "name": "PENDING_ACCEPT" - }, - { - "value": "REJECTED", - "name": "REJECTED" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "FAILED_WORKFLOW", - "name": "FAILED_WORKFLOW" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "PENDING_DELETE", - "name": "PENDING_DELETE" - }, - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "WORKFLOW_COMPLETED", - "name": "WORKFLOW_COMPLETED" + "type": "enum", + "members": { + "PENDING_WORKFLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_WORKFLOW" + } + }, + "PENDING_ACCEPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_ACCEPT" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "FAILED_WORKFLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_WORKFLOW" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "PENDING_DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DELETE" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" } - ] + }, + "WORKFLOW_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKFLOW_COMPLETED" + } + } } }, "com.amazonaws.licensemanager#GrantedLicense": { @@ -3471,10 +5412,7 @@ } }, "com.amazonaws.licensemanager#Integer": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.licensemanager#InvalidParameterValueException": { "type": "structure", @@ -3539,26 +5477,32 @@ } }, "com.amazonaws.licensemanager#InventoryFilterCondition": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUALS", - "name": "EQUALS" - }, - { - "value": "NOT_EQUALS", - "name": "NOT_EQUALS" - }, - { - "value": "BEGINS_WITH", - "name": "BEGINS_WITH" - }, - { - "value": "CONTAINS", - "name": "CONTAINS" + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "NOT_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EQUALS" + } + }, + "BEGINS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEGINS_WITH" } - ] + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + } } }, "com.amazonaws.licensemanager#InventoryFilterList": { @@ -3855,18 +5799,20 @@ } }, "com.amazonaws.licensemanager#LicenseConfigurationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "DISABLED", - "name": "DISABLED" + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" } - ] + } } }, "com.amazonaws.licensemanager#LicenseConfigurationUsage": { @@ -4012,22 +5958,26 @@ } }, "com.amazonaws.licensemanager#LicenseConversionTaskStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "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" + } + } } }, "com.amazonaws.licensemanager#LicenseConversionTasks": { @@ -4037,41 +5987,49 @@ } }, "com.amazonaws.licensemanager#LicenseCountingType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "vCPU", - "name": "VCPU" - }, - { - "value": "Instance", - "name": "INSTANCE" - }, - { - "value": "Core", - "name": "CORE" - }, - { - "value": "Socket", - "name": "SOCKET" + "type": "enum", + "members": { + "VCPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vCPU" + } + }, + "INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance" + } + }, + "CORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Core" + } + }, + "SOCKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Socket" } - ] + } } }, "com.amazonaws.licensemanager#LicenseDeletionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_DELETE", - "name": "PENDING_DELETE" - }, - { - "value": "DELETED", - "name": "DELETED" + "type": "enum", + "members": { + "PENDING_DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DELETE" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" } - ] + } } }, "com.amazonaws.licensemanager#LicenseList": { @@ -4170,38 +6128,50 @@ } }, "com.amazonaws.licensemanager#LicenseStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "PENDING_AVAILABLE", - "name": "PENDING_AVAILABLE" - }, - { - "value": "DEACTIVATED", - "name": "DEACTIVATED" - }, - { - "value": "SUSPENDED", - "name": "SUSPENDED" - }, - { - "value": "EXPIRED", - "name": "EXPIRED" - }, - { - "value": "PENDING_DELETE", - "name": "PENDING_DELETE" - }, - { - "value": "DELETED", - "name": "DELETED" + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "PENDING_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_AVAILABLE" + } + }, + "DEACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATED" + } + }, + "SUSPENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSPENDED" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "PENDING_DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DELETE" } - ] + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } } }, "com.amazonaws.licensemanager#LicenseUsage": { @@ -4937,6 +6907,88 @@ "smithy.api#documentation": "Lists grants that are received but not accepted.
" } }, + "com.amazonaws.licensemanager#ListReceivedGrantsForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.licensemanager#ListReceivedGrantsForOrganizationRequest" + }, + "output": { + "target": "com.amazonaws.licensemanager#ListReceivedGrantsForOrganizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.licensemanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.licensemanager#AuthorizationException" + }, + { + "target": "com.amazonaws.licensemanager#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.licensemanager#RateLimitExceededException" + }, + { + "target": "com.amazonaws.licensemanager#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.licensemanager#ServerInternalException" + }, + { + "target": "com.amazonaws.licensemanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the grants received for all accounts in the organization.
" + } + }, + "com.amazonaws.licensemanager#ListReceivedGrantsForOrganizationRequest": { + "type": "structure", + "members": { + "LicenseArn": { + "target": "com.amazonaws.licensemanager#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the received license.
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.licensemanager#FilterList", + "traits": { + "smithy.api#documentation": "Filters to scope the results. The following filters are supported:
\n\n ParentArn\n
\n GranteePrincipalArn\n
Token for the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.licensemanager#MaxSize100", + "traits": { + "smithy.api#documentation": "Maximum number of results to return in a single call.
" + } + } + } + }, + "com.amazonaws.licensemanager#ListReceivedGrantsForOrganizationResponse": { + "type": "structure", + "members": { + "Grants": { + "target": "com.amazonaws.licensemanager#GrantList", + "traits": { + "smithy.api#documentation": "Lists the grants the organization has received.
" + } + }, + "NextToken": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "Token for the next set of results.
" + } + } + } + }, "com.amazonaws.licensemanager#ListReceivedGrantsRequest": { "type": "structure", "members": { @@ -5018,6 +7070,81 @@ "smithy.api#documentation": "Lists received licenses.
" } }, + "com.amazonaws.licensemanager#ListReceivedLicensesForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.licensemanager#ListReceivedLicensesForOrganizationRequest" + }, + "output": { + "target": "com.amazonaws.licensemanager#ListReceivedLicensesForOrganizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.licensemanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.licensemanager#AuthorizationException" + }, + { + "target": "com.amazonaws.licensemanager#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.licensemanager#RateLimitExceededException" + }, + { + "target": "com.amazonaws.licensemanager#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.licensemanager#ServerInternalException" + }, + { + "target": "com.amazonaws.licensemanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the licenses received for all accounts in the organization.
" + } + }, + "com.amazonaws.licensemanager#ListReceivedLicensesForOrganizationRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.licensemanager#FilterList", + "traits": { + "smithy.api#documentation": "Filters to scope the results. The following filters are supported:
\n\n Beneficiary\n
\n ProductSKU\n
Token for the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.licensemanager#MaxSize100", + "traits": { + "smithy.api#documentation": "Maximum number of results to return in a single call.
" + } + } + } + }, + "com.amazonaws.licensemanager#ListReceivedLicensesForOrganizationResponse": { + "type": "structure", + "members": { + "Licenses": { + "target": "com.amazonaws.licensemanager#GrantedLicenseList", + "traits": { + "smithy.api#documentation": "Lists the licenses the organization has received.
" + } + }, + "NextToken": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "Token for the next set of results.
" + } + } + } + }, "com.amazonaws.licensemanager#ListReceivedLicensesRequest": { "type": "structure", "members": { @@ -5349,10 +7476,7 @@ "type": "string" }, "com.amazonaws.licensemanager#Long": { - "type": "long", - "traits": { - "smithy.api#box": {} - } + "type": "long" }, "com.amazonaws.licensemanager#ManagedResourceSummary": { "type": "structure", @@ -5383,7 +7507,6 @@ "com.amazonaws.licensemanager#MaxSize100": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 @@ -5450,6 +7573,7 @@ "EnableIntegration": { "target": "com.amazonaws.licensemanager#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Enables Organizations integration.
", "smithy.api#required": {} } @@ -5592,42 +7716,56 @@ } }, "com.amazonaws.licensemanager#ReceivedStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_WORKFLOW", - "name": "PENDING_WORKFLOW" - }, - { - "value": "PENDING_ACCEPT", - "name": "PENDING_ACCEPT" - }, - { - "value": "REJECTED", - "name": "REJECTED" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "FAILED_WORKFLOW", - "name": "FAILED_WORKFLOW" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "WORKFLOW_COMPLETED", - "name": "WORKFLOW_COMPLETED" + "type": "enum", + "members": { + "PENDING_WORKFLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_WORKFLOW" + } + }, + "PENDING_ACCEPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_ACCEPT" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "FAILED_WORKFLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_WORKFLOW" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "WORKFLOW_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKFLOW_COMPLETED" } - ] + } } }, "com.amazonaws.licensemanager#RedirectException": { @@ -5720,22 +7858,26 @@ } }, "com.amazonaws.licensemanager#RenewType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "None", - "name": "NONE" - }, - { - "value": "Weekly", - "name": "WEEKLY" - }, - { - "value": "Monthly", - "name": "MONTHLY" + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "WEEKLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Weekly" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Monthly" } - ] + } } }, "com.amazonaws.licensemanager#ReportContext": { @@ -5774,22 +7916,26 @@ } }, "com.amazonaws.licensemanager#ReportFrequencyType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DAY", - "name": "DAY" - }, - { - "value": "WEEK", - "name": "WEEK" - }, - { - "value": "MONTH", - "name": "MONTH" + "type": "enum", + "members": { + "DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAY" } - ] + }, + "WEEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEK" + } + }, + "MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTH" + } + } } }, "com.amazonaws.licensemanager#ReportGenerator": { @@ -5894,18 +8040,20 @@ } }, "com.amazonaws.licensemanager#ReportType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LicenseConfigurationSummaryReport", - "name": "LICENSE_CONFIGURATION_SUMMARY_REPORT" - }, - { - "value": "LicenseConfigurationUsageReport", - "name": "LICENSE_CONFIGURATION_USAGE_REPORT" + "type": "enum", + "members": { + "LICENSE_CONFIGURATION_SUMMARY_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LicenseConfigurationSummaryReport" + } + }, + "LICENSE_CONFIGURATION_USAGE_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LicenseConfigurationUsageReport" } - ] + } } }, "com.amazonaws.licensemanager#ReportTypeList": { @@ -5999,30 +8147,38 @@ } }, "com.amazonaws.licensemanager#ResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EC2_INSTANCE", - "name": "EC2_INSTANCE" - }, - { - "value": "EC2_HOST", - "name": "EC2_HOST" - }, - { - "value": "EC2_AMI", - "name": "EC2_AMI" - }, - { - "value": "RDS", - "name": "RDS" - }, - { - "value": "SYSTEMS_MANAGER_MANAGED_INSTANCE", - "name": "SYSTEMS_MANAGER_MANAGED_INSTANCE" + "type": "enum", + "members": { + "EC2_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_INSTANCE" + } + }, + "EC2_HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_HOST" } - ] + }, + "EC2_AMI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_AMI" + } + }, + "RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS" + } + }, + "SYSTEMS_MANAGER_MANAGED_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEMS_MANAGER_MANAGED_INSTANCE" + } + } } }, "com.amazonaws.licensemanager#S3Location": { @@ -6240,14 +8396,14 @@ } }, "com.amazonaws.licensemanager#TokenType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "REFRESH_TOKEN", - "name": "REFRESH_TOKEN" + "type": "enum", + "members": { + "REFRESH_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REFRESH_TOKEN" } - ] + } } }, "com.amazonaws.licensemanager#UnsupportedDigitalSignatureMethodException": { diff --git a/codegen/sdk-codegen/aws-models/marketplace-catalog.json b/codegen/sdk-codegen/aws-models/marketplace-catalog.json index 2608187b943..a0ef5152eca 100644 --- a/codegen/sdk-codegen/aws-models/marketplace-catalog.json +++ b/codegen/sdk-codegen/aws-models/marketplace-catalog.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -41,21 +41,6 @@ }, "com.amazonaws.marketplacecatalog#AWSMPSeymour": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Marketplace Catalog", - "arnNamespace": "aws-marketplace", - "cloudFormationName": "MarketplaceCatalog", - "cloudTrailEventSource": "marketplacecatalog.amazonaws.com", - "endpointPrefix": "catalog.marketplace" - }, - "aws.auth#sigv4": { - "name": "aws-marketplace" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Catalog API actions allow you to manage your entities through list, describe, and update\n capabilities. An entity can be a product or an offer on AWS Marketplace.
\n\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" - }, "version": "2018-09-17", "operations": [ { @@ -73,10 +58,496 @@ { "target": "com.amazonaws.marketplacecatalog#ListEntities" }, + { + "target": "com.amazonaws.marketplacecatalog#ListTagsForResource" + }, { "target": "com.amazonaws.marketplacecatalog#StartChangeSet" + }, + { + "target": "com.amazonaws.marketplacecatalog#TagResource" + }, + { + "target": "com.amazonaws.marketplacecatalog#UntagResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Marketplace Catalog", + "arnNamespace": "aws-marketplace", + "cloudFormationName": "MarketplaceCatalog", + "cloudTrailEventSource": "marketplacecatalog.amazonaws.com", + "endpointPrefix": "catalog.marketplace" + }, + "aws.auth#sigv4": { + "name": "aws-marketplace" + }, + "aws.protocols#restJson1": {}, + "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", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://catalog.marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://catalog.marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://catalog.marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://catalog.marketplace.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://catalog.marketplace-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://catalog.marketplace-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://catalog.marketplace.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://catalog.marketplace.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://catalog.marketplace-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://catalog.marketplace-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://catalog.marketplace.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://catalog.marketplace.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" } - ] + } }, "com.amazonaws.marketplacecatalog#AccessDeniedException": { "type": "structure", @@ -193,6 +664,12 @@ "smithy.api#required": {} } }, + "EntityTags": { + "target": "com.amazonaws.marketplacecatalog#TagList", + "traits": { + "smithy.api#documentation": "The tags associated with the change.
" + } + }, "Details": { "target": "com.amazonaws.marketplacecatalog#Json", "traits": { @@ -291,7 +768,7 @@ "FailureCode": { "target": "com.amazonaws.marketplacecatalog#FailureCode", "traits": { - "smithy.api#documentation": "Returned if the change set is in FAILED status. Can be either \n CLIENT_ERROR, which means that there are issues with the request (see the \n ErrorDetailList of DescribeChangeSet), or SERVER_FAULT,\n which means that there is a problem in the system, and you should retry your request.
Returned if the change set is in FAILED status. Can be either\n CLIENT_ERROR, which means that there are issues with the request (see\n the ErrorDetailList of DescribeChangeSet), or\n SERVER_FAULT, which means that there is a problem in the system, and\n you should retry your request.
Returned if the change set is in FAILED status. Can be either \n CLIENT_ERROR, which means that there are issues with the request (see the \n ErrorDetailList), or SERVER_FAULT, which means that there is a \n problem in the system, and you should retry your request.
Returned if the change set is in FAILED status. Can be either\n CLIENT_ERROR, which means that there are issues with the request (see\n the ErrorDetailList), or SERVER_FAULT, which means that there\n is a problem in the system, and you should retry your request.
An entity contains data that describes your product, its supported features,\n and how it can be used or launched by your customer.
" + "smithy.api#documentation": "An entity contains data that describes your product, its supported features, and how\n it can be used or launched by your customer.
" } }, "com.amazonaws.marketplacecatalog#EntityNameString": { @@ -638,7 +1123,7 @@ "Name": { "target": "com.amazonaws.marketplacecatalog#EntityNameString", "traits": { - "smithy.api#documentation": "The name for the entity. This value is not unique. It is defined by the\n seller.
" + "smithy.api#documentation": "The name for the entity. This value is not unique. It is defined by the seller.
" } }, "EntityType": { @@ -668,7 +1153,7 @@ "Visibility": { "target": "com.amazonaws.marketplacecatalog#VisibilityValue", "traits": { - "smithy.api#documentation": "The visibility status of the entity to\n buyers.\n This value can be Public (everyone can view the entity),\n Limited (the entity is visible to limited accounts only), or\n Restricted (the entity was published and then unpublished and only\n existing\n buyers\n can view it).
The visibility status of the entity to buyers. This value can be Public\n (everyone can view the entity), Limited (the entity is visible to limited\n accounts only), or Restricted (the entity was published and then\n unpublished and only existing buyers can view it).
\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.
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", @@ -1026,10 +1513,72 @@ } } }, + "com.amazonaws.marketplacecatalog#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.marketplacecatalog#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.marketplacecatalog#ListTagsForResourceResponse" + }, + "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": "Lists all tags that have been added to a resource (either an entity or change set).
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListTagsForResource", + "code": 200 + } + } + }, + "com.amazonaws.marketplacecatalog#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.marketplacecatalog#ResourceARN", + "traits": { + "smithy.api#documentation": "Required. The Amazon Resource Name (ARN) associated with the resource you want to list\n tags on.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.marketplacecatalog#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.marketplacecatalog#ResourceARN", + "traits": { + "smithy.api#documentation": "Required. The ARN associated with the resource you want to list tags on.
" + } + }, + "Tags": { + "target": "com.amazonaws.marketplacecatalog#TagList", + "traits": { + "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#box": {}, "smithy.api#range": { "min": 1, "max": 20 @@ -1058,6 +1607,16 @@ } } }, + "com.amazonaws.marketplacecatalog#ResourceARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:aws-marketplace:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*$" + } + }, "com.amazonaws.marketplacecatalog#ResourceId": { "type": "string", "traits": { @@ -1132,7 +1691,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.
This operation allows you to request changes for your entities. Within a single\n ChangeSet, you cannot start the same change type against the same entity multiple times.\n Additionally, when a ChangeSet is running, all the entities targeted by the different\n changes are locked until the ChangeSet has completed (either succeeded, cancelled, or failed). If \n you try to start a ChangeSet containing a change against an entity that is already\n locked, you will receive a ResourceInUseException.
For example, you cannot start the ChangeSet described in the example later in this topic, because it contains two changes to execute the same change\n type (AddRevisions) against the same entity\n (entity-id@1).
For more information about working with change sets, see \n 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.
", "smithy.api#http": { "method": "POST", "uri": "/StartChangeSet", @@ -1240,6 +1801,12 @@ "smithy.api#documentation": "A unique token to identify the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } + }, + "ChangeSetTags": { + "target": "com.amazonaws.marketplacecatalog#TagList", + "traits": { + "smithy.api#documentation": "A list of objects specifying each key name and value for the\n ChangeSetTags property.
The key associated with the tag.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.marketplacecatalog#TagValue", + "traits": { + "smithy.api#documentation": "The value associated with the tag.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of objects specifying each key name and value.
" + } + }, + "com.amazonaws.marketplacecatalog#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.marketplacecatalog#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.marketplacecatalog#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.marketplacecatalog#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.marketplacecatalog#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.marketplacecatalog#TagResourceResponse" + }, + "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": "Tags a resource (either an entity or change set).
", + "smithy.api#http": { + "method": "POST", + "uri": "/TagResource", + "code": 200 + } + } + }, + "com.amazonaws.marketplacecatalog#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.marketplacecatalog#ResourceARN", + "traits": { + "smithy.api#documentation": "Required. The Amazon Resource Name (ARN) associated with the resource you want to\n tag.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.marketplacecatalog#TagList", + "traits": { + "smithy.api#documentation": "Required. A list of objects specifying each key name and value. Number of objects\n allowed: 1-50.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.marketplacecatalog#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.marketplacecatalog#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, "com.amazonaws.marketplacecatalog#ThrottlingException": { "type": "structure", "members": { @@ -1273,6 +1963,63 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.marketplacecatalog#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.marketplacecatalog#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.marketplacecatalog#UntagResourceResponse" + }, + "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": "Removes a tag or list of tags from a resource (either an entity or change set).
", + "smithy.api#http": { + "method": "POST", + "uri": "/UntagResource", + "code": 200 + } + } + }, + "com.amazonaws.marketplacecatalog#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.marketplacecatalog#ResourceARN", + "traits": { + "smithy.api#documentation": "Required. The Amazon Resource Name (ARN) associated with the resource you want to\n remove the tag from.
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.marketplacecatalog#TagKeyList", + "traits": { + "smithy.api#documentation": "Required. A list of key names of tags to be removed. Number of strings allowed:\n 0-256.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.marketplacecatalog#UntagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.marketplacecatalog#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/rekognition.json b/codegen/sdk-codegen/aws-models/rekognition.json index 77993b7c945..a77238e2005 100644 --- a/codegen/sdk-codegen/aws-models/rekognition.json +++ b/codegen/sdk-codegen/aws-models/rekognition.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -88,18 +88,20 @@ } }, "com.amazonaws.rekognition#Attribute": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DEFAULT", - "name": "DEFAULT" - }, - { - "value": "ALL", - "name": "ALL" + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" } - ] + } } }, "com.amazonaws.rekognition#Attributes": { @@ -152,6 +154,7 @@ "Value": { "target": "com.amazonaws.rekognition#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean value that indicates whether the face has beard or not.
" } }, @@ -187,26 +190,32 @@ } }, "com.amazonaws.rekognition#BodyPart": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FACE", - "name": "FACE" - }, - { - "value": "HEAD", - "name": "HEAD" - }, - { - "value": "LEFT_HAND", - "name": "LEFT_HAND" - }, - { - "value": "RIGHT_HAND", - "name": "RIGHT_HAND" + "type": "enum", + "members": { + "FACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACE" } - ] + }, + "HEAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEAD" + } + }, + "LEFT_HAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEFT_HAND" + } + }, + "RIGHT_HAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHT_HAND" + } + } } }, "com.amazonaws.rekognition#BodyParts": { @@ -216,7 +225,10 @@ } }, "com.amazonaws.rekognition#Boolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.rekognition#BoundingBox": { "type": "structure", @@ -247,13 +259,12 @@ } }, "traits": { - "smithy.api#documentation": "Identifies the bounding box around the label, face, text, object of interest, or personal protective equipment.\n The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and\n left sides of the bounding box. Note that the upper-left corner of the image is the origin\n (0,0).
The top and left values returned are ratios of the overall\n image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of\n the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700)\n and a top value of 0.25 (50/200).
The width and height values represent the dimensions of the\n bounding box as a ratio of the overall image dimension. For example, if the input image is\n 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.
The bounding box coordinates can have negative values. For example, if Amazon Rekognition is\n able to detect a face that is at the image edge and is only partially visible, the service\n can return coordinates that are outside the image bounds and, depending on the image edge,\n you might get negative values or values greater than 1 for the left or\n top values.
Identifies the bounding box around the label, face, text, object of interest, or\n personal protective equipment. The left (x-coordinate) and top\n (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note\n that the upper-left corner of the image is the origin (0,0).
The top and left values returned are ratios of the overall\n image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of\n the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700)\n and a top value of 0.25 (50/200).
The width and height values represent the dimensions of the\n bounding box as a ratio of the overall image dimension. For example, if the input image is\n 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.
The bounding box coordinates can have negative values. For example, if Amazon Rekognition is\n able to detect a face that is at the image edge and is only partially visible, the service\n can return coordinates that are outside the image bounds and, depending on the image edge,\n you might get negative values or values greater than 1 for the left or\n top values.
The time, in milliseconds from the start of the video, that the celebrity was recognized.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The time, in milliseconds from the start of the video, that the celebrity was recognized.\n Note that Timestamp is not guaranteed to be accurate to the individual frame where the celebrity first appears.
Compares a face in the source input image with\n each of the 100 largest faces detected in the target input image.\n
\n \nIf the source image contains multiple faces, the service detects the largest face\n and compares it with each face detected in the target image.
\n \n \nCompareFaces uses machine learning algorithms, which are probabilistic. \n A false negative is an incorrect prediction that\n a face in the target image has a low similarity confidence score when compared to the face\n in the source image. To reduce the probability of false negatives, \n we recommend that you compare the target image against multiple source images.\n If you plan to use CompareFaces to make a decision that impacts an individual's rights,\n privacy, or access to services, we recommend that you pass the result to a human for review and further\n validation before taking action.
You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file.
\nIn response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.
\n\nBy default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.
\n CompareFaces also returns an array of faces that don't match the source image. \n For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality.\n The response also returns information about the face in the source image, including the bounding box\n of the face and confidence value.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. Use QualityFilter to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE. The default value is NONE.
If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the\n source and target images. Use these values to display the images with the correct image orientation.
If no faces are detected in the source or target images, CompareFaces returns an \n InvalidParameterException error.
This is a stateless API operation. That is, data returned by this operation doesn't persist.
\nFor an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.
\nThis operation requires permissions to perform the rekognition:CompareFaces\n action.
Compares a face in the source input image with each of the 100\n largest faces detected in the target input image.
\nIf the source image contains multiple faces, the service detects the largest face and\n compares it with each face detected in the target image.
\nCompareFaces uses machine learning algorithms, which are probabilistic. A false negative\n is an incorrect prediction that a face in the target image has a low similarity confidence\n score when compared to the face in the source image. To reduce the probability of false\n negatives, we recommend that you compare the target image against multiple source images. If\n you plan to use CompareFaces to make a decision that impacts an individual's\n rights, privacy, or access to services, we recommend that you pass the result to a human for\n review and further validation before taking action.
You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file.
\nIn response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.
\nBy default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.
\n CompareFaces also returns an array of faces that don't match the source\n image. For each face, it returns a bounding box, confidence value, landmarks, pose details,\n and quality. The response also returns information about the face in the source image,\n including the bounding box of the face and confidence value.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar by specifying LOW,\n MEDIUM, or HIGH. If you do not want to filter detected faces,\n specify NONE. The default value is NONE.
If the image doesn't contain Exif metadata, CompareFaces returns\n orientation information for the source and target images. Use these values to display the\n images with the correct image orientation.
If no faces are detected in the source or target images, CompareFaces\n returns an InvalidParameterException error.
This is a stateless API operation. That is, data returned by this operation doesn't\n persist.
\nFor an example, see Comparing Faces in Images in the Amazon Rekognition Developer\n Guide.
\nThis operation requires permissions to perform the\n rekognition:CompareFaces action.
The input image as base64-encoded bytes or an S3 object.\n If you use the AWS CLI to call Amazon Rekognition operations,\n passing base64-encoded image bytes is not supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the Bytes field. \n For more information, see Images in the Amazon Rekognition developer guide.
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to\n call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to\n base64-encode image bytes passed using the Bytes field. For more information, see\n Images in the Amazon Rekognition developer guide.
The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to\n call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.\n
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the Bytes field. \n For more information, see Images in the Amazon Rekognition developer guide.
The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to\n call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to\n base64-encode image bytes passed using the Bytes field. For more information, see\n Images in the Amazon Rekognition developer guide.
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 quality bar.\n If you specify LOW, \n MEDIUM, or HIGH, filtering removes all faces that\n don’t meet the chosen quality bar.\n \n The quality bar is based on a variety of common use cases. Low-quality\n detections can occur for a number of reasons. Some examples are an object that's misidentified\n as a face, a face that's too blurry, or a face with a\n pose that's too extreme to use. If you specify NONE, no\n filtering is performed. The default value is NONE.\n
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
" + "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.
" } } } @@ -553,13 +566,13 @@ "SourceImageOrientationCorrection": { "target": "com.amazonaws.rekognition#OrientationCorrection", "traits": { - "smithy.api#documentation": "The value of SourceImageOrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction. The bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata.
\nAmazon Rekognition doesn’t perform image correction for images in .png format and\n .jpeg images without orientation information in the image Exif metadata. The bounding box\n coordinates aren't translated and represent the object locations before the image is rotated.\n
" + "smithy.api#documentation": "The value of SourceImageOrientationCorrection 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.
" } }, "TargetImageOrientationCorrection": { "target": "com.amazonaws.rekognition#OrientationCorrection", "traits": { - "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 (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction. The bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata.
\nAmazon Rekognition doesn’t perform image correction for images in .png format and\n .jpeg images without orientation information in the image Exif metadata. The bounding box\n coordinates aren't translated and represent the object locations before the image is rotated.\n
" + "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.
" } } } @@ -606,13 +619,13 @@ "Emotions": { "target": "com.amazonaws.rekognition#Emotions", "traits": { - "smithy.api#documentation": "The emotions that appear to be expressed on the face, \n and the confidence level in the determination. Valid values include \"Happy\", \"Sad\", \n \"Angry\", \"Confused\", \"Disgusted\", \"Surprised\", \"Calm\", \"Unknown\", and \"Fear\".\n
" + "smithy.api#documentation": "The emotions that appear to be expressed on the face, and the confidence level in the\n determination. Valid values include \"Happy\", \"Sad\", \"Angry\", \"Confused\", \"Disgusted\",\n \"Surprised\", \"Calm\", \"Unknown\", and \"Fear\".
" } }, "Smile": { "target": "com.amazonaws.rekognition#Smile", "traits": { - "smithy.api#documentation": "Indicates whether or not the face is smiling, and the confidence level in the determination. \n
" + "smithy.api#documentation": "Indicates whether or not the face is smiling, and the confidence level in the\n determination.
" } } }, @@ -703,18 +716,20 @@ } }, "com.amazonaws.rekognition#ContentClassifier": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FreeOfPersonallyIdentifiableInformation", - "name": "FREE_OF_PERSONALLY_IDENTIFIABLE_INFORMATION" - }, - { - "value": "FreeOfAdultContent", - "name": "FREE_OF_ADULT_CONTENT" + "type": "enum", + "members": { + "FREE_OF_PERSONALLY_IDENTIFIABLE_INFORMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeOfPersonallyIdentifiableInformation" } - ] + }, + "FREE_OF_ADULT_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeOfAdultContent" + } + } } }, "com.amazonaws.rekognition#ContentClassifiers": { @@ -735,7 +750,8 @@ "Timestamp": { "target": "com.amazonaws.rekognition#Timestamp", "traits": { - "smithy.api#documentation": "Time, in milliseconds from the beginning of the video, that the content moderation label was detected.
" + "smithy.api#default": 0, + "smithy.api#documentation": "Time, in milliseconds from the beginning of the video, that the content moderation label was detected.\n Note that Timestamp is not guaranteed to be accurate to the individual frame where the moderated content first appears.
True if the PPE covers the corresponding body part, otherwise false.
" } } @@ -926,7 +945,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a collection in an AWS Region. You can add faces to the collection using the\n IndexFaces operation.
\nFor example, you might create collections, one for each of your application users. A\n user can then index faces using the IndexFaces operation and persist results in a\n specific collection. Then, a user can search the collection for faces in the user-specific\n container.
When you create a collection, it is associated with the latest version of the face model version.
\nCollection names are case-sensitive.
\nThis operation requires permissions to perform the\n rekognition:CreateCollection action. If you want to tag your collection, you also require permission to perform the rekognition:TagResource operation.
Creates a collection in an AWS Region. You can add faces to the collection using the\n IndexFaces operation.
\nFor example, you might create collections, one for each of your application users. A\n user can then index faces using the IndexFaces operation and persist results in a\n specific collection. Then, a user can search the collection for faces in the user-specific\n container.
When you create a collection, it is associated with the latest version of the face model\n version.
\nCollection names are case-sensitive.
\nThis operation requires permissions to perform the\n rekognition:CreateCollection action. If you want to tag your collection, you\n also require permission to perform the rekognition:TagResource\n operation.
\n A set of tags (key-value pairs) that you want to attach to the collection.\n
" + "smithy.api#documentation": "A set of tags (key-value pairs) that you want to attach to the collection.
" } } } @@ -965,7 +984,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "Version number of the face detection model associated with the collection you are creating.
" + "smithy.api#documentation": "Version number of the face detection model associated with the collection you are\n creating.
" } } } @@ -1185,7 +1204,7 @@ "Tags": { "target": "com.amazonaws.rekognition#TagMap", "traits": { - "smithy.api#documentation": "\n A set of tags (key-value pairs) that you want to attach to the model.\n
" + "smithy.api#documentation": "A set of tags (key-value pairs) that you want to attach to the model.
" } }, "KmsKeyId": { @@ -1286,7 +1305,7 @@ "Tags": { "target": "com.amazonaws.rekognition#TagMap", "traits": { - "smithy.api#documentation": "\n A set of tags (key-value pairs) that you want to attach to the stream processor.\n
" + "smithy.api#documentation": "A set of tags (key-value pairs) that you want to attach to the stream processor.
" } }, "NotificationChannel": { @@ -1608,72 +1627,90 @@ } }, "com.amazonaws.rekognition#DatasetStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "CREATE_COMPLETE", - "name": "CREATE_COMPLETE" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "UPDATE_IN_PROGRESS", - "name": "UPDATE_IN_PROGRESS" - }, - { - "value": "UPDATE_COMPLETE", - "name": "UPDATE_COMPLETE" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_COMPLETE" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_COMPLETE" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" } - ] + } } }, "com.amazonaws.rekognition#DatasetStatusMessageCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "SERVICE_ERROR", - "name": "SERVICE_ERROR" - }, - { - "value": "CLIENT_ERROR", - "name": "CLIENT_ERROR" + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_ERROR" + } + }, + "CLIENT_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIENT_ERROR" } - ] + } } }, "com.amazonaws.rekognition#DatasetType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRAIN", - "name": "TRAIN" - }, - { - "value": "TEST", - "name": "TEST" + "type": "enum", + "members": { + "TRAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAIN" } - ] + }, + "TEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEST" + } + } } }, "com.amazonaws.rekognition#DateTime": { @@ -1682,7 +1719,6 @@ "com.amazonaws.rekognition#Degree": { "type": "float", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": -180, "max": 180 @@ -1718,7 +1754,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified collection. Note that this operation\n removes all faces in the collection. For an example, see Deleting a collection.
\n\nThis operation requires permissions to perform the\n rekognition:DeleteCollection action.
Deletes the specified collection. Note that this operation removes all faces in the\n collection. For an example, see Deleting a\n collection.
\nThis operation requires permissions to perform the\n rekognition:DeleteCollection action.
Detects faces within an image that is provided as input.
\n\n\n DetectFaces detects the 100 largest faces in the image. For each face\n detected, the operation returns face details. These details include a bounding box of the\n face, a confidence value (that the bounding box contains a face), and a fixed set of\n attributes such as facial landmarks (for example, coordinates of eye and mouth),\n presence of beard, sunglasses, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or\n obscured faces, the algorithm might not detect the faces or might detect faces with lower\n confidence.
\nYou pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI\n to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n\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:DetectFaces action.
Detects faces within an image that is provided as input.
\n\n DetectFaces detects the 100 largest faces in the image. For each face\n detected, the operation returns face details. These details include a bounding box of the\n face, a confidence value (that the bounding box contains a face), and a fixed set of\n attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of\n beard, sunglasses, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or\n obscured faces, the algorithm might not detect the faces or might detect faces with lower\n confidence.
\nYou pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
\nThis is a stateless API operation. That is, the operation does not persist any\n data.
\nThis operation requires permissions to perform the rekognition:DetectFaces\n action.
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call\n Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the Bytes field. \n For more information, see Images in the Amazon Rekognition developer guide.
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to\n call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to\n base64-encode image bytes passed using the Bytes field. For more information, see\n Images in the Amazon Rekognition developer guide.
The value of OrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction. The bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata.
\nAmazon Rekognition doesn’t perform image correction for images in .png format and\n .jpeg images without orientation information in the image Exif metadata. The bounding box\n coordinates aren't translated and represent the object locations before the image is rotated.\n
" + "smithy.api#documentation": "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.
" } } } @@ -2765,7 +2801,159 @@ } ], "traits": { - "smithy.api#documentation": "Detects instances of real-world entities within an image (JPEG or PNG)\n provided as input. This includes objects like flower, tree, and table; events like\n wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.\n
\n \nFor an example, see Analyzing images stored in an Amazon S3 bucket in the Amazon Rekognition Developer Guide.
\n\n DetectLabels does not support the detection of activities. However, activity detection\n is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.
You 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.
\nFor each object, scene, and concept the API returns one or more labels. Each label\n provides the object name, and the level of confidence that the image contains the object. For\n example, suppose the input image has a lighthouse, the sea, and a rock. The response includes\n all three labels, one for each object.
\n \n\n {Name: lighthouse, Confidence: 98.4629}\n
\n {Name: rock,Confidence: 79.2097}\n
\n {Name: sea,Confidence: 75.061}\n
In the preceding example, the operation returns one label for each of the three\n objects. The operation can also return multiple labels for the same object in the image. For\n example, if the input image shows a flower (for example, a tulip), the operation might return\n the following 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.
\nIn response, the API returns an array of labels. In addition, the response also\n includes the orientation correction. Optionally, you can specify MinConfidence to\n control the confidence threshold for the labels returned. The default is 55%. You can also add\n the MaxLabels parameter to limit the number of labels returned.
If the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.
\n\n DetectLabels returns bounding boxes for instances of common object labels in an array of\n Instance objects. An Instance object contains a \n BoundingBox object, for the location of the label on the image. It also includes \n the confidence by which the bounding box was detected.
\n DetectLabels also returns a hierarchical taxonomy of detected labels. For example,\n a detected car might be assigned the label car. The label car\n has two parent labels: Vehicle (its parent) and Transportation (its\n grandparent). \n The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response.\n In the previous example, Car, Vehicle, and Transportation\n are returned as unique labels in the response.\n
This 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.
\n \nFor an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.
\n \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. A given label\n can belong to more than one category.
\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 and Brightness of the input image’s\n foreground.
\nBackground - Information about the Sharpness and Brightness of the input image’s\n 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.
The quality of the image background as defined by brightness and sharpness.
" + } + }, + "DominantColors": { + "target": "com.amazonaws.rekognition#DominantColors", + "traits": { + "smithy.api#documentation": "The dominant colors found in the background of an image, defined with RGB values, \n CSS color name, simplified color name, and PixelPercentage (the percentage of \n image pixels that have a particular color).
" + } + } + }, + "traits": { + "smithy.api#documentation": "The background of the image with regard to image quality and dominant colors.
" + } + }, + "com.amazonaws.rekognition#DetectLabelsImageForeground": { + "type": "structure", + "members": { + "Quality": { + "target": "com.amazonaws.rekognition#DetectLabelsImageQuality", + "traits": { + "smithy.api#documentation": "The quality of the image foreground as defined by brightness and sharpness.
" + } + }, + "DominantColors": { + "target": "com.amazonaws.rekognition#DominantColors", + "traits": { + "smithy.api#documentation": "The dominant colors found in the foreground of an image, defined with RGB values, \n CSS color name, simplified color name, and PixelPercentage (the percentage of image \n pixels that have a particular color).
" + } + } + }, + "traits": { + "smithy.api#documentation": "The foreground of the image with regard to image quality and dominant colors.
" + } + }, + "com.amazonaws.rekognition#DetectLabelsImageProperties": { + "type": "structure", + "members": { + "Quality": { + "target": "com.amazonaws.rekognition#DetectLabelsImageQuality", + "traits": { + "smithy.api#documentation": "Information about the quality of the image foreground as defined by brightness, \n sharpness, and contrast. The higher the value the greater the brightness, \n sharpness, and contrast respectively.
" + } + }, + "DominantColors": { + "target": "com.amazonaws.rekognition#DominantColors", + "traits": { + "smithy.api#documentation": "Information about the dominant colors found in an image, described with RGB values, \n CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels \n that have a particular color).
" + } + }, + "Foreground": { + "target": "com.amazonaws.rekognition#DetectLabelsImageForeground", + "traits": { + "smithy.api#documentation": "Information about the properties of an image’s foreground, including the \n foreground’s quality and dominant colors, including the quality and dominant colors of the image.
" + } + }, + "Background": { + "target": "com.amazonaws.rekognition#DetectLabelsImageBackground", + "traits": { + "smithy.api#documentation": "Information about the properties of an image’s background, including \n the background’s quality and dominant colors, including the quality \n and dominant colors of the image.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the quality and dominant colors of an input image. \n Quality and color information is returned for the entire image, foreground, and background.
" + } + }, + "com.amazonaws.rekognition#DetectLabelsImagePropertiesSettings": { + "type": "structure", + "members": { + "MaxDominantColors": { + "target": "com.amazonaws.rekognition#DetectLabelsMaxDominantColors", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of dominant colors to return when detecting labels in an image. The default value is 10.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for the IMAGE_PROPERTIES feature type.
" + } + }, + "com.amazonaws.rekognition#DetectLabelsImageQuality": { + "type": "structure", + "members": { + "Brightness": { + "target": "com.amazonaws.rekognition#Float", + "traits": { + "smithy.api#documentation": "The brightness of an image provided for label detection.
" + } + }, + "Sharpness": { + "target": "com.amazonaws.rekognition#Float", + "traits": { + "smithy.api#documentation": "The sharpness of an image provided for label detection.
" + } + }, + "Contrast": { + "target": "com.amazonaws.rekognition#Float", + "traits": { + "smithy.api#documentation": "The contrast of an image provided for label detection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The quality of an image provided for label detection, with regard to brightness, sharpness, and contrast.
" + } + }, + "com.amazonaws.rekognition#DetectLabelsMaxDominantColors": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 20 + } } }, "com.amazonaws.rekognition#DetectLabelsRequest": { @@ -2774,7 +2962,7 @@ "Image": { "target": "com.amazonaws.rekognition#Image", "traits": { - "smithy.api#documentation": "The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call\n Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do\n not need to be base64-encoded.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the Bytes field. \n For more information, see Images in the Amazon Rekognition developer guide.
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to\n call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an\n S3 Bucket do not need to be base64-encoded.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to\n base64-encode image bytes passed using the Bytes field. For more information, see\n Images in the Amazon Rekognition developer guide.
Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't\n return any labels with confidence lower than this specified value.
\nIf MinConfidence is not specified, the operation returns labels with a\n confidence values greater than or equal to 55 percent.
A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection \n feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality. \n If no option is specified GENERAL_LABELS is used by default.
" + } + }, + "Settings": { + "target": "com.amazonaws.rekognition#DetectLabelsSettings", + "traits": { + "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 LINK HERE.
" + } } } }, @@ -2804,7 +3004,7 @@ "OrientationCorrection": { "target": "com.amazonaws.rekognition#OrientationCorrection", "traits": { - "smithy.api#documentation": "The value of OrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction. The bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata.
\nAmazon Rekognition doesn’t perform image correction for images in .png format and\n .jpeg images without orientation information in the image Exif metadata. The bounding box\n coordinates aren't translated and represent the object locations before the image is rotated.\n
" + "smithy.api#documentation": "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.
" } }, "LabelModelVersion": { @@ -2812,7 +3012,33 @@ "traits": { "smithy.api#documentation": "Version number of the label detection model that was used to detect labels.
" } + }, + "ImageProperties": { + "target": "com.amazonaws.rekognition#DetectLabelsImageProperties", + "traits": { + "smithy.api#documentation": "Information about the properties of the input image, such as brightness, sharpness, contrast, and dominant colors.
" + } + } + } + }, + "com.amazonaws.rekognition#DetectLabelsSettings": { + "type": "structure", + "members": { + "GeneralLabels": { + "target": "com.amazonaws.rekognition#GeneralLabelsSettings", + "traits": { + "smithy.api#documentation": "Contains the specified filters for GENERAL_LABELS.
" + } + }, + "ImageProperties": { + "target": "com.amazonaws.rekognition#DetectLabelsImagePropertiesSettings", + "traits": { + "smithy.api#documentation": "Contains the chosen number of maximum dominant colors in an image.
" + } } + }, + "traits": { + "smithy.api#documentation": "Settings for the DetectLabels request. Settings can include \n filters for both GENERAL_LABELS and IMAGE_PROPERTIES. GENERAL_LABELS filters can be inclusive \n or exclusive and applied to individual labels or label categories. IMAGE_PROPERTIES filters \n allow specification of a maximum number of dominant colors.
" } }, "com.amazonaws.rekognition#DetectModerationLabels": { @@ -2853,7 +3079,7 @@ } ], "traits": { - "smithy.api#documentation": "Detects unsafe content in a specified JPEG or PNG format image.\n Use DetectModerationLabels to moderate images depending on your requirements.\n For example, you might want to filter images that contain nudity, but not images containing\n suggestive content.
To filter images, use the labels returned by DetectModerationLabels\n to determine which types of content are appropriate.
For information about moderation labels,\n see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
\nYou pass the input image either as base64-encoded image bytes or as a reference to an\n image in 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.
" + "smithy.api#documentation": "Detects unsafe content in a specified JPEG or PNG format image. Use\n DetectModerationLabels to moderate images depending on your requirements. For\n example, you might want to filter images that contain nudity, but not images containing\n suggestive content.
To filter images, use the labels returned by DetectModerationLabels to\n determine which types of content are appropriate.
For information about moderation labels, see Detecting Unsafe Content in the\n Amazon Rekognition Developer Guide.
\nYou pass the input image either as base64-encoded image bytes or as a reference to an\n image in 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.
" } }, "com.amazonaws.rekognition#DetectModerationLabelsRequest": { @@ -2862,7 +3088,7 @@ "Image": { "target": "com.amazonaws.rekognition#Image", "traits": { - "smithy.api#documentation": "The input image as base64-encoded bytes or an S3 object.\n If you use the AWS CLI to call Amazon Rekognition operations,\n passing base64-encoded image bytes is not supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the Bytes field. \n For more information, see Images in the Amazon Rekognition developer guide.
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to\n call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to\n base64-encode image bytes passed using the Bytes field. For more information, see\n Images in the Amazon Rekognition developer guide.
Sets up the configuration for human evaluation, including the FlowDefinition\n the image will be sent to.
" + "smithy.api#documentation": "Sets up the configuration for human evaluation, including the FlowDefinition the image\n will be sent to.
" } } } @@ -2886,13 +3112,13 @@ "ModerationLabels": { "target": "com.amazonaws.rekognition#ModerationLabels", "traits": { - "smithy.api#documentation": "Array of detected Moderation labels and the time, in milliseconds from the\n start of the video, they were detected.
" + "smithy.api#documentation": "Array of detected Moderation labels and the time, in milliseconds from the start of the\n video, they were detected.
" } }, "ModerationModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "Version number of the moderation detection model that was used to detect unsafe content.
" + "smithy.api#documentation": "Version number of the moderation detection model that was used to detect unsafe\n content.
" } }, "HumanLoopActivationOutput": { @@ -3017,7 +3243,7 @@ } ], "traits": { - "smithy.api#documentation": "Detects text in the input image and converts it into machine-readable text.
\nPass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file.
\nThe DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.
A word is one or more script characters that are not separated by spaces.\n DetectText can detect up to 100 words in an image.
A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.
To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.
To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.
\n \nFor more information, see Detecting text in the Amazon Rekognition Developer Guide.
" + "smithy.api#documentation": "Detects text in the input image and converts it into machine-readable text.
\nPass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file.
\nThe DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.
A word is one or more script characters that are not separated by spaces.\n DetectText can detect up to 100 words in an image.
A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.
To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.
To be detected, text must be within +/- 90 degrees orientation of the horizontal\n axis.
\n \nFor more information, see Detecting text in the Amazon Rekognition Developer\n Guide.
" } }, "com.amazonaws.rekognition#DetectTextFilters": { @@ -3029,12 +3255,12 @@ "RegionsOfInterest": { "target": "com.amazonaws.rekognition#RegionsOfInterest", "traits": { - "smithy.api#documentation": " A Filter focusing on a certain area of the image. Uses a BoundingBox object to set the region\n of the image.
A Filter focusing on a certain area of the image. Uses a BoundingBox object\n to set the region of the image.
A set of optional parameters that you can use to set the criteria that the text must meet to be included in your response. \n WordFilter looks at a word’s height, width, and minimum confidence. RegionOfInterest\n lets you set a specific region of the image to look for text in.\n
A set of optional parameters that you can use to set the criteria that the text must meet\n to be included in your response. WordFilter looks at a word’s height, width, and\n minimum confidence. RegionOfInterest lets you set a specific region of the image\n to look for text in.
The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI\n to call Amazon Rekognition operations, you can't pass image bytes.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the Bytes field. \n For more information, see Images in the Amazon Rekognition developer guide.
The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS\n CLI to call Amazon Rekognition operations, you can't pass image bytes.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to\n base64-encode image bytes passed using the Bytes field. For more information, see\n Images in the Amazon Rekognition developer guide.
Optional parameters that let you set the criteria that the text must meet to be included in your response.
" + "smithy.api#documentation": "Optional parameters that let you set the criteria that the text must meet to be included\n in your response.
" } } } @@ -3176,67 +3402,139 @@ } } }, - "com.amazonaws.rekognition#Emotion": { + "com.amazonaws.rekognition#DominantColor": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.rekognition#EmotionName", + "Red": { + "target": "com.amazonaws.rekognition#UInteger", "traits": { - "smithy.api#documentation": "Type of emotion detected.
" + "smithy.api#documentation": "The Red RGB value for a dominant color.
" } }, - "Confidence": { - "target": "com.amazonaws.rekognition#Percent", + "Blue": { + "target": "com.amazonaws.rekognition#UInteger", "traits": { - "smithy.api#documentation": "Level of confidence in the determination.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The emotions that appear to be expressed on the face, and the confidence level in the determination. \n The API is only making a determination of the physical appearance of a person's face. It is not a determination\n of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have\n a sad face might not be sad emotionally.
" - } - }, - "com.amazonaws.rekognition#EmotionName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HAPPY", - "name": "HAPPY" - }, - { - "value": "SAD", - "name": "SAD" - }, - { - "value": "ANGRY", - "name": "ANGRY" - }, - { - "value": "CONFUSED", - "name": "CONFUSED" - }, - { - "value": "DISGUSTED", - "name": "DISGUSTED" - }, - { - "value": "SURPRISED", - "name": "SURPRISED" - }, - { - "value": "CALM", - "name": "CALM" - }, - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "FEAR", - "name": "FEAR" + "smithy.api#documentation": "The Blue RGB value for a dominant color.
" } - ] + }, + "Green": { + "target": "com.amazonaws.rekognition#UInteger", + "traits": { + "smithy.api#documentation": "The Green RGB value for a dominant color.
" + } + }, + "HexCode": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "The Hex code equivalent of the RGB values for a dominant color.
" + } + }, + "CSSColor": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "The CSS color name of a dominant color.
" + } + }, + "SimplifiedColor": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "One of 12 simplified color names applied to a dominant color.
" + } + }, + "PixelPercent": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "The percentage of image pixels that have a given dominant color.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A description of the dominant colors in an image.
" + } + }, + "com.amazonaws.rekognition#DominantColors": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#DominantColor" + } + }, + "com.amazonaws.rekognition#Emotion": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.rekognition#EmotionName", + "traits": { + "smithy.api#documentation": "Type of emotion detected.
" + } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "Level of confidence in the determination.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The emotions that appear to be expressed on the face, and the confidence level in the\n determination. The API is only making a determination of the physical appearance of a person's\n face. It is not a determination of the person’s internal emotional state and should not be\n used in such a way. For example, a person pretending to have a sad face might not be sad\n emotionally.
" + } + }, + "com.amazonaws.rekognition#EmotionName": { + "type": "enum", + "members": { + "HAPPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HAPPY" + } + }, + "SAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAD" + } + }, + "ANGRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANGRY" + } + }, + "CONFUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFUSED" + } + }, + "DISGUSTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISGUSTED" + } + }, + "SURPRISED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SURPRISED" + } + }, + "CALM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALM" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + }, + "FEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FEAR" + } + } } }, "com.amazonaws.rekognition#Emotions": { @@ -3328,6 +3626,7 @@ "Value": { "target": "com.amazonaws.rekognition#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean value that indicates whether the eyes on the face are open.
" } }, @@ -3348,6 +3647,7 @@ "Value": { "target": "com.amazonaws.rekognition#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean value that indicates whether the face is wearing eye glasses or not.
" } }, @@ -3398,7 +3698,7 @@ "IndexFacesModelVersion": { "target": "com.amazonaws.rekognition#IndexFacesModelVersion", "traits": { - "smithy.api#documentation": "\n The version of the face detect and storage model that was used when indexing the face vector.\n
" + "smithy.api#documentation": "The version of the face detect and storage model that was used when indexing the face\n vector.
" } } }, @@ -3407,18 +3707,20 @@ } }, "com.amazonaws.rekognition#FaceAttributes": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DEFAULT", - "name": "DEFAULT" - }, - { - "value": "ALL", - "name": "ALL" + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" } - ] + } } }, "com.amazonaws.rekognition#FaceDetail": { @@ -3457,7 +3759,7 @@ "Gender": { "target": "com.amazonaws.rekognition#Gender", "traits": { - "smithy.api#documentation": "The predicted gender of a detected face.\n
" + "smithy.api#documentation": "The predicted gender of a detected face.
" } }, "Beard": { @@ -3487,7 +3789,7 @@ "Emotions": { "target": "com.amazonaws.rekognition#Emotions", "traits": { - "smithy.api#documentation": "The emotions that appear to be expressed on the face, and the confidence level in the determination. \n The API is only making a determination of the physical appearance of a person's face. It is not a determination\n of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have\n a sad face might not be sad emotionally.
" + "smithy.api#documentation": "The emotions that appear to be expressed on the face, and the confidence level in the\n determination. The API is only making a determination of the physical appearance of a person's\n face. It is not a determination of the person’s internal emotional state and should not be\n used in such a way. For example, a person pretending to have a sad face might not be sad\n emotionally.
" } }, "Landmarks": { @@ -3499,7 +3801,7 @@ "Pose": { "target": "com.amazonaws.rekognition#Pose", "traits": { - "smithy.api#documentation": "Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
" + "smithy.api#documentation": "Indicates the pose of the face as determined by its pitch, roll, and yaw. Default\n attribute.
" } }, "Quality": { @@ -3516,7 +3818,7 @@ } }, "traits": { - "smithy.api#documentation": "Structure containing attributes of the face that the algorithm detected.
\nA FaceDetail object contains either the default facial attributes or all facial attributes. \n The default attributes are BoundingBox, Confidence, Landmarks, Pose, and Quality.
\n GetFaceDetection is the only Amazon Rekognition Video stored video operation that can return a FaceDetail object with all attributes. \n To specify which attributes to return, use the FaceAttributes input parameter for StartFaceDetection.\n The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations\n don't have a FaceAttributes input parameter.
GetCelebrityRecognition
\nGetPersonTracking
\nGetFaceSearch
\nThe Amazon Rekognition Image DetectFaces and IndexFaces operations\n can return all facial attributes. To specify which attributes to return, use the \n Attributes input parameter for DetectFaces. For IndexFaces, use the\n DetectAttributes input parameter.
Structure containing attributes of the face that the algorithm detected.
\nA FaceDetail object contains either the default facial attributes or all\n facial attributes. The default attributes are BoundingBox,\n Confidence, Landmarks, Pose, and\n Quality.
\n GetFaceDetection is the only Amazon Rekognition Video stored video operation that can\n return a FaceDetail object with all attributes. To specify which attributes to\n return, use the FaceAttributes input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default\n attributes. The corresponding Start operations don't have a FaceAttributes input\n parameter.
GetCelebrityRecognition
\nGetPersonTracking
\nGetFaceSearch
\nThe Amazon Rekognition Image DetectFaces and IndexFaces operations\n can return all facial attributes. To specify which attributes to return, use the\n Attributes input parameter for DetectFaces. For\n IndexFaces, use the DetectAttributes input parameter.
Time, in milliseconds from the start of the video, that the face was detected.
" + "smithy.api#default": 0, + "smithy.api#documentation": "Time, in milliseconds from the start of the video, that the face was detected.\n Note that Timestamp is not guaranteed to be accurate to the individual frame where the face first appears.
The predicted gender of a detected face. \n
\n \n \nAmazon Rekognition makes gender binary (male/female) predictions based on the physical appearance\n of a face in a particular image. This kind of prediction is not designed to categorize a person’s gender\n identity, and you shouldn't use Amazon Rekognition to make such a determination. For example, a male actor\n wearing a long-haired wig and earrings for a role might be predicted as female.
\n \nUsing Amazon Rekognition to make gender binary predictions is best suited for use cases where aggregate gender distribution statistics need to be \n analyzed without identifying specific users. For example, the percentage of female users compared to male users on a social media platform.
\n \nWe don't recommend using gender binary predictions to make decisions that impact an individual's rights, privacy, or access to services.
" + "smithy.api#documentation": "The predicted gender of a detected face.\n \n
\nAmazon Rekognition makes gender binary (male/female) predictions based on the physical\n appearance of a face in a particular image. This kind of prediction is not designed to\n categorize a person’s gender identity, and you shouldn't use Amazon Rekognition to make such a\n determination. For example, a male actor wearing a long-haired wig and earrings for a role\n might be predicted as female.
\nUsing Amazon Rekognition to make gender binary predictions is best suited for use cases\n where aggregate gender distribution statistics need to be analyzed without identifying\n specific users. For example, the percentage of female users compared to male users on a social\n media platform.
\nWe don't recommend using gender binary predictions to make decisions that impact an\n individual's rights, privacy, or access to services.
" } }, "com.amazonaws.rekognition#GenderType": { + "type": "enum", + "members": { + "Male": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Male" + } + }, + "Female": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Female" + } + } + } + }, + "com.amazonaws.rekognition#GeneralLabelsFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#GeneralLabelsFilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.rekognition#GeneralLabelsFilterValue": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "Male", - "name": "Male" - }, - { - "value": "Female", - "name": "Female" + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^[A-Za-z0-9à âèçñó'-_(). ]*$" + } + }, + "com.amazonaws.rekognition#GeneralLabelsSettings": { + "type": "structure", + "members": { + "LabelInclusionFilters": { + "target": "com.amazonaws.rekognition#GeneralLabelsFilterList", + "traits": { + "smithy.api#documentation": "The labels that should be included in the return from DetectLabels.
" + } + }, + "LabelExclusionFilters": { + "target": "com.amazonaws.rekognition#GeneralLabelsFilterList", + "traits": { + "smithy.api#documentation": "The labels that should be excluded from the return from DetectLabels.
" + } + }, + "LabelCategoryInclusionFilters": { + "target": "com.amazonaws.rekognition#GeneralLabelsFilterList", + "traits": { + "smithy.api#documentation": "The label categories that should be included in the return from DetectLabels.
" } - ] + }, + "LabelCategoryExclusionFilters": { + "target": "com.amazonaws.rekognition#GeneralLabelsFilterList", + "traits": { + "smithy.api#documentation": "The label categories that should be excluded from the return from DetectLabels.
" + } + } + }, + "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.
" } }, "com.amazonaws.rekognition#Geometry": { @@ -3735,7 +4093,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about where an object (DetectCustomLabels) or text (DetectText) is located on\n an image.
" + "smithy.api#documentation": "Information about where an object (DetectCustomLabels) or text (DetectText) is located on an image.
" } }, "com.amazonaws.rekognition#GetCelebrityInfo": { @@ -3767,7 +4125,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.\n The additional information is returned as an array of URLs. If there is no additional\n information about the celebrity, this list is empty.
\n \nFor more information, see Getting information about a celebrity in\n the Amazon Rekognition Developer Guide.
\nThis operation requires permissions to perform the\n rekognition:GetCelebrityInfo action.
Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.\n The additional information is returned as an array of URLs. If there is no additional\n information about the celebrity, this list is empty.
\n \nFor more information, see Getting information about a celebrity in the\n Amazon Rekognition Developer Guide.
\nThis operation requires permissions to perform the\n rekognition:GetCelebrityInfo action.
The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation,\n which recognizes celebrities in an image.
", + "smithy.api#documentation": "The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.\n
", "smithy.api#required": {} } } @@ -4675,10 +5033,7 @@ } }, "com.amazonaws.rekognition#HasErrors": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.rekognition#HumanLoopActivationOutput": { "type": "structure", @@ -4698,12 +5053,12 @@ "HumanLoopActivationConditionsEvaluationResults": { "target": "com.amazonaws.rekognition#SynthesizedJsonHumanLoopActivationConditionsEvaluationResults", "traits": { - "smithy.api#documentation": "Shows the result of condition evaluations, including those conditions which activated a \n human review.
" + "smithy.api#documentation": "Shows the result of condition evaluations, including those conditions which activated a\n human review.
" } } }, "traits": { - "smithy.api#documentation": "Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did \n not trigger human review.
" + "smithy.api#documentation": "Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the\n input did not trigger human review.
" } }, "com.amazonaws.rekognition#HumanLoopActivationReason": { @@ -4735,14 +5090,14 @@ "HumanLoopName": { "target": "com.amazonaws.rekognition#HumanLoopName", "traits": { - "smithy.api#documentation": "The name of the human review used for this image. This should be kept unique within a region.
", + "smithy.api#documentation": "The name of the human review used for this image. This should be kept unique within a\n region.
", "smithy.api#required": {} } }, "FlowDefinitionArn": { "target": "com.amazonaws.rekognition#FlowDefinitionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by using the Amazon Sagemaker\n CreateFlowDefinition\n Operation.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by\n using the Amazon Sagemaker CreateFlowDefinition Operation.
", "smithy.api#required": {} } }, @@ -4754,7 +5109,7 @@ } }, "traits": { - "smithy.api#documentation": "Sets up the flow definition the image will be sent to if one of the conditions is met. \n You can also set certain attributes of the image before review.
" + "smithy.api#documentation": "Sets up the flow definition the image will be sent to if one of the conditions is met. You\n can also set certain attributes of the image before review.
" } }, "com.amazonaws.rekognition#HumanLoopDataAttributes": { @@ -4859,7 +5214,7 @@ } }, "traits": { - "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\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.
\n \nFor Amazon Rekognition to process an S3 object, the user must have permission to access the S3\n object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.\n
" + "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\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.
\n \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": { @@ -4914,7 +5269,7 @@ } }, "traits": { - "smithy.api#documentation": "The input image size exceeds the allowed limit. If you are calling\n DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see \n Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
", + "smithy.api#documentation": "The input image size exceeds the allowed limit. If you are calling\n DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more\n information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.\n
", "smithy.api#error": "client" } }, @@ -4959,7 +5314,7 @@ } ], "traits": { - "smithy.api#documentation": "Detects faces in the input image and adds them to the specified collection.
\nAmazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage\n operations.
\n \nFor more information, see Adding faces to a collection in the Amazon Rekognition\n Developer Guide.
\nTo get the number of faces in a collection, call DescribeCollection.
\n\nIf you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information\n is not returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection\n and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response\n from IndexFaces\n
For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.
\nIf you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want to index\n smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. By default, IndexFaces chooses the quality bar that's \n used to filter faces. You can also explicitly choose\n the quality bar. Use QualityFilter, to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n DescribeCollection.
\nInformation about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't\n indexed for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request\n parameter.
The face is too small compared to the image dimensions.
\nThe face is too blurry.
\nThe image is too dark.
\nThe face has an extreme pose.
\nThe face doesn’t have enough detail to be suitable for face search.
\nIn response, the IndexFaces operation returns an array of metadata for \n all detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected\n and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide\n the same image, specify the same collection, and use the same external ID in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
\nThis operation requires permissions to perform the rekognition:IndexFaces\n action.
Detects faces in the input image and adds them to the specified collection.
\nAmazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage operations.
\n \nFor more information, see Adding faces to a collection in the Amazon Rekognition\n Developer Guide.
\nTo get the number of faces in a collection, call DescribeCollection.
\nIf you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information is not\n returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model\n version from the value of FaceModelVersion in the response from\n IndexFaces\n
For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.
\nIf you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want\n to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. By default, IndexFaces chooses the quality bar that's used to filter\n faces. You can also explicitly choose the quality bar. Use QualityFilter, to set\n the quality bar by specifying LOW, MEDIUM, or HIGH. If\n you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.
\nInformation about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't indexed\n for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request\n parameter.
The face is too small compared to the image dimensions.
\nThe face is too blurry.
\nThe image is too dark.
\nThe face has an extreme pose.
\nThe face doesn’t have enough detail to be suitable for face search.
\nIn response, the IndexFaces operation returns an array of metadata for all\n detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected\n and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide the same\n image, specify the same collection, and use the same external ID in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
\nThis operation requires permissions to perform the rekognition:IndexFaces\n action.
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call\n Amazon Rekognition operations, passing base64-encoded image bytes isn't supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the Bytes field. \n For more information, see Images in the Amazon Rekognition developer guide.
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to\n call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to\n base64-encode image bytes passed using the Bytes field. For more information, see\n Images in the Amazon Rekognition developer guide.
The maximum number of faces to index. The value of MaxFaces must be greater\n than or equal to 1. IndexFaces returns no more than 100 detected faces in an\n image, even if you specify a larger value for MaxFaces.
If IndexFaces detects more faces than the value of MaxFaces, the\n faces with the lowest quality are filtered out first. If there are still more faces than the\n value of MaxFaces, the faces with the smallest bounding boxes are filtered out\n (up to the number that's needed to satisfy the value of MaxFaces). Information\n about the unindexed faces is available in the UnindexedFaces array.
The faces that are returned by IndexFaces are sorted by the largest face\n bounding box size to the smallest size, in descending order.
\n MaxFaces can be used with a collection associated with any version of \n the face model.
The maximum number of faces to index. The value of MaxFaces must be greater\n than or equal to 1. IndexFaces returns no more than 100 detected faces in an\n image, even if you specify a larger value for MaxFaces.
If IndexFaces detects more faces than the value of MaxFaces, the\n faces with the lowest quality are filtered out first. If there are still more faces than the\n value of MaxFaces, the faces with the smallest bounding boxes are filtered out\n (up to the number that's needed to satisfy the value of MaxFaces). Information\n about the unindexed faces is available in the UnindexedFaces array.
The faces that are returned by IndexFaces are sorted by the largest face\n bounding box size to the smallest size, in descending order.
\n MaxFaces can be used with a collection associated with any version of the\n face model.
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 bar.\n If you specify LOW, \n MEDIUM, or HIGH, filtering removes all faces that\n don’t meet the chosen quality bar. The default value is AUTO.\n \n The quality bar is based on a variety of common use cases. Low-quality\n detections can occur for a number of reasons. Some examples are an object that's misidentified\n as a face, a face that's too blurry, or a face with a\n pose that's too extreme to use. If you specify NONE, no\n filtering is performed.\n
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
" + "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.
" } } } @@ -5017,13 +5372,13 @@ "FaceRecords": { "target": "com.amazonaws.rekognition#FaceRecordList", "traits": { - "smithy.api#documentation": "An array of faces detected and added to the collection.\n For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.\n
" + "smithy.api#documentation": "An array of faces detected and added to the collection. For more information,\n see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
" } }, "OrientationCorrection": { "target": "com.amazonaws.rekognition#OrientationCorrection", "traits": { - "smithy.api#documentation": "If your collection is associated with a face detection model that's later \n than version 3.0, the value of OrientationCorrection\n is always null and no orientation information is returned.
If your collection is associated with a face detection model that's\n version 3.0 or earlier, the following applies:
\nIf the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction - the bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata. The value of OrientationCorrection\n is null.
If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns\n an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform \n image correction for images. The bounding box coordinates aren't translated and represent the \n object locations before the image is rotated.
\nBounding box information is returned in the FaceRecords array. You can get the \n version of the face detection model by calling DescribeCollection.
If your collection is associated with a face detection model that's later than version\n 3.0, the value of OrientationCorrection is always null and no orientation\n information is returned.
If your collection is associated with a face detection model that's version 3.0 or\n earlier, the following applies:
\nIf 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\n to correct the image orientation. Images in .png format don't contain Exif metadata. The\n value of OrientationCorrection is null.
If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition\n returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition\n doesn’t perform image correction for images. The bounding box coordinates aren't\n translated and represent the object locations before the image is rotated.
\nBounding box information is returned in the FaceRecords array. You can get\n the version of the face detection model by calling DescribeCollection.
The confidence that Amazon Rekognition has in the accuracy of the bounding box.
" } + }, + "DominantColors": { + "target": "com.amazonaws.rekognition#DominantColors", + "traits": { + "smithy.api#documentation": "The dominant colors found in an individual instance of a label.
" + } } }, "traits": { - "smithy.api#documentation": "An instance of a label returned by Amazon Rekognition Image (DetectLabels)\n or by Amazon Rekognition Video (GetLabelDetection).
" + "smithy.api#documentation": "An instance of a label returned by Amazon Rekognition Image (DetectLabels) or by\n Amazon Rekognition Video (GetLabelDetection).
" } }, "com.amazonaws.rekognition#Instances": { @@ -5202,10 +5562,7 @@ } }, "com.amazonaws.rekognition#IsLabeled": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.rekognition#JobId": { "type": "string", @@ -5283,7 +5640,7 @@ "ProducerTimestamp": { "target": "com.amazonaws.rekognition#ULong", "traits": { - "smithy.api#documentation": "\n The timestamp from the producer corresponding to the fragment.\n
" + "smithy.api#documentation": "The timestamp from the producer corresponding to the fragment, in milliseconds,\n expressed in unix time format.
" } }, "FragmentNumber": { @@ -5294,7 +5651,7 @@ } }, "traits": { - "smithy.api#documentation": "\n Specifies the starting point in a Kinesis stream to start processing. \n You can use the producer timestamp or the fragment number.\n For more information, see Fragment. \n
" + "smithy.api#documentation": "Specifies the starting point in a Kinesis stream to start processing. You can use the\n producer timestamp or the fragment number. One of either producer timestamp or fragment\n number is required. If you use the producer timestamp, you must put the time in\n milliseconds. For more information about fragment numbers, see Fragment.
" } }, "com.amazonaws.rekognition#KmsKeyId": { @@ -5322,27 +5679,35 @@ } }, "com.amazonaws.rekognition#KnownGenderType": { - "type": "string", - "traits": { - "smithy.api#documentation": "A list of enum string of possible gender values that Celebrity returns.
", - "smithy.api#enum": [ - { - "value": "Male", - "name": "Male" - }, - { - "value": "Female", - "name": "Female" - }, - { - "value": "Nonbinary", - "name": "Nonbinary" - }, - { - "value": "Unlisted", - "name": "Unlisted" + "type": "enum", + "members": { + "Male": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Male" + } + }, + "Female": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Female" + } + }, + "Nonbinary": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Nonbinary" + } + }, + "Unlisted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unlisted" } - ] + } + }, + "traits": { + "smithy.api#documentation": "A list of enum string of possible gender values that Celebrity returns.
" } }, "com.amazonaws.rekognition#Label": { @@ -5371,19 +5736,72 @@ "traits": { "smithy.api#documentation": "The parent labels for a label. The response includes all ancestor labels.
" } + }, + "Aliases": { + "target": "com.amazonaws.rekognition#LabelAliases", + "traits": { + "smithy.api#documentation": "A list of potential aliases for a given label.
" + } + }, + "Categories": { + "target": "com.amazonaws.rekognition#LabelCategories", + "traits": { + "smithy.api#documentation": "A list of the categories associated with a given label.
" + } } }, "traits": { "smithy.api#documentation": "Structure containing details about the detected label, including the name, detected instances, parent labels, and level of\n confidence.
\n\n
" } }, + "com.amazonaws.rekognition#LabelAlias": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "The name of an alias for a given label.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A potential alias of for a given label.
" + } + }, + "com.amazonaws.rekognition#LabelAliases": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#LabelAlias" + } + }, + "com.amazonaws.rekognition#LabelCategories": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#LabelCategory" + } + }, + "com.amazonaws.rekognition#LabelCategory": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "The name of a category that applies to a given label.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The category that applies to a given label.
" + } + }, "com.amazonaws.rekognition#LabelDetection": { "type": "structure", "members": { "Timestamp": { "target": "com.amazonaws.rekognition#Timestamp", "traits": { - "smithy.api#documentation": "Time, in milliseconds from the start of the video, that the label was detected.
" + "smithy.api#default": 0, + "smithy.api#documentation": "Time, in milliseconds from the start of the video, that the label was detected.\n Note that Timestamp is not guaranteed to be accurate to the individual frame where the label first appears.
The x-coordinate of the landmark expressed as a ratio of the width of the image. \n The x-coordinate is measured from the left-side of the image. \n For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.
" + "smithy.api#documentation": "The x-coordinate of the landmark expressed as a ratio of the width of the image. The\n x-coordinate is measured from the left-side of the image. For example, if the image is 700\n pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.\n
" } }, "Y": { "target": "com.amazonaws.rekognition#Float", "traits": { - "smithy.api#documentation": "The y-coordinate of the landmark expressed as a ratio of the height of the image. \n The y-coordinate is measured from the top of the image. \n For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.
" + "smithy.api#documentation": "The y-coordinate of the landmark expressed as a ratio of the height of the image. The\n y-coordinate is measured from the top of the image. For example, if the image height is 200\n pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.
" } } }, @@ -5451,142 +5871,200 @@ } }, "com.amazonaws.rekognition#LandmarkType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "eyeLeft", - "name": "eyeLeft" - }, - { - "value": "eyeRight", - "name": "eyeRight" - }, - { - "value": "nose", - "name": "nose" - }, - { - "value": "mouthLeft", - "name": "mouthLeft" - }, - { - "value": "mouthRight", - "name": "mouthRight" - }, - { - "value": "leftEyeBrowLeft", - "name": "leftEyeBrowLeft" - }, - { - "value": "leftEyeBrowRight", - "name": "leftEyeBrowRight" - }, - { - "value": "leftEyeBrowUp", - "name": "leftEyeBrowUp" - }, - { - "value": "rightEyeBrowLeft", - "name": "rightEyeBrowLeft" - }, - { - "value": "rightEyeBrowRight", - "name": "rightEyeBrowRight" - }, - { - "value": "rightEyeBrowUp", - "name": "rightEyeBrowUp" - }, - { - "value": "leftEyeLeft", - "name": "leftEyeLeft" - }, - { - "value": "leftEyeRight", - "name": "leftEyeRight" - }, - { - "value": "leftEyeUp", - "name": "leftEyeUp" - }, - { - "value": "leftEyeDown", - "name": "leftEyeDown" - }, - { - "value": "rightEyeLeft", - "name": "rightEyeLeft" - }, - { - "value": "rightEyeRight", - "name": "rightEyeRight" - }, - { - "value": "rightEyeUp", - "name": "rightEyeUp" - }, - { - "value": "rightEyeDown", - "name": "rightEyeDown" - }, - { - "value": "noseLeft", - "name": "noseLeft" - }, - { - "value": "noseRight", - "name": "noseRight" - }, - { - "value": "mouthUp", - "name": "mouthUp" - }, - { - "value": "mouthDown", - "name": "mouthDown" - }, - { - "value": "leftPupil", - "name": "leftPupil" - }, - { - "value": "rightPupil", - "name": "rightPupil" - }, - { - "value": "upperJawlineLeft", - "name": "upperJawlineLeft" - }, - { - "value": "midJawlineLeft", - "name": "midJawlineLeft" - }, - { - "value": "chinBottom", - "name": "chinBottom" - }, - { - "value": "midJawlineRight", - "name": "midJawlineRight" - }, - { - "value": "upperJawlineRight", - "name": "upperJawlineRight" - } - ] - } - }, - "com.amazonaws.rekognition#Landmarks": { - "type": "list", - "member": { - "target": "com.amazonaws.rekognition#Landmark" - } - }, - "com.amazonaws.rekognition#LimitExceededException": { - "type": "structure", + "type": "enum", "members": { - "Message": { + "eyeLeft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eyeLeft" + } + }, + "eyeRight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eyeRight" + } + }, + "nose": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nose" + } + }, + "mouthLeft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mouthLeft" + } + }, + "mouthRight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mouthRight" + } + }, + "leftEyeBrowLeft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "leftEyeBrowLeft" + } + }, + "leftEyeBrowRight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "leftEyeBrowRight" + } + }, + "leftEyeBrowUp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "leftEyeBrowUp" + } + }, + "rightEyeBrowLeft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rightEyeBrowLeft" + } + }, + "rightEyeBrowRight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rightEyeBrowRight" + } + }, + "rightEyeBrowUp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rightEyeBrowUp" + } + }, + "leftEyeLeft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "leftEyeLeft" + } + }, + "leftEyeRight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "leftEyeRight" + } + }, + "leftEyeUp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "leftEyeUp" + } + }, + "leftEyeDown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "leftEyeDown" + } + }, + "rightEyeLeft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rightEyeLeft" + } + }, + "rightEyeRight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rightEyeRight" + } + }, + "rightEyeUp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rightEyeUp" + } + }, + "rightEyeDown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rightEyeDown" + } + }, + "noseLeft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "noseLeft" + } + }, + "noseRight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "noseRight" + } + }, + "mouthUp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mouthUp" + } + }, + "mouthDown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mouthDown" + } + }, + "leftPupil": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "leftPupil" + } + }, + "rightPupil": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rightPupil" + } + }, + "upperJawlineLeft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "upperJawlineLeft" + } + }, + "midJawlineLeft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "midJawlineLeft" + } + }, + "chinBottom": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "chinBottom" + } + }, + "midJawlineRight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "midJawlineRight" + } + }, + "upperJawlineRight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "upperJawlineRight" + } + } + } + }, + "com.amazonaws.rekognition#Landmarks": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#Landmark" + } + }, + "com.amazonaws.rekognition#LimitExceededException": { + "type": "structure", + "members": { + "Message": { "target": "com.amazonaws.rekognition#String" }, "Code": { @@ -5636,7 +6114,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns list of collection IDs in your account.\n If the result is truncated, the response also provides a NextToken\n that you can use in the subsequent request to fetch the next set of collection IDs.
For an example, see Listing collections in the Amazon Rekognition Developer Guide.
\nThis operation requires permissions to perform the rekognition:ListCollections action.
Returns list of collection IDs in your account. If the result is truncated, the\n response also provides a NextToken that you can use in the subsequent request to\n fetch the next set of collection IDs.
For an example, see Listing collections in the Amazon Rekognition Developer\n Guide.
\nThis operation requires permissions to perform the\n rekognition:ListCollections action.
Version numbers of the face detection models associated with the collections in the array CollectionIds.\n For example, the value of FaceModelVersions[2] is the version number for the face detection model used\n by the collection in CollectionId[2].
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].
Returns metadata for faces in the specified collection.\n This metadata includes information such as the bounding box coordinates, the confidence\n (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection\n in the Amazon Rekognition Developer Guide.
\n \n \nThis operation requires permissions to perform the\n rekognition:ListFaces action.
Returns metadata for faces in the specified collection. This metadata\n includes information such as the bounding box coordinates, the confidence (that the bounding\n box contains a face), and face ID. For an example, see Listing Faces in a Collection in the\n Amazon Rekognition Developer Guide.
\nThis operation requires permissions to perform the rekognition:ListFaces\n action.
Version number of the face detection model associated with the input collection (CollectionId).
Version number of the face detection model associated with the input collection\n (CollectionId).
\n Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.\n
\nThis operation requires permissions to perform the\n rekognition:ListTagsForResource action.
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.
\n Amazon Resource Name (ARN) of the model, collection, or stream processor that contains the tags that you want a list of.\n
", + "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": {} } } @@ -6206,7 +6681,7 @@ "Tags": { "target": "com.amazonaws.rekognition#TagMap", "traits": { - "smithy.api#documentation": "\n A list of key-value tags assigned to the resource.\n
" + "smithy.api#documentation": "A list of key-value tags assigned to the resource.
" } } } @@ -6235,7 +6710,6 @@ "com.amazonaws.rekognition#MaxDurationInSecondsULong": { "type": "long", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 120 @@ -6245,7 +6719,6 @@ "com.amazonaws.rekognition#MaxFaces": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 4096 @@ -6255,7 +6728,6 @@ "com.amazonaws.rekognition#MaxFacesToIndex": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -6264,7 +6736,6 @@ "com.amazonaws.rekognition#MaxPixelThreshold": { "type": "float", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 1 @@ -6274,7 +6745,6 @@ "com.amazonaws.rekognition#MaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1 } @@ -6283,7 +6753,6 @@ "com.amazonaws.rekognition#MinCoveragePercentage": { "type": "float", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 100 @@ -6313,7 +6782,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information about a single type of inappropriate, unwanted, or offensive content found in an image or video. Each type of\n moderated content has a label within a hierarchical taxonomy. For more information, see\n Content moderation in the Amazon Rekognition Developer Guide.
" + "smithy.api#documentation": "Provides information about a single type of inappropriate, unwanted, or\n offensive content found in an image or video. Each type of moderated content has a label\n within a hierarchical taxonomy. For more information, see Content moderation in the Amazon Rekognition\n Developer Guide.
" } }, "com.amazonaws.rekognition#ModerationLabels": { @@ -6328,6 +6797,7 @@ "Value": { "target": "com.amazonaws.rekognition#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean value that indicates whether the mouth on the face is open or not.
" } }, @@ -6348,6 +6818,7 @@ "Value": { "target": "com.amazonaws.rekognition#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean value that indicates whether the face has mustache or not.
" } }, @@ -6385,26 +6856,32 @@ } }, "com.amazonaws.rekognition#OrientationCorrection": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ROTATE_0", - "name": "ROTATE_0" - }, - { - "value": "ROTATE_90", - "name": "ROTATE_90" - }, - { - "value": "ROTATE_180", - "name": "ROTATE_180" - }, - { - "value": "ROTATE_270", - "name": "ROTATE_270" + "type": "enum", + "members": { + "ROTATE_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROTATE_0" + } + }, + "ROTATE_90": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROTATE_90" + } + }, + "ROTATE_180": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROTATE_180" + } + }, + "ROTATE_270": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROTATE_270" } - ] + } } }, "com.amazonaws.rekognition#OutputConfig": { @@ -6430,7 +6907,6 @@ "com.amazonaws.rekognition#PageSize": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 4096 @@ -6469,7 +6945,6 @@ "com.amazonaws.rekognition#Percent": { "type": "float", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 100 @@ -6482,6 +6957,7 @@ "Index": { "target": "com.amazonaws.rekognition#PersonIndex", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition.
" } }, @@ -6508,7 +6984,8 @@ "Timestamp": { "target": "com.amazonaws.rekognition#Timestamp", "traits": { - "smithy.api#documentation": "The time, in milliseconds from the start of the video, that the person's path was tracked.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The time, in milliseconds from the start of the video, that the person's path was tracked.\n Note that Timestamp is not guaranteed to be accurate to the individual frame where the person's path first appears.
The time, in milliseconds from the beginning of the video, that the person was matched in the video.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The time, in milliseconds from the beginning of the video, that the person was matched in\n the video.
" } }, "Person": { @@ -6549,12 +7030,12 @@ "FaceMatches": { "target": "com.amazonaws.rekognition#FaceMatchList", "traits": { - "smithy.api#documentation": "Information about the faces in the input collection that match the face of a person in the video.
" + "smithy.api#documentation": "Information about the faces in the input collection that match the face of a person in the\n video.
" } } }, "traits": { - "smithy.api#documentation": "Information about a person whose face matches a face(s) in an Amazon Rekognition collection.\n Includes information about the faces in the Amazon Rekognition collection (FaceMatch), information about the person (PersonDetail),\n and the time stamp for when the person was detected in a video. An array of\n PersonMatch objects is returned by GetFaceSearch.
Information about a person whose face matches a face(s) in an Amazon Rekognition collection.\n Includes information about the faces in the Amazon Rekognition collection (FaceMatch), information about the person (PersonDetail), and the time stamp for\n when the person was detected in a video. An array of PersonMatch objects is\n returned by GetFaceSearch.
The X and Y coordinates of a point on an image or video frame. The X and Y values are ratios\n of the overall image size or video resolution. For example, if an input image is 700x200 and the \n values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.
\n \nAn array of Point objects makes up a Polygon.\n A Polygon is returned by DetectText and by DetectCustomLabels\n Polygon\n represents a fine-grained polygon around a detected item. For more information, see Geometry in the\n Amazon Rekognition Developer Guide.
The X and Y coordinates of a point on an image or video frame. The X and Y values are\n ratios of the overall image size or video resolution. For example, if an input image is\n 700x200 and the values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel\n coordinate on the image.
\n \nAn array of Point objects makes up a Polygon. A\n Polygon is returned by DetectText and by DetectCustomLabels\n Polygon represents a fine-grained polygon around a detected item. For more\n information, see Geometry in the Amazon Rekognition Developer Guide.
Returns an array of celebrities recognized in the input image. For more information, see Recognizing celebrities\n in the Amazon Rekognition Developer Guide.
\n\n RecognizeCelebrities returns the 64 largest faces in the image. It lists the\n recognized celebrities in the CelebrityFaces array and any unrecognized faces in\n the UnrecognizedFaces array. RecognizeCelebrities doesn't return\n celebrities whose faces aren't among the largest 64 faces in the image.
For each celebrity recognized, RecognizeCelebrities returns a\n Celebrity object. The Celebrity object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n ComparedFace object that you can use to locate the celebrity's face on the\n image.
Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the Celebrity ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by RecognizeCelebrities, you will need the\n ID to identify the celebrity in a call to the GetCelebrityInfo\n operation.
You pass the input image either as base64-encoded image bytes or as a reference to an\n image in 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\n\n \nFor an example, see Recognizing celebrities in an image in the Amazon Rekognition Developer Guide.
\nThis operation requires permissions to perform the\n rekognition:RecognizeCelebrities operation.
Returns an array of celebrities recognized in the input image. For more\n information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.
\n\n RecognizeCelebrities returns the 64 largest faces in the image. It lists\n the recognized celebrities in the CelebrityFaces array and any unrecognized faces\n in the UnrecognizedFaces array. RecognizeCelebrities doesn't return\n celebrities whose faces aren't among the largest 64 faces in the image.
For each celebrity recognized, RecognizeCelebrities returns a\n Celebrity object. The Celebrity object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n ComparedFace object that you can use to locate the celebrity's face on the\n image.
Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the Celebrity ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by RecognizeCelebrities, you will need the\n ID to identify the celebrity in a call to the GetCelebrityInfo\n operation.
You pass the input image either as base64-encoded image bytes or as a reference to an\n image in 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 \nFor an example, see Recognizing celebrities in an image in the Amazon Rekognition\n Developer Guide.
\nThis operation requires permissions to perform the\n rekognition:RecognizeCelebrities operation.
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call\n Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to\n base64-encode image bytes passed using the Bytes field. For more information, see\n Images in the Amazon Rekognition developer guide.
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to\n call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to\n base64-encode image bytes passed using the Bytes field. For more information, see\n Images in the Amazon Rekognition developer guide.
Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64\n celebrities in an image. Each celebrity object includes the following attributes:\n Face, Confidence, Emotions, Landmarks,\n Pose, Quality, Smile, Id,\n KnownGender, MatchConfidence, Name,\n Urls.
Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64\n celebrities in an image. Each celebrity object includes the following attributes:\n Face, Confidence, Emotions, Landmarks,\n Pose, Quality, Smile, Id,\n KnownGender, MatchConfidence, Name,\n Urls.
Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. \n Any returned values for this field included in an API response 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.
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.
This is the API Reference for Amazon Rekognition Image, \n Amazon Rekognition Custom Labels,\n Amazon Rekognition Stored Video, \n Amazon Rekognition Streaming Video.\n It provides descriptions of actions, data types, common parameters,\n and common errors.
\n\n\n Amazon Rekognition Image \n
\n\n \n\n\n CompareFaces\n
\n\n CreateCollection\n
\n\n DeleteCollection\n
\n\n DeleteFaces\n
\n\n DescribeCollection\n
\n\n DetectFaces\n
\n\n DetectLabels\n
\n\n DetectText\n
\n\n GetCelebrityInfo\n
\n\n IndexFaces\n
\n\n ListCollections\n
\n\n ListFaces\n
\n\n RecognizeCelebrities\n
\n\n SearchFaces\n
\n\n SearchFacesByImage\n
\n\n Amazon Rekognition Custom Labels \n
\n\n CopyProjectVersion\n
\n\n CreateDataset\n
\n\n CreateProject\n
\n\n CreateProjectVersion\n
\n\n DeleteDataset\n
\n\n DeleteProject\n
\n\n DeleteProjectPolicy\n
\n\n DeleteProjectVersion\n
\n\n DescribeDataset\n
\n\n DescribeProjects\n
\n\n DetectCustomLabels\n
\n\n ListDatasetEntries\n
\n\n ListDatasetLabels\n
\n\n ListProjectPolicies\n
\n\n PutProjectPolicy\n
\n\n StartProjectVersion\n
\n\n StopProjectVersion\n
\n\n UpdateDatasetEntries\n
\n\n Amazon Rekognition Video Stored Video \n
\n\n\n GetContentModeration\n
\n\n GetFaceDetection\n
\n\n GetFaceSearch\n
\n\n GetLabelDetection\n
\n\n GetPersonTracking\n
\n\n GetSegmentDetection\n
\n\n GetTextDetection\n
\n\n StartFaceDetection\n
\n\n StartFaceSearch\n
\n\n StartLabelDetection\n
\n\n StartPersonTracking\n
\n\n StartTextDetection\n
\n\n Amazon Rekognition Video Streaming Video \n
\n\n\n ListStreamProcessors\n
\n\n StartStreamProcessor\n
\n\n StopStreamProcessor\n
\nThis is the API Reference for Amazon Rekognition Image, Amazon Rekognition Custom Labels,\n Amazon Rekognition Stored\n Video, Amazon Rekognition Streaming Video. It provides descriptions of actions, data types, common\n parameters, and common errors.
\n\n Amazon Rekognition Image\n
\n\n CompareFaces\n
\n\n CreateCollection\n
\n\n DeleteCollection\n
\n\n DeleteFaces\n
\n\n DescribeCollection\n
\n\n DetectFaces\n
\n\n DetectLabels\n
\n\n DetectText\n
\n\n GetCelebrityInfo\n
\n\n IndexFaces\n
\n\n ListCollections\n
\n\n ListFaces\n
\n\n RecognizeCelebrities\n
\n\n SearchFaces\n
\n\n SearchFacesByImage\n
\n\n Amazon Rekognition Custom Labels\n
\n\n CopyProjectVersion\n
\n\n CreateDataset\n
\n\n CreateProject\n
\n\n CreateProjectVersion\n
\n\n DeleteDataset\n
\n\n DeleteProject\n
\n\n DeleteProjectPolicy\n
\n\n DeleteProjectVersion\n
\n\n DescribeDataset\n
\n\n DescribeProjects\n
\n\n DetectCustomLabels\n
\n\n ListDatasetEntries\n
\n\n ListDatasetLabels\n
\n\n ListProjectPolicies\n
\n\n PutProjectPolicy\n
\n\n StartProjectVersion\n
\n\n StopProjectVersion\n
\n\n UpdateDatasetEntries\n
\n\n Amazon Rekognition Video Stored Video\n
\n\n GetContentModeration\n
\n\n GetFaceDetection\n
\n\n GetFaceSearch\n
\n\n GetLabelDetection\n
\n\n GetPersonTracking\n
\n\n GetSegmentDetection\n
\n\n GetTextDetection\n
\n\n StartFaceDetection\n
\n\n StartFaceSearch\n
\n\n StartLabelDetection\n
\n\n StartPersonTracking\n
\n\n StartTextDetection\n
\n\n Amazon Rekognition Video Streaming Video\n
\n\n ListStreamProcessors\n
\n\n StartStreamProcessor\n
\n\n StopStreamProcessor\n
\nProvides the S3 bucket name and object name.
\nThe region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.
\n \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 Amazon Rekognition\n Developer Guide.
" + "smithy.api#documentation": "Provides the S3 bucket name and object name.
\nThe region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.
\n \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#S3ObjectName": { @@ -7858,7 +9589,7 @@ } ], "traits": { - "smithy.api#documentation": "For a given input face ID, searches for matching faces in the collection the face\n belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with\n faces in the specified collection.
\nYou can also search faces without indexing faces by using the\n SearchFacesByImage operation.
\n The operation response returns\n an array of faces that match, ordered by similarity score with the highest\n similarity first. More specifically, it is an\n array of metadata for each face match that is found. Along with the metadata, the response also\n includes a confidence value for each face match, indicating the confidence\n that the specific face matches the input face.\n
For an example, see Searching for a face using its face ID in the Amazon Rekognition Developer Guide.
\n\nThis operation requires permissions to perform the rekognition:SearchFaces\n action.
For a given input face ID, searches for matching faces in the collection the face\n belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with\n faces in the specified collection.
\nYou can also search faces without indexing faces by using the\n SearchFacesByImage operation.
The operation response returns an array of faces that match, ordered by similarity\n score with the highest similarity first. More specifically, it is an array of metadata for\n each face match that is found. Along with the metadata, the response also includes a\n confidence value for each face match, indicating the confidence that the\n specific face matches the input face.
For an example, see Searching for a face using its face ID in the Amazon Rekognition\n Developer Guide.
\nThis operation requires permissions to perform the rekognition:SearchFaces\n action.
For a given input image, first detects the largest face in the image, and then searches\n the specified collection for matching faces. The operation compares the features of the input\n face with faces in the specified collection.
\nTo search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent\n calls to the SearchFaces operation.
\n You can also call the DetectFaces operation and use the bounding boxes\n in the response to make face crops, which then you can pass in to the\n SearchFacesByImage operation.
You pass the input image either as base64-encoded image bytes or as a reference to an\n image in 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 The response returns an array of faces that match, ordered by similarity score with the\n highest similarity first. More specifically, it is an\n array of metadata for each face match found. Along with the metadata, the response also\n includes a similarity indicating how similar the face is\n to the input face.\n\n In the response, the operation also returns the bounding\n box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition\n used for the input image.\n
If no faces are detected in the input image, SearchFacesByImage returns an \n InvalidParameterException error.
For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.
\n \nThe QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. \n Use QualityFilter to set the quality bar for \n filtering by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE. The default\n value is NONE.
To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n DescribeCollection.
\nThis operation requires permissions to perform the rekognition:SearchFacesByImage\n action.
For a given input image, first detects the largest face in the image, and then searches\n the specified collection for matching faces. The operation compares the features of the input\n face with faces in the specified collection.
\nTo search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls\n to the SearchFaces operation.
\n You can also call the DetectFaces operation and use the bounding boxes\n in the response to make face crops, which then you can pass in to the\n SearchFacesByImage operation.
You pass the input image either as base64-encoded image bytes or as a reference to an\n image in 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 The response returns an array of faces that match, ordered by similarity score with\n the highest similarity first. More specifically, it is an array of metadata for each face\n match found. Along with the metadata, the response also includes a similarity\n indicating how similar the face is to the input face. In the response, the operation also\n returns the bounding box (and a confidence level that the bounding box contains a face) of the\n face that Amazon Rekognition used for the input image.
If no faces are detected in the input image, SearchFacesByImage returns an\n InvalidParameterException error.
For an example, Searching for a Face Using an Image in the Amazon Rekognition\n Developer Guide.
\nThe QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar for filtering by specifying\n LOW, MEDIUM, or HIGH. If you do not want to filter\n detected faces, specify NONE. The default value is NONE.
To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.
\nThis operation requires permissions to perform the\n rekognition:SearchFacesByImage action.
The input image as base64-encoded bytes or an S3 object.\n If you use the AWS CLI to call Amazon Rekognition operations,\n passing base64-encoded image bytes is not supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the Bytes field. \n For more information, see Images in the Amazon Rekognition developer guide.
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to\n call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
\nIf you are using an AWS SDK to call Amazon Rekognition, you might not need to\n base64-encode image bytes passed using the Bytes field. For more information, see\n Images in the Amazon Rekognition developer guide.
(Optional) Specifies the minimum confidence in the face match to return. For example,\n don't return any matches where confidence in matches is less than 70%.\n The default value is 80%.
" + "smithy.api#documentation": "(Optional) Specifies the minimum confidence in the face match to return. For example,\n don't return any matches where confidence in matches is less than 70%. The default value is\n 80%.
" } }, "QualityFilter": { "target": "com.amazonaws.rekognition#QualityFilter", "traits": { - "smithy.api#documentation": "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, Amazon Rekognition \n chooses the quality bar. If you specify LOW, \n MEDIUM, or HIGH, filtering removes all faces that\n don’t meet the chosen quality bar. \n \n The quality bar is based on a variety of common use cases. Low-quality\n detections can occur for a number of reasons. Some examples are an object that's misidentified\n as a face, a face that's too blurry, or a face with a\n pose that's too extreme to use. If you specify NONE, no\n filtering is performed. The default value is NONE.\n
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
" + "smithy.api#documentation": "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.
" } } } @@ -7963,7 +9694,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "Version number of the face detection model associated with the input collection (CollectionId).
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%. \n The default value is 80%.\n
" + "smithy.api#documentation": "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%.
" } } } @@ -8017,7 +9748,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "Version number of the face detection model associated with the input collection (CollectionId).
Version number of the face detection model associated with the input collection\n (CollectionId).
The start time of the detected segment in milliseconds from the start of the video. This value\n is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of\n 100 millis.
" } }, "EndTimestampMillis": { "target": "com.amazonaws.rekognition#Timestamp", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The end time of the detected segment, in milliseconds, from the start of the video.\n This value is rounded down.
" } }, @@ -8119,18 +9851,20 @@ } }, "com.amazonaws.rekognition#SegmentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TECHNICAL_CUE", - "name": "TECHNICAL_CUE" - }, - { - "value": "SHOT", - "name": "SHOT" + "type": "enum", + "members": { + "TECHNICAL_CUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TECHNICAL_CUE" + } + }, + "SHOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHOT" } - ] + } } }, "com.amazonaws.rekognition#SegmentTypeInfo": { @@ -8187,7 +9921,7 @@ } }, "traits": { - "smithy.api#documentation": "\n \n \nThe size of the collection exceeds the allowed limit. For more information, see \n Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
", + "smithy.api#documentation": "\n \nThe size of the collection exceeds the allowed limit. For more information,\n see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
", "smithy.api#error": "client" } }, @@ -8217,6 +9951,7 @@ "Value": { "target": "com.amazonaws.rekognition#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean value that indicates whether the face is smiling or not.
" } }, @@ -9014,7 +10749,7 @@ "StartSelector": { "target": "com.amazonaws.rekognition#StreamProcessingStartSelector", "traits": { - "smithy.api#documentation": "\n Specifies the starting point in the Kinesis stream to start processing. \n You can use the producer timestamp or the fragment number. \n For more information, see Fragment. \n
\nThis is a required parameter for label detection stream processors and should not be used to start a face search stream processor.
" + "smithy.api#documentation": "\n Specifies the starting point in the Kinesis stream to start processing. \n You can use the producer timestamp or the fragment number. If you use the producer timestamp, you must put the time in milliseconds.\n For more information about fragment numbers, see Fragment. \n
\nThis is a required parameter for label detection stream processors and should not be used to start a face search stream processor.
" } }, "StopSelector": { @@ -9282,12 +11017,12 @@ "KVSStreamStartSelector": { "target": "com.amazonaws.rekognition#KinesisVideoStreamStartSelector", "traits": { - "smithy.api#documentation": "\n Specifies the starting point in the stream to start processing. This can be done with a timestamp or a fragment number in a Kinesis stream.\n
" + "smithy.api#documentation": "\n Specifies the starting point in the stream to start processing. This can be done with a producer timestamp or a fragment number in a Kinesis stream.\n
" } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "This is a required parameter for label detection stream processors and should not be used\n to start a face search stream processor.
" } }, "com.amazonaws.rekognition#StreamProcessingStopSelector": { @@ -9336,6 +11071,7 @@ "OptIn": { "target": "com.amazonaws.rekognition#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "\n If this option is set to true, you choose to share data with Rekognition to improve model performance.\n
", "smithy.api#required": {} } @@ -9411,18 +11147,20 @@ } }, "com.amazonaws.rekognition#StreamProcessorParameterToDelete": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ConnectedHomeMinConfidence", - "name": "ConnectedHomeMinConfidence" - }, - { - "value": "RegionsOfInterest", - "name": "RegionsOfInterest" + "type": "enum", + "members": { + "ConnectedHomeMinConfidence": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConnectedHomeMinConfidence" + } + }, + "RegionsOfInterest": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RegionsOfInterest" } - ] + } } }, "com.amazonaws.rekognition#StreamProcessorParametersToDelete": { @@ -9463,34 +11201,44 @@ } }, "com.amazonaws.rekognition#StreamProcessorStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "UPDATING", - "name": "UPDATING" + "type": "enum", + "members": { + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" } - ] + } } }, "com.amazonaws.rekognition#String": { @@ -9513,6 +11261,7 @@ "Value": { "target": "com.amazonaws.rekognition#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean value that indicates whether the face is wearing sunglasses or not.
" } }, @@ -9606,7 +11355,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model. For more information, see Tagging AWS Resources.\n
\nThis operation requires permissions to perform the\n rekognition:TagResource action.
Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom\n Labels model. For more information, see Tagging AWS\n Resources.
\nThis operation requires permissions to perform the rekognition:TagResource\n action.
\n Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to assign the tags to.\n
", + "smithy.api#documentation": "Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to\n assign the tags to.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rekognition#TagMap", "traits": { - "smithy.api#documentation": "\n The key-value tags to assign to the resource.\n
", + "smithy.api#documentation": "The key-value tags to assign to the resource.
", "smithy.api#required": {} } } @@ -9663,38 +11412,50 @@ } }, "com.amazonaws.rekognition#TechnicalCueType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ColorBars", - "name": "COLOR_BARS" - }, - { - "value": "EndCredits", - "name": "END_CREDITS" - }, - { - "value": "BlackFrames", - "name": "BLACK_FRAMES" - }, - { - "value": "OpeningCredits", - "name": "OPENING_CREDITS" - }, - { - "value": "StudioLogo", - "name": "STUDIO_LOGO" - }, - { - "value": "Slate", - "name": "SLATE" - }, - { - "value": "Content", - "name": "CONTENT" + "type": "enum", + "members": { + "COLOR_BARS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ColorBars" + } + }, + "END_CREDITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EndCredits" + } + }, + "BLACK_FRAMES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BlackFrames" + } + }, + "OPENING_CREDITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OpeningCredits" + } + }, + "STUDIO_LOGO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StudioLogo" + } + }, + "SLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Slate" + } + }, + "CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Content" } - ] + } } }, "com.amazonaws.rekognition#TestingData": { @@ -9709,6 +11470,7 @@ "AutoCreate": { "target": "com.amazonaws.rekognition#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job.\n After training completes, the test dataset is not stored and the training dataset reverts to its previous size.
" } } @@ -9784,7 +11546,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about a word or line of text detected by DetectText.
\nThe DetectedText field contains the text that Amazon Rekognition detected in the\n image.
Every word and line has an identifier (Id). Each word belongs to a line\n and has a parent identifier (ParentId) that identifies the line of text in which\n the word appears. The word Id is also an index for the word within a line of\n words.
For more information, see Detecting text in the Amazon Rekognition Developer Guide.
" + "smithy.api#documentation": "Information about a word or line of text detected by DetectText.
\nThe DetectedText field contains the text that Amazon Rekognition detected in the\n image.
Every word and line has an identifier (Id). Each word belongs to a line\n and has a parent identifier (ParentId) that identifies the line of text in which\n the word appears. The word Id is also an index for the word within a line of\n words.
For more information, see Detecting text in the Amazon Rekognition Developer\n Guide.
" } }, "com.amazonaws.rekognition#TextDetectionList": { @@ -9799,7 +11561,8 @@ "Timestamp": { "target": "com.amazonaws.rekognition#Timestamp", "traits": { - "smithy.api#documentation": "The time, in milliseconds from the start of the video, that the text was detected.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The time, in milliseconds from the start of the video, that the text was detected.\n Note that Timestamp is not guaranteed to be accurate to the individual frame where the text first appears.
An array of reasons that specify why a face wasn't indexed.
\nEXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned\n too far away from the camera.
\nEXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the \n MaxFaces input parameter for IndexFaces.
LOW_BRIGHTNESS - The image is too dark.
\nLOW_SHARPNESS - The image is too blurry.
\nLOW_CONFIDENCE - The face was detected with a low confidence.
\nSMALL_BOUNDING_BOX - The bounding box around the face is too small.
\nAn array of reasons that specify why a face wasn't indexed.
\nEXTREME_POSE - The face is at a pose that can't be detected. For example, the head is\n turned too far away from the camera.
\nEXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified\n by the MaxFaces input parameter for IndexFaces.
LOW_BRIGHTNESS - The image is too dark.
\nLOW_SHARPNESS - The image is too blurry.
\nLOW_CONFIDENCE - The face was detected with a low confidence.
\nSMALL_BOUNDING_BOX - The bounding box around the face is too small.
\n\n Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.\n
\nThis operation requires permissions to perform the\n rekognition:UntagResource action.
Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels\n model.
\nThis operation requires permissions to perform the\n rekognition:UntagResource action.
\n Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to remove the tags from.\n
", + "smithy.api#documentation": "Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to\n remove the tags from.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.rekognition#TagKeyList", "traits": { - "smithy.api#documentation": "\n A list of the tags that you want to remove.\n
", + "smithy.api#documentation": "A list of the tags that you want to remove.
", "smithy.api#required": {} } } @@ -10199,37 +11965,43 @@ } }, "com.amazonaws.rekognition#VideoColorRange": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FULL", - "name": "FULL" - }, - { - "value": "LIMITED", - "name": "LIMITED" + "type": "enum", + "members": { + "FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL" + } + }, + "LIMITED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIMITED" } - ] + } } }, "com.amazonaws.rekognition#VideoJobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "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" + } + } } }, "com.amazonaws.rekognition#VideoMetadata": { diff --git a/codegen/sdk-codegen/aws-models/securityhub.json b/codegen/sdk-codegen/aws-models/securityhub.json index c26c340fd76..9d421bdc098 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.json +++ b/codegen/sdk-codegen/aws-models/securityhub.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -256,6 +256,7 @@ "Port": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of the port.
" } }, @@ -314,6 +315,7 @@ "Port": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of the port.
" } }, @@ -416,23 +418,26 @@ } }, "com.amazonaws.securityhub#AdminStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLE_IN_PROGRESS", - "name": "DISABLE_IN_PROGRESS" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_IN_PROGRESS" } - ] + } } }, "com.amazonaws.securityhub#AdminsMaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 10 @@ -446,18 +451,20 @@ } }, "com.amazonaws.securityhub#AutoEnableStandards": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NONE", - "name": "NONE" - }, - { - "value": "DEFAULT", - "name": "DEFAULT" + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" } - ] + } } }, "com.amazonaws.securityhub#AvailabilityZone": { @@ -582,6 +589,7 @@ "PercentTraffic": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The percentage of traffic that is diverted to a canary deployment.
" } }, @@ -600,6 +608,7 @@ "UseStageCache": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the canary deployment uses the stage cache.
" } } @@ -628,6 +637,7 @@ "MetricsEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether CloudWatch metrics are enabled for the method.
" } }, @@ -640,42 +650,49 @@ "DataTraceEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether data trace logging is enabled for the method. Data trace logging\n affects the log entries that are pushed to CloudWatch Logs.
" } }, "ThrottlingBurstLimit": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The throttling burst limit for the method.
" } }, "ThrottlingRateLimit": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The throttling rate limit for the method.
" } }, "CachingEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether responses are cached and returned for requests. For responses to be\n cached, a cache cluster must be enabled on the stage.
" } }, "CacheTtlInSeconds": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL,\n the longer the response is cached.
" } }, "CacheDataEncrypted": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the cached responses are encrypted.
" } }, "RequireAuthorizationForCacheControl": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether authorization is required for a cache invalidation request.
" } }, @@ -750,6 +767,7 @@ "MinimumCompressionSize": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The minimum size in bytes of a payload before compression is enabled.
\nIf null, then compression is disabled.
If 0, then all payloads are compressed.
" } }, @@ -800,6 +818,7 @@ "CacheClusterEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether a cache cluster is enabled for the stage.
" } }, @@ -848,6 +867,7 @@ "TracingEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether active tracing with X-Ray is enabled for the stage.
" } }, @@ -948,6 +968,7 @@ "DetailedMetricsEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether detailed metrics are enabled.
" } }, @@ -960,18 +981,21 @@ "DataTraceEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether data trace logging is enabled. Data trace logging affects the log\n entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.
" } }, "ThrottlingBurstLimit": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The throttling burst limit.
" } }, "ThrottlingRateLimit": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The throttling rate limit.
" } } @@ -1046,6 +1070,7 @@ "AutoDeploy": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether updates to an API automatically trigger a new deployment.
" } }, @@ -1058,6 +1083,7 @@ "ApiGatewayManaged": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the stage is managed by API Gateway.
" } } @@ -1110,6 +1136,7 @@ "HealthCheckGracePeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the\n health status of an EC2 instance that has come into service.
" } }, @@ -1140,6 +1167,7 @@ "CapacityRebalance": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether capacity rebalancing is enabled.\n
" } } @@ -1206,12 +1234,14 @@ "OnDemandBaseCapacity": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.
" } }, "OnDemandPercentageAboveBaseCapacity": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The percentage of On-Demand Instances and Spot Instances for additional capacity beyond OnDemandBaseCapacity.
The number of Spot Instance pools across which to allocate your Spot Instances.
" } }, @@ -1328,6 +1359,7 @@ "NoDevice": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to suppress the device that is included in the block device mapping of the Amazon Machine Image (AMI).
\nIf NoDevice is true, then you cannot specify Ebs.>
Whether to delete the volume when the instance is terminated.
" } }, "Encrypted": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to encrypt the volume.
" } }, "Iops": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of input/output (I/O) operations per second (IOPS) to provision for the volume.
\nOnly supported for gp3 or io1 volumes. Required for io1 volumes. Not used with standard, gp2, st1, or sc1 volumes.
The volume size, in GiBs. The following are the supported volumes sizes for each volume type:
\ngp2 and gp3: 1-16,384
\nio1: 4-16,384
\nst1 and sc1: 125-16,384
\nstandard: 1-1,024
\nYou must specify either SnapshotId or VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.
For Auto Scaling groups that run in a VPC, specifies whether to assign a public IP address to the group's instances.
" } }, @@ -1428,6 +1465,7 @@ "EbsOptimized": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the launch configuration is optimized for Amazon EBS I/O.
" } }, @@ -1520,6 +1558,7 @@ "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "If set to true, then instances in the group launch with detailed\n monitoring.
If set to false, then instances in the group launch with basic\n monitoring.
The HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.\n
Specifies the number of days after creation that a recovery point is moved to cold storage.\n
" } } @@ -1670,12 +1712,12 @@ "Lifecycle": { "target": "com.amazonaws.securityhub#AwsBackupBackupPlanLifecycleDetails", "traits": { - "smithy.api#documentation": "Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
" + "smithy.api#documentation": "Defines when a protected resource is transitioned to cold storage and when it expires.\n Backup transitions and expires backups automatically according to the\n lifecycle that you define. If you do not specify a lifecycle, Backup applies\n the lifecycle policy of the source backup to the destination backup.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
" } } }, "traits": { - "smithy.api#documentation": "An array of CopyAction objects, which contains the details of the copy operation.\n
An array of CopyAction objects, each of which contains details of the copy operation.\n
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.\n
" + "smithy.api#documentation": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.\n
" } }, "StartWindowMinutes": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.\n
" } }, @@ -1708,7 +1751,7 @@ "RuleName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.\n
" + "smithy.api#documentation": "A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
" } }, "RuleId": { @@ -1720,19 +1763,21 @@ "EnableContinuousBackup": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).\n
" } }, "CompletionWindowMinutes": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.\n
" } }, "CopyActions": { "target": "com.amazonaws.securityhub#AwsBackupBackupPlanRuleCopyActionsList", "traits": { - "smithy.api#documentation": "An array of CopyAction objects, which contains the details of the copy operation.\n
An array of CopyAction objects, each of which contains details of the\n copy operation.
The size, in bytes, of a backup.\n
" } }, @@ -1922,6 +1968,7 @@ "IsEncrypted": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "A Boolean value that is returned as TRUE if the specified recovery point is \nencrypted, or FALSE if the recovery point is not encrypted.\n
Specifies the number of days after creation that a recovery point is deleted. Must be greater \nthan 90 days plus MoveToColdStorageAfterDays.\n
Specifies the number of days after creation that a recovery point is moved to cold storage.\n
" } } @@ -2342,6 +2391,7 @@ "DisableRollback": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Boolean to enable or disable rollback on stack creation failures. \n
" } }, @@ -2354,6 +2404,7 @@ "EnableTerminationProtection": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether termination protection is enabled for the stack.\n
" } }, @@ -2408,6 +2459,7 @@ "TimeoutInMinutes": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The length of time, in minutes, that CloudFormation waits for the nested stack to reach \nthe CREATE_COMPLETE state.\n
With this field, you can enable or disable the selected distribution.
" } }, "IncludeCookies": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether you want CloudFront to include cookies in access logs.
" } }, @@ -2628,18 +2682,21 @@ "HttpPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The HTTP port that CloudFront uses to connect to the origin.\n
" } }, "HttpsPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The HTTPS port that CloudFront uses to connect to the origin.\n
" } }, "OriginKeepaliveTimeout": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies how long, in seconds, CloudFront persists its connection to the origin.\n
" } }, @@ -2652,6 +2709,7 @@ "OriginReadTimeout": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies how long, in seconds, CloudFront waits for a response from the origin.\n
" } }, @@ -2706,6 +2764,7 @@ "Quantity": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of status codes that can cause a failover.
" } } @@ -2810,6 +2869,7 @@ "Quantity": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing \nan HTTPS connection with this origin.\n
" } } @@ -2856,6 +2916,7 @@ "CloudFrontDefaultCertificate": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the distribution uses the CloudFront domain name. If set to false, then you provide either AcmCertificateArn or IamCertificateId.
Indicates whether the trail has custom event selectors.
" } }, @@ -2912,18 +2974,21 @@ "IncludeGlobalServiceEvents": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the trail publishes events from global services such as IAM to the log\n files.
" } }, "IsMultiRegionTrail": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the trail applies only to the current Region or to all Regions.
" } }, "IsOrganizationTrail": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the trail is created for all accounts in an organization in Organizations,\n or only for the current Amazon Web Services account.
" } }, @@ -2936,6 +3001,7 @@ "LogFileValidationEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether CloudTrail log file validation is enabled.
" } }, @@ -2986,6 +3052,7 @@ "ActionsEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether actions should be executed during any changes to the alarm state. \n
" } }, @@ -3028,6 +3095,7 @@ "DatapointsToAlarm": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of datapoints that must be breaching to trigger the alarm. \n
" } }, @@ -3046,6 +3114,7 @@ "EvaluationPeriods": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of periods over which data is compared to the specified threshold.\n
" } }, @@ -3082,6 +3151,7 @@ "Period": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The period, in seconds, over which the statistic is applied. This is required for an alarm based on a \nmetric.\n
" } }, @@ -3094,6 +3164,7 @@ "Threshold": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The value to compare with the specified statistic.\n
" } }, @@ -3158,6 +3229,7 @@ "EncryptionDisabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether to disable encryption on the artifact. Only valid when Type is S3.
Whether the name specified in the buildspec file overrides the artifact name.
" } }, @@ -3294,6 +3367,7 @@ "PrivilegedMode": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.
Whether to disable encryption of the S3 build log output.
" } }, @@ -3462,12 +3537,14 @@ "GitCloneDepth": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Information about the Git clone depth for the build project.
" } }, "InsecureSsl": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to ignore SSL warnings while connecting to the project source code.
" } } @@ -3514,6 +3591,7 @@ "AllowCredentials": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the CORS request includes credentials.
" } }, @@ -3526,6 +3604,7 @@ "MaxAge": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of seconds for which the browser caches preflight request results.
" } }, @@ -3628,6 +3707,7 @@ "ItemCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of items in the table.
" } }, @@ -3700,6 +3780,7 @@ "TableSizeBytes": { "target": "com.amazonaws.securityhub#SizeBytes", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total size of the table in bytes.
" } }, @@ -3720,6 +3801,7 @@ "Backfilling": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the index is currently backfilling.
" } }, @@ -3738,6 +3820,7 @@ "IndexSizeBytes": { "target": "com.amazonaws.securityhub#SizeBytes", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total size in bytes of the index.
" } }, @@ -3750,6 +3833,7 @@ "ItemCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of items in the index.
" } }, @@ -3884,18 +3968,21 @@ "NumberOfDecreasesToday": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of times during the current UTC calendar day that the provisioned throughput\n was decreased.
" } }, "ReadCapacityUnits": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException.
The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.
The read capacity units for the replica.
" } } @@ -4018,6 +4106,7 @@ "RestoreInProgress": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether a restore is currently in progress.
" } } @@ -4064,6 +4153,7 @@ "StreamEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether DynamoDB Streams is enabled on the table.
" } }, @@ -4244,6 +4334,7 @@ "HttpPutResponseHopLimit": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The desired HTTP PUT response hop limit for instance metadata requests. \n The larger the number, the further instance metadata requests can travel.\n
" } }, @@ -4322,6 +4413,7 @@ "IsDefault": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether this is the default network ACL for the VPC.
" } }, @@ -4372,6 +4464,7 @@ "Egress": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the rule is an egress rule. An egress rule is a rule that applies to traffic that leaves the subnet.
" } }, @@ -4408,6 +4501,7 @@ "RuleNumber": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The rule number. The rules are processed in order by their number.
" } } @@ -4440,12 +4534,14 @@ "DeleteOnTermination": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the network interface is deleted when the instance is\n terminated.
" } }, "DeviceIndex": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The device index of the network interface attachment on the instance.
" } }, @@ -4496,6 +4592,7 @@ "SourceDestCheck": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether traffic to or from the instance is validated.
" } }, @@ -4656,12 +4753,14 @@ "FromPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type\n number.
\nA value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you\n must specify all codes.
" } }, "ToPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
\nA value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all\n codes.
Whether to assign an IPV6 address to a network interface that is created in this subnet.
" } }, @@ -4834,6 +4934,7 @@ "AvailableIpAddressCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of available IPV4 addresses in the subnet. Does not include addresses for stopped instances.
" } }, @@ -4846,12 +4947,14 @@ "DefaultForAz": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether this subnet is the default subnet for the Availability Zone.
" } }, "MapPublicIpOnLaunch": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether instances in this subnet receive a public IP address.
" } }, @@ -4968,6 +5071,7 @@ "AmazonSideAsn": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n
" } } @@ -4988,6 +5092,7 @@ "DeleteOnTermination": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the EBS volume is deleted when the EC2 instance is terminated.
" } }, @@ -5032,12 +5137,14 @@ "Encrypted": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the volume is encrypted.
" } }, "Size": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The size of the volume, in GiBs.
" } }, @@ -5126,6 +5233,7 @@ "AcceptanceRequired": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.
" } }, @@ -5144,6 +5252,7 @@ "ManagesVpcEndpoints": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the service manages its VPC endpoints.
" } }, @@ -5402,6 +5511,7 @@ "StaticRoutesOnly": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the VPN connection uses static routes only.
" } }, @@ -5422,6 +5532,7 @@ "DpdTimeoutSeconds": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of seconds after which a Dead Peer Detection (DPD) timeout occurs.
" } }, @@ -5458,6 +5569,7 @@ "Phase1LifetimeSeconds": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The lifetime for phase 1 of the IKE negotiation, in seconds.
" } }, @@ -5482,6 +5594,7 @@ "Phase2LifetimeSeconds": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The lifetime for phase 2 of the IKE negotiation, in seconds.
" } }, @@ -5494,18 +5607,21 @@ "RekeyFuzzPercentage": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The percentage of the rekey window, which is determined by\n RekeyMarginTimeSeconds during which the rekey time is randomly selected.
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services\n side of the VPN connection performs an IKE rekey.
" } }, "ReplayWindowSize": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of packets in an IKE replay window.
" } }, @@ -5558,6 +5674,7 @@ "AcceptedRouteCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of accepted routes.
" } }, @@ -5696,6 +5813,7 @@ "ScanOnPush": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to scan images after they are pushed to a repository.
" } } @@ -5796,6 +5914,7 @@ "CloudWatchEncryptionEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to enable encryption on the CloudWatch logs.
" } }, @@ -5814,6 +5933,7 @@ "S3EncryptionEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to encrypt the logs that are sent to the S3 bucket.
" } }, @@ -5834,6 +5954,7 @@ "Base": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The minimum number of tasks to run on the specified capacity provider.
" } }, @@ -5846,6 +5967,7 @@ "Weight": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The relative percentage of the total number of tasks launched that should use the capacity provider.
" } } @@ -5872,6 +5994,7 @@ "ActiveServicesCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of services that are running on the cluster in an ACTIVE state. You can view these services with the Amazon ECS \n ListServices\n API operation.\n
The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.\n
The number of tasks in the cluster that are in the RUNNING state.\n
When this parameter is true, the container is given elevated privileges on the host container instance \n(similar to the root user). \n
" } } @@ -5972,6 +6098,7 @@ "Base": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The minimum number of tasks to run on the capacity provider. Only one strategy item can specify a value for Base.
The value must be between 0 and 100000.
" } }, @@ -5984,6 +6111,7 @@ "Weight": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The relative percentage of the total number of tasks that should use the capacity provider.
\nIf no weight is specified, the default value is 0. At least one capacity provider must have a weight greater than 0.
\nThe value can be between 0 and 1000.
" } } @@ -6004,12 +6132,14 @@ "Enable": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to enable the deployment circuit breaker logic for the service.
" } }, "Rollback": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
" } } @@ -6030,12 +6160,14 @@ "MaximumPercent": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "For a service that uses the rolling update (ECS) deployment type, the maximum number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, and for tasks that use the EC2 launch type, when any container instances are in the DRAINING state. Provided as a percentage of the desired number of tasks. The default value is 200%.
For a service that uses the blue/green (CODE_DEPLOY) or EXTERNAL deployment types, and tasks that use the EC2 launch type, the maximum number of tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state.
For the Fargate launch type, the maximum percent value is not used.
" } }, "MinimumHealthyPercent": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "For a service that uses the rolling update (ECS) deployment type, the minimum number of tasks in a service that must remain in the RUNNING state during a deployment, and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Expressed as a percentage of the desired number of tasks. The default value is 100%.
For a service that uses the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the minimum number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state.
For the Fargate launch type, the minimum healthy percent value is not used.
" } } @@ -6088,24 +6220,28 @@ "DesiredCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of instantiations of the task definition to run on the service.
" } }, "EnableEcsManagedTags": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to enable Amazon ECS managed tags for the tasks in the service.
" } }, "EnableExecuteCommand": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the execute command functionality is enabled for the service.
" } }, "HealthCheckGracePeriodSeconds": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.
" } }, @@ -6210,6 +6346,7 @@ "ContainerPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
The port value to use for the service discovery service.
\nIf the task definition uses the bridge or host network mode, you must specify ContainerName and ContainerPort.
If the task definition uses the awsvpc network mode and a type SRV DNS record, you must specify either ContainerName and ContainerPort, or Port , but not both.
The port value to use for a service discovery service that specifies an SRV record. This field can be used if both the awsvpcawsvpc network mode and SRV records are used.
The number of CPU units reserved for the container.
" } }, @@ -6416,6 +6556,7 @@ "DisableNetworking": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to disable networking within the container.
" } }, @@ -6464,6 +6605,7 @@ "Essential": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the container is essential. All tasks must have at least one essential container.
" } }, @@ -6500,6 +6642,7 @@ "Interactive": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "If set to true, then containerized applications can be deployed that require stdin or a tty to be allocated.
The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is shut down. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified.
" } }, "MemoryReservation": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container.
" } }, @@ -6554,18 +6699,21 @@ "Privileged": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.
" } }, "PseudoTerminal": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to allocate a TTY to the container.
" } }, "ReadonlyRootFilesystem": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the container is given read-only access to its root file system.
" } }, @@ -6590,12 +6738,14 @@ "StartTimeout": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of seconds to wait before giving up on resolving dependencies for a container.
" } }, "StopTimeout": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.
" } }, @@ -6744,24 +6894,28 @@ "Interval": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The time period in seconds between each health check execution. The default value is 30 seconds.
" } }, "Retries": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of times to retry a failed health check before the container is considered unhealthy. The default value is 3.
" } }, "StartPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.
" } }, "Timeout": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The time period in seconds to wait for a health check to succeed before it is considered a failure. The default value is 5.
" } } @@ -6808,24 +6962,28 @@ "InitProcessEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to run an init process inside the container that forwards signals and reaps processes.
The total amount of swap memory (in MiB) that a container can use.
" } }, "SharedMemorySize": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The value for the size (in MiB) of the /dev/shm volume.
" } }, "Swappiness": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Configures the container's memory swappiness behavior. Determines how aggressively pages are swapped. The higher the value, the more aggressive the swappiness. The default is 60.
" } }, @@ -6890,6 +7048,7 @@ "Size": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum size (in MiB) of the tmpfs volume.
" } } @@ -6974,6 +7133,7 @@ "ReadOnly": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the container has read-only access to the volume.
" } }, @@ -7000,12 +7160,14 @@ "ContainerPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port number on the container that is bound to the user-specified or automatically assigned host port.
" } }, "HostPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port number on the container instance to reserve for the container.
" } }, @@ -7124,6 +7286,7 @@ "HardLimit": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The hard limit for the ulimit type.
" } }, @@ -7136,6 +7299,7 @@ "SoftLimit": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The soft limit for the ulimit type.
" } } @@ -7156,6 +7320,7 @@ "ReadOnly": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the container has read-only access to the volume.
" } }, @@ -7410,6 +7575,7 @@ "Autoprovision": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to create the Docker volume automatically if it does not already exist.
" } }, @@ -7492,6 +7658,7 @@ "TransitEncryptionPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
" } } @@ -7806,6 +7973,7 @@ "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the logging types that are listed in Types are enabled.
Whether to require that all traffic to the domain arrive over HTTPS.
" } }, @@ -8166,12 +8335,14 @@ "DedicatedMasterCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.
Whether to use a dedicated master node for the Elasticsearch domain. A dedicated master node performs cluster management tasks, but doesn't hold data or respond to data upload requests.
" } }, @@ -8184,6 +8355,7 @@ "InstanceCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of data nodes to use in the Elasticsearch domain.
" } }, @@ -8202,6 +8374,7 @@ "ZoneAwarenessEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to enable zone awareness for the Elasticsearch domain. When zone awareness is enabled, OpenSearch allocates the cluster's nodes and replica index shards across Availability Zones in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.
" } } @@ -8216,6 +8389,7 @@ "AvailabilityZoneCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "he number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.
" } } @@ -8230,6 +8404,7 @@ "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether encryption at rest is enabled.
" } }, @@ -8279,6 +8454,7 @@ "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the log publishing is enabled.
" } } @@ -8293,6 +8469,7 @@ "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether node-to-node encryption is enabled.
" } } @@ -8313,6 +8490,7 @@ "Cancellable": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether a request to update the domain can be canceled.
" } }, @@ -8337,6 +8515,7 @@ "UpdateAvailable": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether a service software update is available for the domain.
" } }, @@ -8421,6 +8600,7 @@ "CookieExpirationPeriod": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The amount of time, in seconds, after which the cookie is considered stale. If an\n expiration period is not specified, the stickiness session lasts for the duration of the\n browser session.
" } }, @@ -8441,12 +8621,14 @@ "EmitInterval": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The interval in minutes for publishing the access logs.
\nYou can publish access logs either every 5 minutes or every 60 minutes.
" } }, "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether access logs are enabled for the load balancer.
" } }, @@ -8537,6 +8719,7 @@ "InstancePort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port on which the EC2 instance is listening.
" } }, @@ -8563,12 +8746,14 @@ "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether connection draining is enabled for the load balancer.
" } }, "Timeout": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum time, in seconds, to keep the existing connections open before deregistering\n the instances.
" } } @@ -8583,6 +8768,7 @@ "IdleTimeout": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The time, in seconds, that the connection can be idle (no data is sent over the\n connection) before it is closed by the load balancer.
" } } @@ -8597,6 +8783,7 @@ "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether cross-zone load balancing is enabled for the load balancer.
" } } @@ -8721,12 +8908,14 @@ "HealthyThreshold": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of consecutive health check successes required before the instance is moved\n to the Healthy state.
" } }, "Interval": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The approximate interval, in seconds, between health checks of an individual\n instance.
" } }, @@ -8739,12 +8928,14 @@ "Timeout": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The amount of time, in seconds, during which no response means a failed health\n check.
" } }, "UnhealthyThreshold": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of consecutive health check failures that must occur before the instance is\n moved to the Unhealthy state.
" } } @@ -8779,6 +8970,7 @@ "InstancePort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port on which the instance is listening.
" } }, @@ -8791,6 +8983,7 @@ "LoadBalancerPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port on which the load balancer is listening.
\nOn EC2-VPC, you can specify any port from the range 1-65535.
\nOn EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587,\n 1024-65535.
" } }, @@ -9074,6 +9267,7 @@ "MfaAuthenticated": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the session used multi-factor authentication (MFA).
" } }, @@ -9127,18 +9321,20 @@ } }, "com.amazonaws.securityhub#AwsIamAccessKeyStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Active", - "name": "ACTIVE" - }, - { - "value": "Inactive", - "name": "INACTIVE" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" } - ] + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + } } }, "com.amazonaws.securityhub#AwsIamAttachedManagedPolicy": { @@ -9357,6 +9553,7 @@ "AttachmentCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of users, groups, and roles that the policy is attached to.
" } }, @@ -9381,6 +9578,7 @@ "IsAttachable": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the policy can be attached to a user, group, or role.
" } }, @@ -9393,6 +9591,7 @@ "PermissionsBoundaryUsageCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of users and roles that use the policy to set the permissions\n boundary.
" } }, @@ -9437,6 +9636,7 @@ "IsDefaultVersion": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the version is the default version.
" } }, @@ -9518,6 +9718,7 @@ "MaxSessionDuration": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum session duration (in seconds) that you want to set for the specified role.
" } }, @@ -9652,12 +9853,14 @@ "ShardCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of shards that the stream uses. \n
" } }, "RetentionPeriodHours": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of hours for the data records that are stored in shards to remain accessible. \n
" } } @@ -9698,6 +9901,7 @@ "CreationDate": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Indicates when the KMS key was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Whether the key has key rotation enabled.
" } } @@ -9854,6 +10059,7 @@ "MemorySize": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The memory that is allocated to the function.
" } }, @@ -9878,6 +10084,7 @@ "Timeout": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The amount of time that Lambda allows a function to run before stopping it.
" } }, @@ -9956,6 +10163,7 @@ "CodeSize": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The size of the layer archive in bytes.
" } } @@ -10016,6 +10224,7 @@ "Version": { "target": "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version number.
" } }, @@ -10037,7 +10246,10 @@ } }, "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber": { - "type": "long" + "type": "long", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.securityhub#AwsMountPoint": { "type": "structure", @@ -10071,6 +10283,7 @@ "DeleteProtection": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the firewall is protected from deletion. If set to true, then the firewall cannot be deleted.
Whether the firewall is protected from a change to the firewall policy. If set to true, you cannot associate a different policy with the firewall.
Whether the firewall is protected from a change to the subnet associations. If set to true, you cannot map different subnets to the firewall.
The maximum number of operating resources that this rule group can use.
" } }, @@ -10247,12 +10463,14 @@ "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Enables fine-grained access control.\n
" } }, "InternalUserDatabaseEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Enables the internal user database.\n
" } }, @@ -10273,24 +10491,28 @@ "InstanceCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of data nodes to use in the OpenSearch domain.
" } }, "WarmEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether UltraWarm is enabled.
" } }, "WarmCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of UltraWarm instances.
" } }, "DedicatedMasterEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.
" } }, @@ -10303,6 +10525,7 @@ "DedicatedMasterCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.
Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.
" } }, @@ -10341,6 +10565,7 @@ "AvailabilityZoneCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of Availability Zones that the domain uses. Valid values are 2 or 3. The default is 2.
Whether to enable a custom endpoint for the domain.
" } }, "EnforceHTTPS": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to require that all traffic to the domain arrive over HTTPS.
" } }, @@ -10491,6 +10718,7 @@ "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether encryption at rest is enabled.
" } }, @@ -10517,6 +10745,7 @@ "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the log publishing is enabled.
" } } @@ -10583,6 +10812,7 @@ "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether node-to-node encryption is enabled.
" } } @@ -10603,6 +10833,7 @@ "Cancellable": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether a request to update the domain can be canceled.
" } }, @@ -10627,6 +10858,7 @@ "UpdateAvailable": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether a service software update is available for the domain.
" } }, @@ -10639,6 +10871,7 @@ "OptionalDeployment": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the service software update is optional.
" } } @@ -10699,6 +10932,7 @@ "AllocatedStorage": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "For all database engines except Aurora, specifies the allocated storage size in\n gibibytes (GiB).
" } }, @@ -10711,6 +10945,7 @@ "BackupRetentionPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of days for which automated backups are retained.
" } }, @@ -10747,6 +10982,7 @@ "MultiAz": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the DB cluster has instances in multiple Availability Zones.
" } }, @@ -10765,6 +11001,7 @@ "Port": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port number on which the DB instances in the DB cluster accept connections.
" } }, @@ -10807,6 +11044,7 @@ "StorageEncrypted": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the DB cluster is encrypted.
" } }, @@ -10849,12 +11087,14 @@ "DeletionProtection": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the DB cluster has deletion protection enabled.
" } }, "HttpEndpointEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
" } }, @@ -10867,12 +11107,14 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether tags are copied from the DB cluster to snapshots of the DB cluster.
" } }, "CrossAccountClone": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services\n account.
" } }, @@ -10915,6 +11157,7 @@ "IamDatabaseAuthenticationEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the mapping of IAM accounts to database accounts is enabled.
" } } @@ -10929,12 +11172,14 @@ "IsClusterWriter": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the cluster member is the primary instance for the DB cluster.
" } }, "PromotionTier": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the order in which an Aurora replica is promoted to the primary instance when\n the existing primary instance fails.
" } }, @@ -11011,6 +11256,7 @@ "AllocatedStorage": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the allocated storage size in gibibytes (GiB).
" } }, @@ -11023,6 +11269,7 @@ "Port": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port number on which the DB instances in the DB cluster accept connections.
" } }, @@ -11065,12 +11312,14 @@ "PercentProgress": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the percentage of the estimated data that has been transferred.
" } }, "StorageEncrypted": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the DB cluster is encrypted.
" } }, @@ -11095,6 +11344,7 @@ "IamDatabaseAuthenticationEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether mapping of IAM accounts to database accounts is enabled.
" } } @@ -11209,6 +11459,7 @@ "DbInstancePort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the port that the DB instance listens on. If the DB instance is part of a DB\n cluster, this can be a different port than the DB cluster port.
" } }, @@ -11227,6 +11478,7 @@ "DeletionProtection": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the DB instance has deletion protection enabled.
\nWhen deletion protection is enabled, the database cannot be deleted.
" } }, @@ -11251,6 +11503,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "True if mapping of IAM accounts to database\n accounts is enabled, and otherwise false.
\nIAM database authentication can be enabled for the following database engines.
\nFor MySQL 5.6, minor version 5.6.34 or higher
\nFor MySQL 5.7, minor version 5.7.16 or higher
\nAurora 5.6 or higher
\nSpecifies the accessibility options for the DB instance.
\nA value of true specifies an Internet-facing instance with a publicly resolvable DNS\n name, which resolves to a public IP address.
\nA value of false specifies an internal instance with a DNS name that resolves to a\n private IP address.
" } }, "StorageEncrypted": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the DB instance is encrypted.
" } }, @@ -11293,6 +11548,7 @@ "MultiAz": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the DB instance is a multiple Availability Zone deployment.
" } }, @@ -11317,6 +11573,7 @@ "AllocatedStorage": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The amount of storage (in gigabytes) to initially allocate for the DB instance.
" } }, @@ -11329,6 +11586,7 @@ "BackupRetentionPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of days for which to retain automated backups.
" } }, @@ -11377,6 +11635,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether minor version patches are applied automatically.
" } }, @@ -11407,6 +11666,7 @@ "Iops": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
" } }, @@ -11449,12 +11709,14 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to copy resource tags to snapshots of the DB instance.
" } }, "MonitoringInterval": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The interval, in seconds, between points when enhanced monitoring metrics are collected\n for the DB instance.
" } }, @@ -11467,6 +11729,7 @@ "PromotionTier": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The order in which to promote an Aurora replica to the primary instance after a failure\n of the existing primary instance.
" } }, @@ -11479,6 +11742,7 @@ "PerformanceInsightsEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether Performance Insights is enabled for the DB instance.
" } }, @@ -11491,6 +11755,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of days to retain Performance Insights data.
" } }, @@ -11512,6 +11777,7 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The upper limit to which Amazon RDS can automatically scale the storage of the DB\n instance.
" } } @@ -11532,6 +11798,7 @@ "Port": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Specifies the port that the database engine is listening on.
" } }, @@ -11636,6 +11903,7 @@ "AllocatedStorage": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The new value of the allocated storage for the DB instance.
" } }, @@ -11648,18 +11916,21 @@ "Port": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The new port for the DB instance.
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The new backup retention period for the DB instance.
" } }, "MultiAZ": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates that a single Availability Zone DB instance is changing to a multiple Availability Zone deployment.
" } }, @@ -11678,6 +11949,7 @@ "Iops": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The new provisioned IOPS value for the DB instance.
" } }, @@ -11892,6 +12164,7 @@ "AllocatedStorage": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The amount of storage (in gigabytes) to be initially allocated for the database instance.
" } }, @@ -11904,6 +12177,7 @@ "Port": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port that the database engine was listening on at the time of the snapshot.
" } }, @@ -11952,6 +12226,7 @@ "Iops": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
" } }, @@ -11964,6 +12239,7 @@ "PercentProgress": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The percentage of the estimated data that has been transferred.
" } }, @@ -11994,6 +12270,7 @@ "Encrypted": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the DB snapshot is encrypted.
" } }, @@ -12012,6 +12289,7 @@ "IamDatabaseAuthenticationEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether mapping of IAM accounts to database accounts is enabled.
" } }, @@ -12044,6 +12322,7 @@ "Normal": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the read replica instance is operating normally.
" } }, @@ -12178,6 +12457,7 @@ "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the event notification subscription is enabled.
" } }, @@ -12382,12 +12662,14 @@ "ManualSnapshotRetentionPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of days that manual snapshots are retained in the destination region after\n they are copied from a source region.
\nIf the value is -1,\n then the manual snapshot is retained indefinitely.
Valid values: Either -1\n or an integer between 1 and 3,653
The number of days to retain automated snapshots in the destination Region after they\n are copied from a source Region.
" } }, @@ -12440,12 +12722,14 @@ "AllowVersionUpgrade": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether major version upgrades are applied automatically to the cluster during\n the maintenance window.
" } }, "AutomatedSnapshotRetentionPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of days that automatic cluster snapshots are retained.
" } }, @@ -12554,6 +12838,7 @@ "Encrypted": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the data in the cluster is encrypted at rest.
" } }, @@ -12566,6 +12851,7 @@ "EnhancedVpcRouting": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether to create the cluster with enhanced VPC routing enabled.
" } }, @@ -12608,6 +12894,7 @@ "ManualSnapshotRetentionPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The default number of days to retain a manual snapshot.
\nIf the value is -1, the snapshot is retained indefinitely.
This setting doesn't change the retention period of existing snapshots.
\nValid values: Either -1 or an integer between 1 and 3,653
The number of compute nodes in the cluster.
" } }, @@ -12656,6 +12944,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the cluster can be accessed from a public network.
" } }, @@ -12738,6 +13027,7 @@ "Port": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The port that the database engine listens on.
" } } @@ -12828,6 +13118,7 @@ "LoggingEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether logging is enabled.
" } }, @@ -12848,6 +13139,7 @@ "AutomatedSnapshotRetentionPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The pending or in-progress change to the automated snapshot retention period.
" } }, @@ -12878,6 +13170,7 @@ "EnhancedVpcRouting": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether to create the cluster with enhanced VPC routing enabled.
" } }, @@ -12902,12 +13195,14 @@ "NumberOfNodes": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The pending or in-progress change to the number of nodes in the cluster.
" } }, "PubliclyAccessible": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "The pending or in-progress change to whether the cluster can be connected to from the\n public network.
" } } @@ -12922,6 +13217,7 @@ "AllowCancelResize": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the resize operation can be canceled.
" } }, @@ -12942,30 +13238,35 @@ "CurrentRestoreRateInMegaBytesPerSecond": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of megabytes per second being transferred from the backup storage. Returns\n the average rate for a completed backup.
\nThis field is only updated when you restore to DC2 and DS2 node types.
" } }, "ElapsedTimeInSeconds": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The amount of time an in-progress restore has been running, or the amount of time it\n took a completed restore to finish.
\nThis field is only updated when you restore to DC2 and DS2 node types.
" } }, "EstimatedTimeToCompletionInSeconds": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The estimate of the time remaining before the restore is complete. Returns 0 for a\n completed restore.
\nThis field is only updated when you restore to DC2 and DS2 node types.
" } }, "ProgressInMegaBytes": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of megabytes that were transferred from snapshot storage.
\nThis field is only updated when you restore to DC2 and DS2 node types.
" } }, "SnapshotSizeInMegaBytes": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The size of the set of snapshot data that was used to restore the cluster.
\nThis field is only updated when you restore to DC2 and DS2 node types.
" } }, @@ -13012,24 +13313,28 @@ "BlockPublicAcls": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether to reject calls to update an S3 bucket if the calls include a public access control list (ACL).
" } }, "BlockPublicPolicy": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether to reject calls to update the access policy for an S3 bucket or access point if the policy allows public access.
" } }, "IgnorePublicAcls": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether Amazon S3 ignores public ACLs that are associated with an S3 bucket.
" } }, "RestrictPublicBuckets": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether to restrict access to an access point or S3 bucket that has a public policy to only Amazon Web Services service principals and authorized users within the S3 bucket owner's account.
" } } @@ -13058,6 +13363,7 @@ "DaysAfterInitiation": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of days after which Amazon S3 cancels an incomplete multipart upload.
" } } @@ -13084,12 +13390,14 @@ "ExpirationInDays": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The length in days of the lifetime for objects that are subject to the rule.
" } }, "ExpiredObjectDeleteMarker": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether Amazon S3 removes a delete marker that has no noncurrent versions. If set to\n true, the delete marker is expired. If set to false, the policy\n takes no action.
If you provide ExpiredObjectDeleteMarker, you cannot provide\n ExpirationInDays or ExpirationDate.
The number of days that an object is noncurrent before Amazon S3 can perform the associated action.
" } }, @@ -13270,6 +13579,7 @@ "Days": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of days that an object is noncurrent before Amazon S3 can perform the associated action.
" } }, @@ -13302,6 +13612,7 @@ "Days": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of days after which to transition the object to the specified storage class. If you provide Days, you cannot provide Date.
Specifies whether MFA delete is currently enabled in the S3 bucket versioning configuration. If the S3 bucket was never configured with MFA delete, then this attribute is not included.
" } }, @@ -13549,18 +13861,20 @@ } }, "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRuleName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Prefix", - "name": "PREFIX" - }, - { - "value": "Suffix", - "name": "SUFFIX" + "type": "enum", + "members": { + "PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Prefix" + } + }, + "SUFFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Suffix" } - ] + } } }, "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRules": { @@ -13815,6 +14129,7 @@ "RotationOccurredWithinFrequency": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the rotation occurred within the specified rotation frequency.
" } }, @@ -13827,6 +14142,7 @@ "RotationEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether rotation is enabled.
" } }, @@ -13839,6 +14155,7 @@ "Deleted": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the secret is deleted.
" } }, @@ -13865,6 +14182,7 @@ "AutomaticallyAfterDays": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of days after the previous rotation to rotate the secret.
" } } @@ -13970,12 +14288,14 @@ "Confidence": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A finding's confidence. Confidence is defined as the likelihood that a finding\n accurately identifies the behavior or issue that it was intended to identify.
\nConfidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.
" } }, "Criticality": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The level of importance assigned to the resources associated with the finding.
\nA score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.
" } }, @@ -14129,6 +14449,7 @@ "Sample": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the finding is a sample finding.
" } } @@ -14867,6 +15188,7 @@ "KmsDataKeyReusePeriodSeconds": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.
" } }, @@ -14905,18 +15227,21 @@ "CompliantCriticalCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "For the patches that are compliant, the number that have a severity of\n CRITICAL.
For the patches that are compliant, the number that have a severity of\n HIGH.
For the patches that are compliant, the number that have a severity of\n MEDIUM.
For the patch items that are noncompliant, the number of items that have a severity of\n CRITICAL.
For the patches that are compliant, the number that have a severity of\n INFORMATIONAL.
For the patches that are noncompliant, the number that have a severity of\n INFORMATIONAL.
For the patches that are compliant, the number that have a severity of\n UNSPECIFIED.
For the patches that are noncompliant, the number that have a severity of\n LOW.
For the patches that are noncompliant, the number that have a severity of\n HIGH.
For the patches that are compliant, the number that have a severity of\n LOW.
For the patches that are noncompliant, the number that have a severity of\n MEDIUM.
For the patches that are noncompliant, the number that have a severity of\n UNSPECIFIED.
The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.
If set to true, then the rule actions are performed on requests that match the predicate settings.
If set to false, then the rule actions are performed on all requests except those that match the predicate settings.\n
The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.
If set to true, then the rule actions are performed on requests that match the predicate settings.
If set to false, then the rule actions are performed on all requests except those that match the predicate settings.
If you define more than one rule in a web ACL, WAF evaluates each request against the rules in\n order based on the value of Priority.
Specifies if you want WAF to allow, block, or count requests based on the settings in the \n ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n
The order in which WAF evaluates the rules in a web ACL.\n
" } }, @@ -15537,6 +15878,7 @@ "Priority": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "If you define more than one rule in a web ACL, WAF evaluates each request against the rules in order\n based on the value of Priority.
Specifies if you want WAF to allow, block, or count requests based on the settings in the \n ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n
Specifies the order in which the rules in a web\n ACL are evaluated. Rules with a lower value for Priority are\n evaluated before rules with a higher value. The value must be a unique integer. If you add\n multiple rules to a web ACL, the values do not need to be consecutive.
The number of findings that failed to import.
", "smithy.api#required": {} } @@ -15879,6 +16224,7 @@ "SuccessCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of findings that were successfully imported.
", "smithy.api#required": {} } @@ -15950,12 +16296,14 @@ "Confidence": { "target": "com.amazonaws.securityhub#RatioScale", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The updated value for the finding confidence. Confidence is defined as the likelihood\n that a finding accurately identifies the behavior or issue that it was intended to\n identify.
\nConfidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.
" } }, "Criticality": { "target": "com.amazonaws.securityhub#RatioScale", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The updated value for the level of importance assigned to the resources associated with\n the findings.
\nA score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.
" } }, @@ -16040,7 +16388,10 @@ } }, "com.amazonaws.securityhub#Boolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.securityhub#BooleanFilter": { "type": "structure", @@ -16048,6 +16399,7 @@ "Value": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "The value of the boolean.
" } } @@ -16074,12 +16426,14 @@ "Column": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The column number of the column that contains the data. For a Microsoft Excel workbook, the column number corresponds to the alphabetical column identifiers. For example, a value of 1 for Column corresponds to the A column in the workbook.
" } }, "Row": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The row number of the row that contains the data.
" } }, @@ -16164,12 +16518,14 @@ "SizeClassified": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total size in bytes of the affected data.
" } }, "AdditionalOccurrences": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether there are additional occurrences of sensitive data that are not included in the finding. This occurs when the number of occurrences exceeds the maximum that can be included.
" } }, @@ -16243,26 +16599,32 @@ } }, "com.amazonaws.securityhub#ComplianceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PASSED", - "name": "PASSED" - }, - { - "value": "WARNING", - "name": "WARNING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "NOT_AVAILABLE", - "name": "NOT_AVAILABLE" + "type": "enum", + "members": { + "PASSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSED" } - ] + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARNING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_AVAILABLE" + } + } } }, "com.amazonaws.securityhub#ContainerDetails": { @@ -16307,6 +16669,7 @@ "Privileged": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "When this parameter is true, the container is given elevated privileges on the host \ncontainer instance (similar to the root user). \n
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.\n
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.\n
The total number of occurrences of sensitive data that were detected.
" } }, @@ -16691,6 +17058,7 @@ "TotalCount": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of occurrences of sensitive data.
" } } @@ -16711,6 +17079,7 @@ "BaseScore": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The base CVSS score.
" } }, @@ -16801,6 +17170,7 @@ "Value": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A date range value for the date filter.
" } }, @@ -16816,14 +17186,14 @@ } }, "com.amazonaws.securityhub#DateRangeUnit": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DAYS", - "name": "DAYS" + "type": "enum", + "members": { + "DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAYS" } - ] + } } }, "com.amazonaws.securityhub#DeclineInvitations": { @@ -17218,6 +17588,7 @@ "MaxResults": { "target": "com.amazonaws.securityhub#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of results to return.
" } } @@ -17305,6 +17676,7 @@ "AutoEnableControls": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to automatically enable new controls when they are added to standards that are\n enabled.
\nIf set to true, then new controls for enabled standards are enabled\n automatically. If set to false, then new controls are not enabled.
Whether to automatically enable Security Hub for new accounts in the organization.
\nIf set to true, then Security Hub is enabled for new accounts. If set to false,\n then new accounts are not added automatically.
Whether the maximum number of allowed member accounts are already associated with the\n Security Hub administrator account.
" } }, @@ -17418,6 +17792,7 @@ "MaxResults": { "target": "com.amazonaws.securityhub#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of results to return.
", "smithy.api#httpQuery": "MaxResults" } @@ -17541,6 +17916,7 @@ "MaxResults": { "target": "com.amazonaws.securityhub#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of security standard controls to return.
", "smithy.api#httpQuery": "MaxResults" } @@ -17577,6 +17953,7 @@ "MaxResults": { "target": "com.amazonaws.securityhub#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of standards to return.
", "smithy.api#httpQuery": "MaxResults" } @@ -17892,6 +18269,7 @@ "Blocked": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the DNS request was blocked.
" } } @@ -17901,7 +18279,10 @@ } }, "com.amazonaws.securityhub#Double": { - "type": "double" + "type": "double", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.securityhub#EnableImportFindingsForProduct": { "type": "operation", @@ -18053,6 +18434,7 @@ "EnableDefaultStandards": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether to enable the security standards that Security Hub has designated as automatically\n enabled. If you do not provide a value for EnableDefaultStandards, it is set\n to true. To not enable the automatically enabled standards, set\n EnableDefaultStandards to false.
A finding's confidence. Confidence is defined as the likelihood that a finding\n accurately identifies the behavior or issue that it was intended to identify.
\nConfidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.
" } }, "Criticality": { "target": "com.amazonaws.securityhub#RatioScale", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The level of importance assigned to the resources associated with the finding.
\nA score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.
" } }, @@ -18277,6 +18661,7 @@ "Priority": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The order in which to run the stateless rule group.
" } }, @@ -18303,12 +18688,14 @@ "Lon": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The longitude of the location.
" } }, "Lat": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The latitude of the location.
" } } @@ -18418,6 +18805,7 @@ "MaxResults": { "target": "com.amazonaws.securityhub#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of results to return in the response.
" } } @@ -18580,6 +18968,7 @@ "MaxResults": { "target": "com.amazonaws.securityhub#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of findings to return.
" } } @@ -18720,6 +19109,7 @@ "MaxResults": { "target": "com.amazonaws.securityhub#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of items to return in the response.
" } } @@ -18784,6 +19174,7 @@ "InvitationsCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of all membership invitations sent to this Security Hub member account, not\n including the currently accepted invitation.
" } } @@ -18910,12 +19301,14 @@ "Code": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The ICMP code for which to deny or allow access. To deny or allow all codes, use the\n value -1.
The ICMP type for which to deny or allow access. To deny or allow all types, use the\n value -1.
The number of findings returned for each GroupByAttributeValue.
The Autonomous System Number (ASN) of the internet provider
" } }, @@ -19402,6 +19804,7 @@ "MaxResults": { "target": "com.amazonaws.securityhub#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of items to return in the response.
", "smithy.api#httpQuery": "MaxResults" } @@ -19478,6 +19881,7 @@ "MaxResults": { "target": "com.amazonaws.securityhub#MaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of results to return. This operation currently only returns a single result.
", "smithy.api#httpQuery": "MaxResults" } @@ -19544,6 +19948,7 @@ "MaxResults": { "target": "com.amazonaws.securityhub#CrossAccountMaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of items to return in the response.
", "smithy.api#httpQuery": "MaxResults" } @@ -19617,6 +20022,7 @@ "OnlyAssociated": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Specifies which member accounts to include in the response based on their relationship\n status with the administrator account. The default value is TRUE.
If OnlyAssociated is set to TRUE, the response includes member\n accounts whose relationship status with the administrator account is set to ENABLED.
If OnlyAssociated is set to FALSE, the response includes all\n existing member accounts.
The maximum number of items to return in the response.
", "smithy.api#httpQuery": "MaxResults" } @@ -19697,6 +20104,7 @@ "MaxResults": { "target": "com.amazonaws.securityhub#AdminsMaxResults", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of items to return in the response.
", "smithy.api#httpQuery": "MaxResults" } @@ -19800,7 +20208,10 @@ } }, "com.amazonaws.securityhub#Long": { - "type": "long" + "type": "long", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.securityhub#Malware": { "type": "structure", @@ -19842,89 +20253,121 @@ } }, "com.amazonaws.securityhub#MalwareState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OBSERVED", - "name": "OBSERVED" - }, - { - "value": "REMOVAL_FAILED", - "name": "REMOVAL_FAILED" - }, - { - "value": "REMOVED", - "name": "REMOVED" + "type": "enum", + "members": { + "OBSERVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OBSERVED" + } + }, + "REMOVAL_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVAL_FAILED" + } + }, + "REMOVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVED" } - ] + } } }, "com.amazonaws.securityhub#MalwareType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ADWARE", - "name": "ADWARE" - }, - { - "value": "BLENDED_THREAT", - "name": "BLENDED_THREAT" - }, - { - "value": "BOTNET_AGENT", - "name": "BOTNET_AGENT" - }, - { - "value": "COIN_MINER", - "name": "COIN_MINER" - }, - { - "value": "EXPLOIT_KIT", - "name": "EXPLOIT_KIT" - }, - { - "value": "KEYLOGGER", - "name": "KEYLOGGER" - }, - { - "value": "MACRO", - "name": "MACRO" - }, - { - "value": "POTENTIALLY_UNWANTED", - "name": "POTENTIALLY_UNWANTED" - }, - { - "value": "SPYWARE", - "name": "SPYWARE" - }, - { - "value": "RANSOMWARE", - "name": "RANSOMWARE" - }, - { - "value": "REMOTE_ACCESS", - "name": "REMOTE_ACCESS" - }, - { - "value": "ROOTKIT", - "name": "ROOTKIT" - }, - { - "value": "TROJAN", - "name": "TROJAN" - }, - { - "value": "VIRUS", - "name": "VIRUS" - }, - { - "value": "WORM", - "name": "WORM" + "type": "enum", + "members": { + "ADWARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADWARE" + } + }, + "BLENDED_THREAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLENDED_THREAT" + } + }, + "BOTNET_AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTNET_AGENT" + } + }, + "COIN_MINER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COIN_MINER" + } + }, + "EXPLOIT_KIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPLOIT_KIT" + } + }, + "KEYLOGGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEYLOGGER" + } + }, + "MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MACRO" + } + }, + "POTENTIALLY_UNWANTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POTENTIALLY_UNWANTED" + } + }, + "SPYWARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPYWARE" + } + }, + "RANSOMWARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANSOMWARE" + } + }, + "REMOTE_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOTE_ACCESS" + } + }, + "ROOTKIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROOTKIT" + } + }, + "TROJAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TROJAN" + } + }, + "VIRUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIRUS" + } + }, + "WORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORM" } - ] + } } }, "com.amazonaws.securityhub#MapFilter": { @@ -19954,18 +20397,20 @@ } }, "com.amazonaws.securityhub#MapFilterComparison": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUALS", - "name": "EQUALS" - }, - { - "value": "NOT_EQUALS", - "name": "NOT_EQUALS" + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "NOT_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EQUALS" } - ] + } } }, "com.amazonaws.securityhub#MapFilterList": { @@ -19977,6 +20422,7 @@ "com.amazonaws.securityhub#MaxResults": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -20078,6 +20524,7 @@ "SourcePort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The source port of network-related information about a finding.
" } }, @@ -20108,6 +20555,7 @@ "DestinationPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The destination port of network-related information about a finding.
" } }, @@ -20158,6 +20606,7 @@ "Blocked": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the network connection attempt was blocked.
" } } @@ -20167,18 +20616,20 @@ } }, "com.amazonaws.securityhub#NetworkDirection": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IN", - "name": "IN" - }, - { - "value": "OUT", - "name": "OUT" + "type": "enum", + "members": { + "IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN" } - ] + }, + "OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUT" + } + } } }, "com.amazonaws.securityhub#NetworkHeader": { @@ -20337,18 +20788,21 @@ "Gte": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The greater-than-equal condition to be applied to a single field when querying for\n findings.
" } }, "Lte": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The less-than-equal condition to be applied to a single field when querying for\n findings.
" } }, "Eq": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The equal-to condition to be applied to a single field when querying for\n findings.
" } } @@ -20407,6 +20861,7 @@ "PageNumber": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The page number of the page that contains the sensitive data.
" } }, @@ -20434,22 +20889,26 @@ } }, "com.amazonaws.securityhub#Partition": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "aws", - "name": "AWS" - }, - { - "value": "aws-cn", - "name": "AWS_CN" - }, - { - "value": "aws-us-gov", - "name": "AWS_US_GOV" + "type": "enum", + "members": { + "AWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws" + } + }, + "AWS_CN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws-cn" + } + }, + "AWS_US_GOV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws-us-gov" } - ] + } } }, "com.amazonaws.securityhub#PatchSummary": { @@ -20465,36 +20924,42 @@ "InstalledCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of patches from the compliance standard that were installed\n successfully.
" } }, "MissingCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of patches that are part of the compliance standard but are not installed.\n The count includes patches that failed to install.
" } }, "FailedCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of patches from the compliance standard that failed to install.
" } }, "InstalledOtherCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of installed patches that are not part of the compliance standard.
" } }, "InstalledRejectedCount": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of patches that are installed but are also on a list of patches that the\n customer rejected.
" } }, "InstalledPendingReboot": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of patches that were applied, but that require the instance to be rebooted in\n order to be marked as installed.
" } }, @@ -20539,6 +21004,7 @@ "Blocked": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the port probe was blocked.
" } } @@ -20585,12 +21051,14 @@ "Begin": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The first port in the port range.
" } }, "End": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The last port in the port range.
" } } @@ -20605,12 +21073,14 @@ "From": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The first port in the port range.
" } }, "To": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The last port in the port range.
" } } @@ -20643,12 +21113,14 @@ "Pid": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The process ID.
" } }, "ParentPid": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The parent process ID.
" } }, @@ -20750,18 +21222,21 @@ "Start": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
" } }, "End": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
" } }, "StartColumn": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "In the line where the sensitive data starts, the column within the line where the sensitive data starts.
" } } @@ -20779,6 +21254,7 @@ "com.amazonaws.securityhub#RatioScale": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 100 @@ -20817,6 +21293,7 @@ "RecordIndex": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The record index, starting from 0, for the record that contains the data.
" } } @@ -20826,18 +21303,20 @@ } }, "com.amazonaws.securityhub#RecordState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "ARCHIVED", - "name": "ARCHIVED" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" } - ] + } } }, "com.amazonaws.securityhub#Records": { @@ -21786,12 +22265,14 @@ "FromPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The starting port value for the port range.
" } }, "ToPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The ending port value for the port range.
" } } @@ -21838,12 +22319,14 @@ "FromPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The starting port value for the port range.
" } }, "ToPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The ending port value for the port range.
" } } @@ -21930,6 +22413,7 @@ "Priority": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Indicates the order in which to run this rule relative to all of the rules in the stateless rule group.
" } }, @@ -22006,21 +22490,6 @@ }, "com.amazonaws.securityhub#SecurityHubAPIService": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "SecurityHub", - "arnNamespace": "securityhub", - "cloudFormationName": "SecurityHub", - "cloudTrailEventSource": "securityhub.amazonaws.com", - "endpointPrefix": "securityhub" - }, - "aws.auth#sigv4": { - "name": "securityhub" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the \n Security HubUser\n Guide\n .
\nWhen you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.
\nFor example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.
The following throttling limits apply to using Security Hub API operations.
\n\n BatchEnableStandards - RateLimit of 1\n request per second, BurstLimit of 1 request per second.
\n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.
\n BatchImportFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
\n BatchUpdateFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
\n UpdateStandardsControl - RateLimit of\n 1 request per second, BurstLimit of 5 requests per second.
All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
The total number of occurrences of sensitive data that were detected.
" - } + ], + "traits": { + "aws.api#service": { + "sdkId": "SecurityHub", + "arnNamespace": "securityhub", + "cloudFormationName": "SecurityHub", + "cloudTrailEventSource": "securityhub.amazonaws.com", + "endpointPrefix": "securityhub" }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "The type of sensitive data that was detected. For example, the type might indicate that the data is an email address.
" - } + "aws.auth#sigv4": { + "name": "securityhub" }, - "Occurrences": { - "target": "com.amazonaws.securityhub#Occurrences", - "traits": { - "smithy.api#documentation": "Details about the sensitive data that was detected.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The list of detected instances of sensitive data.
" - } - }, - "com.amazonaws.securityhub#SensitiveDataDetectionsList": { + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the \n Security HubUser\n Guide\n .
\nWhen you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.
\nFor example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.
The following throttling limits apply to using Security Hub API operations.
\n\n BatchEnableStandards - RateLimit of 1\n request per second, BurstLimit of 1 request per second.
\n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.
\n BatchImportFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
\n BatchUpdateFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
\n UpdateStandardsControl - RateLimit of\n 1 request per second, BurstLimit of 5 requests per second.
All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
The total number of occurrences of sensitive data that were detected.
" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The type of sensitive data that was detected. For example, the type might indicate that the data is an email address.
" + } + }, + "Occurrences": { + "target": "com.amazonaws.securityhub#Occurrences", + "traits": { + "smithy.api#documentation": "Details about the sensitive data that was detected.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The list of detected instances of sensitive data.
" + } + }, + "com.amazonaws.securityhub#SensitiveDataDetectionsList": { "type": "list", "member": { "target": "com.amazonaws.securityhub#SensitiveDataDetections" @@ -22243,6 +24438,7 @@ "TotalCount": { "target": "com.amazonaws.securityhub#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The total number of occurrences of sensitive data.
" } } @@ -22263,6 +24459,7 @@ "Product": { "target": "com.amazonaws.securityhub#Double", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Deprecated. This attribute is being deprecated. Instead of providing\n Product, provide Original.
The native severity as defined by the Amazon Web Services service or integrated partner product that\n generated the finding.
" } }, @@ -22275,6 +24472,7 @@ "Normalized": { "target": "com.amazonaws.securityhub#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Deprecated. The normalized severity of a finding. This attribute is being deprecated.\n Instead of providing Normalized, provide Label.
If you provide Label and do not provide Normalized, then\n Normalized is set automatically as follows.
\n INFORMATIONAL - 0
\n LOW - 1
\n MEDIUM - 40
\n HIGH - 70
\n CRITICAL - 90
The normalized severity for the finding. This attribute is to be deprecated in favor of\n Label.
If you provide Normalized and do not provide Label,\n Label is set automatically as follows.
0 - INFORMATIONAL\n
1–39 - LOW\n
40–69 - MEDIUM\n
70–89 - HIGH\n
90–100 - CRITICAL\n
The native severity as defined by the Amazon Web Services service or integrated partner product that\n generated the finding.
" } }, @@ -22366,7 +24580,10 @@ } }, "com.amazonaws.securityhub#SizeBytes": { - "type": "long" + "type": "long", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.securityhub#SoftwarePackage": { "type": "structure", @@ -22463,18 +24680,20 @@ } }, "com.amazonaws.securityhub#SortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "asc", - "name": "ASCENDING" - }, - { - "value": "desc", - "name": "DESCENDING" + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "asc" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "desc" } - ] + } } }, "com.amazonaws.securityhub#Standard": { @@ -22501,6 +24720,7 @@ "EnabledByDefault": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Whether the standard is enabled by default. When Security Hub is enabled from the console, if a\n standard is enabled by default, the check box for that standard is selected by\n default.
\nWhen Security Hub is enabled using the EnableSecurityHub API operation, the\n standard is enabled by default unless EnableDefaultStandards is set to\n false.
This total number of items in which the threat has been detected.\n\t\t
" } }, @@ -23053,34 +25290,44 @@ } }, "com.amazonaws.securityhub#ThreatIntelIndicatorCategory": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BACKDOOR", - "name": "BACKDOOR" - }, - { - "value": "CARD_STEALER", - "name": "CARD_STEALER" - }, - { - "value": "COMMAND_AND_CONTROL", - "name": "COMMAND_AND_CONTROL" - }, - { - "value": "DROP_SITE", - "name": "DROP_SITE" - }, - { - "value": "EXPLOIT_SITE", - "name": "EXPLOIT_SITE" - }, - { - "value": "KEYLOGGER", - "name": "KEYLOGGER" + "type": "enum", + "members": { + "BACKDOOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BACKDOOR" + } + }, + "CARD_STEALER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CARD_STEALER" + } + }, + "COMMAND_AND_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMAND_AND_CONTROL" + } + }, + "DROP_SITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DROP_SITE" + } + }, + "EXPLOIT_SITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPLOIT_SITE" + } + }, + "KEYLOGGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEYLOGGER" } - ] + } } }, "com.amazonaws.securityhub#ThreatIntelIndicatorList": { @@ -23090,54 +25337,74 @@ } }, "com.amazonaws.securityhub#ThreatIntelIndicatorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DOMAIN", - "name": "DOMAIN" - }, - { - "value": "EMAIL_ADDRESS", - "name": "EMAIL_ADDRESS" - }, - { - "value": "HASH_MD5", - "name": "HASH_MD5" - }, - { - "value": "HASH_SHA1", - "name": "HASH_SHA1" - }, - { - "value": "HASH_SHA256", - "name": "HASH_SHA256" - }, - { - "value": "HASH_SHA512", - "name": "HASH_SHA512" - }, - { - "value": "IPV4_ADDRESS", - "name": "IPV4_ADDRESS" - }, - { - "value": "IPV6_ADDRESS", - "name": "IPV6_ADDRESS" - }, - { - "value": "MUTEX", - "name": "MUTEX" - }, - { - "value": "PROCESS", - "name": "PROCESS" - }, - { - "value": "URL", - "name": "URL" + "type": "enum", + "members": { + "DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN" + } + }, + "EMAIL_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL_ADDRESS" + } + }, + "HASH_MD5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HASH_MD5" + } + }, + "HASH_SHA1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HASH_SHA1" + } + }, + "HASH_SHA256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HASH_SHA256" + } + }, + "HASH_SHA512": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HASH_SHA512" + } + }, + "IPV4_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4_ADDRESS" + } + }, + "IPV6_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV6_ADDRESS" + } + }, + "MUTEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MUTEX" + } + }, + "PROCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESS" + } + }, + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL" } - ] + } } }, "com.amazonaws.securityhub#ThreatList": { @@ -23328,7 +25595,7 @@ "Regions": { "target": "com.amazonaws.securityhub#StringList", "traits": { - "smithy.api#documentation": "If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.
Whether to automatically enable Security Hub for new accounts in the organization.
\nBy default, this is false, and new accounts are not added\n automatically.
To automatically enable Security Hub for new accounts, set this to true.
Whether to automatically enable new controls when they are added to standards that are\n enabled.
\nBy default, this is set to true, and new controls are enabled\n automatically. To not automatically enable new controls, set this to false.\n
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.\n
" } }, "AllowEgressFromLocalClassicLinkToRemoteVpc": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.\n
" } }, "AllowEgressFromLocalVpcToRemoteClassicLink": { "target": "com.amazonaws.securityhub#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.\n
" } } @@ -23822,22 +26100,26 @@ } }, "com.amazonaws.securityhub#VulnerabilityFixAvailable": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "YES", - "name": "YES" - }, - { - "value": "NO", - "name": "NO" - }, - { - "value": "PARTIAL", - "name": "PARTIAL" + "type": "enum", + "members": { + "YES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YES" } - ] + }, + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO" + } + }, + "PARTIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL" + } + } } }, "com.amazonaws.securityhub#VulnerabilityList": { @@ -23948,56 +26230,72 @@ } }, "com.amazonaws.securityhub#WorkflowState": { - "type": "string", + "type": "enum", + "members": { + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "ASSIGNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSIGNED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "DEFERRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFERRED" + } + }, + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOLVED" + } + } + }, "traits": { "smithy.api#deprecated": { "message": "This filter is deprecated. Instead, use SeverityLabel or FindingProviderFieldsSeverityLabel." - }, - "smithy.api#enum": [ - { - "value": "NEW", - "name": "NEW" - }, - { - "value": "ASSIGNED", - "name": "ASSIGNED" - }, - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "DEFERRED", - "name": "DEFERRED" - }, - { - "value": "RESOLVED", - "name": "RESOLVED" - } - ] + } } }, "com.amazonaws.securityhub#WorkflowStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NEW", - "name": "NEW" - }, - { - "value": "NOTIFIED", - "name": "NOTIFIED" - }, - { - "value": "RESOLVED", - "name": "RESOLVED" - }, - { - "value": "SUPPRESSED", - "name": "SUPPRESSED" + "type": "enum", + "members": { + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "NOTIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOTIFIED" } - ] + }, + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOLVED" + } + }, + "SUPPRESSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPPRESSED" + } + } } }, "com.amazonaws.securityhub#WorkflowUpdate": { diff --git a/codegen/sdk-codegen/aws-models/ssm-incidents.json b/codegen/sdk-codegen/aws-models/ssm-incidents.json index 21c8c4ffa2d..09a06783a9a 100644 --- a/codegen/sdk-codegen/aws-models/ssm-incidents.json +++ b/codegen/sdk-codegen/aws-models/ssm-incidents.json @@ -511,6 +511,12 @@ "smithy.api#documentation": "A short description of the event.
", "smithy.api#required": {} } + }, + "eventReferences": { + "target": "com.amazonaws.ssmincidents#EventReferenceList", + "traits": { + "smithy.api#documentation": "Adds one or more references to the TimelineEvent. A reference can be an Amazon Web Services resource involved in the incident or in some way associated with it. When you specify a reference, you enter the Amazon Resource Name (ARN) of the resource. You can also specify a related item. As an example, you could specify the ARN of an Amazon DynamoDB (DynamoDB) table. The table for this example is the resource. You could also specify a Amazon CloudWatch metric for that table. The metric is the related item.
The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a\n TimelineEvent.
The ID of a RelatedItem referenced in a TimelineEvent.
An item referenced in a TimelineEvent that is involved in or somehow\n associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services\n resource or a RelatedItem ID.
The type of event. The timeline event must be Custom Event.
A list of references in a TimelineEvent.
Tags to assign to the template. When the StartIncident API action is\n called, Incident Manager assigns the tags specified in the template to the\n incident.
Tags to assign to the template. When the StartIncident API action is\n called, Incident Manager assigns the tags specified in the template to the incident.
A unique ID for a RelatedItem.
Don't specify this parameter when you add a RelatedItem by using the\n UpdateRelatedItems API action.
A short description of the event.
", "smithy.api#required": {} } + }, + "eventReferences": { + "target": "com.amazonaws.ssmincidents#EventReferenceList", + "traits": { + "smithy.api#documentation": "A list of references in a TimelineEvent.
A short description of the event.
" } + }, + "eventReferences": { + "target": "com.amazonaws.ssmincidents#EventReferenceList", + "traits": { + "smithy.api#documentation": "Updates all existing references in a TimelineEvent. A reference can be an Amazon Web Services resource involved in the incident or in some way associated with it. When you specify a reference, you enter the Amazon Resource Name (ARN) of the resource. You can also specify a related item. As an example, you could specify the ARN of an Amazon DynamoDB (DynamoDB) table. The table for this example is the resource. You could also specify a Amazon CloudWatch metric for that table. The metric is the related item.
This update action overrides all existing references. If you want to keep existing\n references, you must specify them in the call. If you don't, this action removes\n them and enters only new references.
\n