{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.sagemakerruntime#AmazonSageMakerRuntime": { "type": "service", "version": "2017-05-13", "operations": [ { "target": "com.amazonaws.sagemakerruntime#InvokeEndpoint" }, { "target": "com.amazonaws.sagemakerruntime#InvokeEndpointAsync" }, { "target": "com.amazonaws.sagemakerruntime#InvokeEndpointWithResponseStream" } ], "traits": { "aws.api#service": { "sdkId": "SageMaker Runtime", "arnNamespace": "sagemaker", "cloudFormationName": "SageMakerRuntime", "cloudTrailEventSource": "sagemakerruntime.amazonaws.com", "docId": "runtime.sagemaker-2017-05-13", "endpointPrefix": "runtime.sagemaker" }, "aws.auth#sigv4": { "name": "sagemaker" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "
The Amazon SageMaker AI runtime API.
", "smithy.api#title": "Amazon SageMaker Runtime", "smithy.rules#endpointBdd": { "version": "1.1", "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" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://runtime.sagemaker-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": [], "endpoint": { "url": "https://runtime-fips.sagemaker.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://runtime.sagemaker.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://runtime.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://runtime.sagemaker.{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://runtime.sagemaker.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 15, "nodes": "/////wAAAAH/////AAAAAAAAAA4AAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEMAAAABQX14QoF9eELAAAABAAAAAwAAAAJAAAABgAAAAoF9eEJAAAABwX14QYAAAALAAAACAX14QcF9eEIAAAABQAAAA0F9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAPAAAABAX14QIF9eED" }, "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": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "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" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://runtime.sagemaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] } ], "endpoint": { "url": "https://runtime-fips.sagemaker.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://runtime.sagemaker.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://runtime.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://runtime.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://runtime.sagemaker.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime-fips.sagemaker.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime-fips.sagemaker.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime-fips.sagemaker.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime-fips.sagemaker.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://runtime.sagemaker.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "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": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.sagemakerruntime#AsyncBodyBlob": { "type": "blob", "traits": { "smithy.api#length": { "min": 0, "max": 128000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.sagemakerruntime#BodyBlob": { "type": "blob", "traits": { "smithy.api#length": { "min": 0, "max": 6291456 }, "smithy.api#sensitive": {} } }, "com.amazonaws.sagemakerruntime#CustomAttributesHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^\\p{ASCII}*$", "smithy.api#sensitive": {} } }, "com.amazonaws.sagemakerruntime#EnableExplanationsHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.sagemakerruntime#EndpointName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, "com.amazonaws.sagemakerruntime#ErrorCode": { "type": "string" }, "com.amazonaws.sagemakerruntime#FilenameHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^(?!.*\\..*\\.)[a-zA-Z0-9][a-zA-Z0-9-_\\.]*$" } }, "com.amazonaws.sagemakerruntime#Header": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^\\p{ASCII}*$" } }, "com.amazonaws.sagemakerruntime#InferenceComponentHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" } }, "com.amazonaws.sagemakerruntime#InferenceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^\\A\\S[\\p{Print}]*\\z$" } }, "com.amazonaws.sagemakerruntime#InputLocationHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" } }, "com.amazonaws.sagemakerruntime#InternalDependencyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerruntime#Message" } }, "traits": { "smithy.api#documentation": "Your request caused an exception with an internal dependency. Contact customer\n support.
", "smithy.api#error": "server", "smithy.api#httpError": 530 } }, "com.amazonaws.sagemakerruntime#InternalFailure": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerruntime#Message" } }, "traits": { "smithy.api#documentation": "An internal failure occurred.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.sagemakerruntime#InternalStreamFailure": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerruntime#Message" } }, "traits": { "smithy.api#documentation": "The stream processing failed because of an unknown error, exception or failure. Try your request again.
", "smithy.api#error": "server" } }, "com.amazonaws.sagemakerruntime#InvocationTimeoutSecondsHeader": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 3600 } } }, "com.amazonaws.sagemakerruntime#InvokeEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.sagemakerruntime#InvokeEndpointInput" }, "output": { "target": "com.amazonaws.sagemakerruntime#InvokeEndpointOutput" }, "errors": [ { "target": "com.amazonaws.sagemakerruntime#InternalDependencyException" }, { "target": "com.amazonaws.sagemakerruntime#InternalFailure" }, { "target": "com.amazonaws.sagemakerruntime#ModelError" }, { "target": "com.amazonaws.sagemakerruntime#ModelNotReadyException" }, { "target": "com.amazonaws.sagemakerruntime#ServiceUnavailable" }, { "target": "com.amazonaws.sagemakerruntime#ValidationError" } ], "traits": { "smithy.api#documentation": "After you deploy a model into production using Amazon SageMaker AI hosting services,\n your client applications use this API to get inferences from the model hosted at the\n specified endpoint.
\nFor an overview of Amazon SageMaker AI, see How It Works.
\nAmazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.
\nCalls to InvokeEndpoint are authenticated by using Amazon Web Services\n Signature Version 4. For information, see Authenticating\n Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.
A customer's model containers must respond to requests within 60 seconds. The model\n itself can have a maximum processing time of 60 seconds before responding to\n invocations. If your model is going to take 50-60 seconds of processing time, the SDK\n socket timeout should be set to be 70 seconds.
\nEndpoints are scoped to an individual account, and are not public. The URL does\n not contain the account ID, but Amazon SageMaker AI determines the account ID from\n the authentication token that is supplied by the caller.
\nAfter you deploy a model into production using Amazon SageMaker AI hosting services,\n your client applications use this API to get inferences from the model hosted at the\n specified endpoint in an asynchronous manner.
\nInference requests sent to this API are enqueued for asynchronous processing. The\n processing of the inference request may or may not complete before you receive a\n response from this API. The response from this API will not contain the result of the\n inference request but contain information about where you can locate it.
\nAmazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.
\nCalls to InvokeEndpointAsync are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating\n Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.
The name of the endpoint that you specified when you created the endpoint using the\n CreateEndpoint API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ContentType": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { "smithy.api#documentation": "The MIME type of the input data in the request body.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Content-Type" } }, "Accept": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { "smithy.api#documentation": "The desired MIME type of the inference response from the model container.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Accept" } }, "CustomAttributes": { "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", "traits": { "smithy.api#documentation": "Provides additional information about a request for an inference submitted to a model\n hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is forwarded\n verbatim. You could use this value, for example, to provide an ID that you can use to\n track a request or to provide other metadata that a service endpoint was programmed to\n process. The value must consist of no more than 1024 visible US-ASCII characters as\n specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol\n (HTTP/1.1).
\nThe code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.
This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker AI\n Python SDK.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } }, "InferenceId": { "target": "com.amazonaws.sagemakerruntime#InferenceId", "traits": { "smithy.api#documentation": "The identifier for the inference request. Amazon SageMaker AI will generate an\n identifier for you if none is specified.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Inference-Id" } }, "InputLocation": { "target": "com.amazonaws.sagemakerruntime#InputLocationHeader", "traits": { "smithy.api#documentation": "The Amazon S3 URI where the inference request payload is stored.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-InputLocation" } }, "S3OutputPathExtension": { "target": "com.amazonaws.sagemakerruntime#S3OutputPathExtensionHeader", "traits": { "smithy.api#documentation": "The path extension that is appended to the Amazon S3 output path where the inference\n response payload is stored.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-S3OutputPathExtension" } }, "Filename": { "target": "com.amazonaws.sagemakerruntime#FilenameHeader", "traits": { "smithy.api#documentation": "The filename for the inference response payload stored in Amazon S3. If not\n specified, Amazon SageMaker AI generates a filename based on the inference ID.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Filename" } }, "RequestTTLSeconds": { "target": "com.amazonaws.sagemakerruntime#RequestTTLSecondsHeader", "traits": { "smithy.api#documentation": "Maximum age in seconds a request can be in the queue before it is marked as expired.\n The default is 6 hours, or 21,600 seconds.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-RequestTTLSeconds" } }, "InvocationTimeoutSeconds": { "target": "com.amazonaws.sagemakerruntime#InvocationTimeoutSecondsHeader", "traits": { "smithy.api#documentation": "Maximum amount of time in seconds a request can be processed before it is marked as\n expired. The default is 15 minutes, or 900 seconds.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-InvocationTimeoutSeconds" } }, "Body": { "target": "com.amazonaws.sagemakerruntime#AsyncBodyBlob", "traits": { "smithy.api#documentation": "Provides inline input data for the inference request, in the format specified in the\n ContentType request header. Use this parameter to send the request\n payload directly in the API call instead of uploading it to Amazon S3 and\n referencing it with InputLocation. The inline payload can be up to 128,000\n bytes.
\n Body and InputLocation are mutually exclusive. Provide\n exactly one of them.
For information about the format of the request body, see Common Data\n Formats-Inference.
", "smithy.api#httpPayload": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakerruntime#InvokeEndpointAsyncOutput": { "type": "structure", "members": { "InferenceId": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { "smithy.api#documentation": "Identifier for an inference request. This will be the same as the\n InferenceId specified in the input. Amazon SageMaker AI will generate\n an identifier for you if you do not specify one.
The Amazon S3 URI where the inference response payload is stored.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-OutputLocation" } }, "FailureLocation": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { "smithy.api#documentation": "The Amazon S3 URI where the inference failure response payload is\n stored.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-FailureLocation" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sagemakerruntime#InvokeEndpointInput": { "type": "structure", "members": { "EndpointName": { "target": "com.amazonaws.sagemakerruntime#EndpointName", "traits": { "smithy.api#documentation": "The name of the endpoint that you specified when you created the endpoint using the\n CreateEndpoint API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Body": { "target": "com.amazonaws.sagemakerruntime#BodyBlob", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Provides input data, in the format specified in the ContentType\n request header. Amazon SageMaker AI passes all of the data in the body to the model.
For information about the format of the request body, see Common Data\n Formats-Inference.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "ContentType": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { "smithy.api#documentation": "The MIME type of the input data in the request body.
", "smithy.api#httpHeader": "Content-Type" } }, "Accept": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { "smithy.api#documentation": "The desired MIME type of the inference response from the model container.
", "smithy.api#httpHeader": "Accept" } }, "CustomAttributes": { "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", "traits": { "smithy.api#documentation": "Provides additional information about a request for an inference submitted to a model\n hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is forwarded\n verbatim. You could use this value, for example, to provide an ID that you can use to\n track a request or to provide other metadata that a service endpoint was programmed to\n process. The value must consist of no more than 1024 visible US-ASCII characters as\n specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol\n (HTTP/1.1).
\nThe code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.
This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker AI\n Python SDK.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } }, "TargetModel": { "target": "com.amazonaws.sagemakerruntime#TargetModelHeader", "traits": { "smithy.api#documentation": "The model to request for inference when invoking a multi-model endpoint.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Target-Model" } }, "TargetVariant": { "target": "com.amazonaws.sagemakerruntime#TargetVariantHeader", "traits": { "smithy.api#documentation": "Specify the production variant to send the inference request to when invoking an\n endpoint that is running two or more variants. Note that this parameter overrides the\n default behavior for the endpoint, which is to distribute the invocation traffic based\n on the variant weights.
\nFor information about how to use variant targeting to perform a/b testing, see Test models in\n production\n
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Target-Variant" } }, "TargetContainerHostname": { "target": "com.amazonaws.sagemakerruntime#TargetContainerHostnameHeader", "traits": { "smithy.api#documentation": "If the endpoint hosts multiple containers and is configured to use direct invocation,\n this parameter specifies the host name of the container to invoke.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Target-Container-Hostname" } }, "InferenceId": { "target": "com.amazonaws.sagemakerruntime#InferenceId", "traits": { "smithy.api#documentation": "If you provide a value, it is added to the captured data when you enable data capture\n on the endpoint. For information about data capture, see Capture\n Data.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Inference-Id" } }, "EnableExplanations": { "target": "com.amazonaws.sagemakerruntime#EnableExplanationsHeader", "traits": { "smithy.api#documentation": "An optional JMESPath expression used to override the EnableExplanations\n parameter of the ClarifyExplainerConfig API. See the EnableExplanations section in the developer guide for more information.\n
If the endpoint hosts one or more inference components, this parameter specifies the\n name of inference component to invoke.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Inference-Component" } }, "SessionId": { "target": "com.amazonaws.sagemakerruntime#SessionIdOrNewSessionConstantHeader", "traits": { "smithy.api#documentation": "Creates a stateful session or identifies an existing one. You can do one of the\n following:
\nCreate a stateful session by specifying the value\n NEW_SESSION.
Send your request to an existing stateful session by specifying the ID of that\n session.
\nWith a stateful session, you can send multiple requests to a stateful model. When you\n create a session with a stateful model, the model must create the session ID and set the\n expiration time. The model must also provide that information in the response to your\n request. You can get the ID and timestamp from the NewSessionId response\n parameter. For any subsequent request where you specify that session ID, SageMaker AI routes the request to the same instance that supports the session.
An optional, stable identifier that serves as a routing hint for prefix-aware routing.\n The service routes requests with the same prefix and the same identifier to the same\n instance. If requests from different applications might have the same prompt prefix, set\n a different identifier for each application to differentiate their routing\n decisions.
\nApplies only to endpoints configured with a\n RoutingStrategy of PREFIX_AWARE.
Includes the inference provided by the model.
\nFor information about the format of the response body, see Common Data\n Formats-Inference.
\nIf the explainer is activated, the body includes the explanations provided by the\n model. For more information, see the Response section\n under Invoke the Endpoint in the Developer Guide.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "ContentType": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { "smithy.api#documentation": "The MIME type of the inference returned from the model container.
", "smithy.api#httpHeader": "Content-Type" } }, "InvokedProductionVariant": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { "smithy.api#documentation": "Identifies the production variant that was invoked.
", "smithy.api#httpHeader": "x-Amzn-Invoked-Production-Variant" } }, "CustomAttributes": { "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", "traits": { "smithy.api#documentation": "Provides additional information in the response about the inference returned by a\n model hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is\n forwarded verbatim. You could use this value, for example, to return an ID received in\n the CustomAttributes header of a request or other metadata that a service\n endpoint was programmed to produce. The value must consist of no more than 1024 visible\n US-ASCII characters as specified in Section 3.3.6. Field Value\n Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer\n wants the custom attribute returned, the model must set the custom attribute to be\n included on the way back.
The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.
This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker AI\n Python SDK.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } }, "NewSessionId": { "target": "com.amazonaws.sagemakerruntime#NewSessionResponseHeader", "traits": { "smithy.api#documentation": "If you created a stateful session with your request, the ID and expiration time that\n the model assigns to that session.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-New-Session-Id" } }, "ClosedSessionId": { "target": "com.amazonaws.sagemakerruntime#SessionIdHeader", "traits": { "smithy.api#documentation": "If you closed a stateful session with your request, the ID of that session.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Closed-Session-Id" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sagemakerruntime#InvokeEndpointWithResponseStream": { "type": "operation", "input": { "target": "com.amazonaws.sagemakerruntime#InvokeEndpointWithResponseStreamInput" }, "output": { "target": "com.amazonaws.sagemakerruntime#InvokeEndpointWithResponseStreamOutput" }, "errors": [ { "target": "com.amazonaws.sagemakerruntime#InternalFailure" }, { "target": "com.amazonaws.sagemakerruntime#InternalStreamFailure" }, { "target": "com.amazonaws.sagemakerruntime#ModelError" }, { "target": "com.amazonaws.sagemakerruntime#ModelStreamError" }, { "target": "com.amazonaws.sagemakerruntime#ServiceUnavailable" }, { "target": "com.amazonaws.sagemakerruntime#ValidationError" } ], "traits": { "smithy.api#documentation": "Invokes a model at the specified endpoint to return the inference response as a\n stream. The inference stream provides the response payload incrementally as a series of\n parts. Before you can get an inference stream, you must have access to a model that's\n deployed using Amazon SageMaker AI hosting services, and the container for that model\n must support inference streaming.
\nFor more information that can help you use this API, see the following sections in the\n Amazon SageMaker AI Developer Guide:
\nFor information about how to add streaming support to a model, see How Containers Serve Requests.
\nFor information about how to process the streaming response, see Invoke real-time endpoints.
\nBefore you can use this operation, your IAM permissions must allow the\n sagemaker:InvokeEndpoint action. For more information about Amazon SageMaker AI actions for IAM policies, see Actions, resources, and condition keys for Amazon SageMaker AI in the IAM Service Authorization\n Reference.
Amazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.
\nCalls to InvokeEndpointWithResponseStream are authenticated by using\n Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the\n Amazon S3 API Reference.
The name of the endpoint that you specified when you created the endpoint using the\n CreateEndpoint API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Body": { "target": "com.amazonaws.sagemakerruntime#BodyBlob", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Provides input data, in the format specified in the ContentType\n request header. Amazon SageMaker AI passes all of the data in the body to the model.
For information about the format of the request body, see Common Data\n Formats-Inference.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "ContentType": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { "smithy.api#documentation": "The MIME type of the input data in the request body.
", "smithy.api#httpHeader": "Content-Type" } }, "Accept": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { "smithy.api#documentation": "The desired MIME type of the inference response from the model container.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Accept" } }, "CustomAttributes": { "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", "traits": { "smithy.api#documentation": "Provides additional information about a request for an inference submitted to a model\n hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is forwarded\n verbatim. You could use this value, for example, to provide an ID that you can use to\n track a request or to provide other metadata that a service endpoint was programmed to\n process. The value must consist of no more than 1024 visible US-ASCII characters as\n specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol\n (HTTP/1.1).
\nThe code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.
This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker AI\n Python SDK.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } }, "TargetVariant": { "target": "com.amazonaws.sagemakerruntime#TargetVariantHeader", "traits": { "smithy.api#documentation": "Specify the production variant to send the inference request to when invoking an\n endpoint that is running two or more variants. Note that this parameter overrides the\n default behavior for the endpoint, which is to distribute the invocation traffic based\n on the variant weights.
\nFor information about how to use variant targeting to perform a/b testing, see Test models in\n production\n
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Target-Variant" } }, "TargetContainerHostname": { "target": "com.amazonaws.sagemakerruntime#TargetContainerHostnameHeader", "traits": { "smithy.api#documentation": "If the endpoint hosts multiple containers and is configured to use direct invocation,\n this parameter specifies the host name of the container to invoke.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Target-Container-Hostname" } }, "InferenceId": { "target": "com.amazonaws.sagemakerruntime#InferenceId", "traits": { "smithy.api#documentation": "An identifier that you assign to your request.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Inference-Id" } }, "InferenceComponentName": { "target": "com.amazonaws.sagemakerruntime#InferenceComponentHeader", "traits": { "smithy.api#documentation": "If the endpoint hosts one or more inference components, this parameter specifies the\n name of inference component to invoke for a streaming response.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Inference-Component" } }, "SessionId": { "target": "com.amazonaws.sagemakerruntime#SessionIdHeader", "traits": { "smithy.api#documentation": "The ID of a stateful session to handle your request.
\nYou can't create a stateful session by using the\n InvokeEndpointWithResponseStream action. Instead, you can create one by\n using the \n InvokeEndpoint\n action. In your request, you\n specify NEW_SESSION for the SessionId request parameter. The\n response to that request provides the session ID for the NewSessionId\n response parameter.
An optional, stable identifier that serves as a routing hint for prefix-aware routing.\n The service routes requests with the same prefix and the same identifier to the same\n instance. If requests from different applications might have the same prompt prefix, set\n a different identifier for each application to differentiate their routing\n decisions.
\nApplies only to endpoints configured with a\n RoutingStrategy of PREFIX_AWARE.
The MIME type of the inference returned from the model container.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Content-Type" } }, "InvokedProductionVariant": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { "smithy.api#documentation": "Identifies the production variant that was invoked.
", "smithy.api#httpHeader": "x-Amzn-Invoked-Production-Variant" } }, "CustomAttributes": { "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", "traits": { "smithy.api#documentation": "Provides additional information in the response about the inference returned by a\n model hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is\n forwarded verbatim. You could use this value, for example, to return an ID received in\n the CustomAttributes header of a request or other metadata that a service\n endpoint was programmed to produce. The value must consist of no more than 1024 visible\n US-ASCII characters as specified in Section 3.3.6. Field Value\n Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer\n wants the custom attribute returned, the model must set the custom attribute to be\n included on the way back.
The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.
This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker AI\n Python SDK.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sagemakerruntime#LogStreamArn": { "type": "string" }, "com.amazonaws.sagemakerruntime#Message": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.sagemakerruntime#ModelError": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerruntime#Message" }, "OriginalStatusCode": { "target": "com.amazonaws.sagemakerruntime#StatusCode", "traits": { "smithy.api#documentation": "Original status code.
" } }, "OriginalMessage": { "target": "com.amazonaws.sagemakerruntime#Message", "traits": { "smithy.api#documentation": "Original message.
" } }, "LogStreamArn": { "target": "com.amazonaws.sagemakerruntime#LogStreamArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the log stream.
" } } }, "traits": { "smithy.api#documentation": "Model (owned by the customer in the container) returned 4xx or 5xx error code.\n
", "smithy.api#error": "client", "smithy.api#httpError": 424 } }, "com.amazonaws.sagemakerruntime#ModelNotReadyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerruntime#Message" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ModelNotReadyException", "httpResponseCode": 429 }, "smithy.api#documentation": "Either a serverless endpoint variant's resources are still being provisioned, or a\n multi-model endpoint is still downloading or loading the target model. Wait and try your\n request again.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.sagemakerruntime#ModelStreamError": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerruntime#Message" }, "ErrorCode": { "target": "com.amazonaws.sagemakerruntime#ErrorCode", "traits": { "smithy.api#documentation": "This error can have the following error codes:
\nThe model failed to finish sending the response within the timeout period\n allowed by Amazon SageMaker AI.
\nThe Transmission Control Protocol (TCP) connection between the client and\n the model was reset or closed.
\nAn error occurred while streaming the response body. This error can have the\n following error codes:
\nThe model failed to finish sending the response within the timeout period allowed by Amazon SageMaker AI.
\nThe Transmission Control Protocol (TCP) connection between the client and\n the model was reset or closed.
\nA blob that contains part of the response for your streaming inference request.
", "smithy.api#eventPayload": {} } } }, "traits": { "smithy.api#documentation": "A wrapper for pieces of the payload that's returned in response to a streaming\n inference request. A streaming inference response consists of one or more payload parts.\n
" } }, "com.amazonaws.sagemakerruntime#PrefixAwareIdHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^\\A\\S[\\p{Print}]*\\z$" } }, "com.amazonaws.sagemakerruntime#RequestTTLSecondsHeader": { "type": "integer", "traits": { "smithy.api#range": { "min": 60, "max": 21600 } } }, "com.amazonaws.sagemakerruntime#ResponseStream": { "type": "union", "members": { "PayloadPart": { "target": "com.amazonaws.sagemakerruntime#PayloadPart", "traits": { "smithy.api#documentation": "A wrapper for pieces of the payload that's returned in response to a streaming\n inference request. A streaming inference response consists of one or more payload parts.\n
" } }, "ModelStreamError": { "target": "com.amazonaws.sagemakerruntime#ModelStreamError", "traits": { "smithy.api#documentation": "An error occurred while streaming the response body. This error can have the\n following error codes:
\nThe model failed to finish sending the response within the timeout period allowed by Amazon SageMaker AI.
\nThe Transmission Control Protocol (TCP) connection between the client and\n the model was reset or closed.
\nThe stream processing failed because of an unknown error, exception or failure. Try your request again.
" } } }, "traits": { "smithy.api#documentation": "A stream of payload parts. Each part contains a portion of the response for a\n streaming inference request.
", "smithy.api#streaming": {} } }, "com.amazonaws.sagemakerruntime#S3OutputPathExtensionHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^(?!s3:|https:)[a-zA-Z0-9!_.*'()/-]+$" } }, "com.amazonaws.sagemakerruntime#ServiceUnavailable": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerruntime#Message" } }, "traits": { "smithy.api#documentation": "The service is unavailable. Try your call again.
", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.sagemakerruntime#SessionIdHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, "com.amazonaws.sagemakerruntime#SessionIdOrNewSessionConstantHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^(NEW_SESSION)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, "com.amazonaws.sagemakerruntime#StatusCode": { "type": "integer" }, "com.amazonaws.sagemakerruntime#TargetContainerHostnameHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, "com.amazonaws.sagemakerruntime#TargetModelHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^\\A\\S[\\p{Print}]*\\z$" } }, "com.amazonaws.sagemakerruntime#TargetVariantHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, "com.amazonaws.sagemakerruntime#ValidationError": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.sagemakerruntime#Message" } }, "traits": { "smithy.api#documentation": "Inspect your request and try again.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } } } }