A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.
Access log settings, including the access log format and access log destination ARN.
" + } + }, + "com.amazonaws.apigateway#Account": { + "type": "structure", + "members": { + "cloudwatchRoleArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ARN of an Amazon CloudWatch role for the current Account.
" + } + }, + "throttleSettings": { + "target": "com.amazonaws.apigateway#ThrottleSettings", + "traits": { + "smithy.api#documentation": "Specifies the API request limits configured for the current Account.
" + } + }, + "features": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A list of features supported for the account. When usage plans are enabled, the features list will include an entry of \"UsagePlans\".
The version of the API keys used for the account.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an AWS account that is associated with API Gateway.
" + } + }, + "com.amazonaws.apigateway#ApiKey": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the API Key.
" + } + }, + "value": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The value of the API Key.
" + } + }, + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the API Key.
" + } + }, + "customerId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the API Key.
" + } + }, + "enabled": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the API Key can be used by callers.
" + } + }, + "createdDate": { + "target": "com.amazonaws.apigateway#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the API Key was created.
" + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.apigateway#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the API Key was last updated.
" + } + }, + "stageKeys": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A list of Stage resources that are associated with the ApiKey resource.
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The collection of tags. Each tag element is associated with a given resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
" + } + }, + "com.amazonaws.apigateway#ApiKeyIds": { + "type": "structure", + "members": { + "ids": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A list of all the ApiKey identifiers.
" + } + }, + "warnings": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A list of warning messages.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The identifier of an ApiKey used in a UsagePlan.
" + } + }, + "com.amazonaws.apigateway#ApiKeySourceType": { + "type": "enum", + "members": { + "HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEADER" + } + }, + "AUTHORIZER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZER" + } + } + } + }, + "com.amazonaws.apigateway#ApiKeys": { + "type": "structure", + "members": { + "warnings": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.
The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a collection of API keys as represented by an ApiKeys resource.
" + } + }, + "com.amazonaws.apigateway#ApiKeysFormat": { + "type": "enum", + "members": { + "csv": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "csv" + } + } + } + }, + "com.amazonaws.apigateway#ApiStage": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "API Id of the associated API stage in a usage plan.
" + } + }, + "stage": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "API stage name of the associated API stage in a usage plan.
" + } + }, + "throttle": { + "target": "com.amazonaws.apigateway#MapOfApiStageThrottleSettings", + "traits": { + "smithy.api#documentation": "Map containing method level throttling information for API stage in a usage plan.
" + } + } + }, + "traits": { + "smithy.api#documentation": "API stage name of the associated API stage in a usage plan.
" + } + }, + "com.amazonaws.apigateway#ApiStatus": { + "type": "enum", + "members": { + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.apigateway#Authorizer": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier for the authorizer resource.
" + } + }, + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the authorizer.
" + } + }, + "type": { + "target": "com.amazonaws.apigateway#AuthorizerType", + "traits": { + "smithy.api#documentation": "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
" + } + }, + "authorizerUri": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
" + } + }, + "identitySource": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identity source for which authorization is requested. For a TOKEN or\n COGNITO_USER_POOLS authorizer, this is required and specifies the request\n header mapping expression for the custom header holding the authorization token submitted by\n the client. For example, if the token header name is Auth, the header mapping expression is\n method.request.header.Auth. For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping expressions\n of the specified request parameters. For example, if an Auth header, a Name query string\n parameter are defined as identity sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to derive the authorization\n caching key and to perform runtime validation of the REQUEST authorizer by verifying all of\n the identity-related request parameters are present, not null and non-empty. Only when this is\n true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value is a string of\n comma-separated mapping expressions of the specified request parameters. When the\n authorization caching is not enabled, this property is optional.
A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
" + } + }, + "com.amazonaws.apigateway#AuthorizerType": { + "type": "enum", + "members": { + "TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN" + } + }, + "REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUEST" + } + }, + "COGNITO_USER_POOLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COGNITO_USER_POOLS" + } + } + }, + "traits": { + "smithy.api#documentation": "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a collection of Authorizer resources.
" + } + }, + "com.amazonaws.apigateway#BackplaneControlService": { + "type": "service", + "version": "2015-07-09", + "operations": [ + { + "target": "com.amazonaws.apigateway#CreateApiKey" + }, + { + "target": "com.amazonaws.apigateway#CreateAuthorizer" + }, + { + "target": "com.amazonaws.apigateway#CreateBasePathMapping" + }, + { + "target": "com.amazonaws.apigateway#CreateDeployment" + }, + { + "target": "com.amazonaws.apigateway#CreateDocumentationPart" + }, + { + "target": "com.amazonaws.apigateway#CreateDocumentationVersion" + }, + { + "target": "com.amazonaws.apigateway#CreateDomainName" + }, + { + "target": "com.amazonaws.apigateway#CreateDomainNameAccessAssociation" + }, + { + "target": "com.amazonaws.apigateway#CreateModel" + }, + { + "target": "com.amazonaws.apigateway#CreateRequestValidator" + }, + { + "target": "com.amazonaws.apigateway#CreateResource" + }, + { + "target": "com.amazonaws.apigateway#CreateRestApi" + }, + { + "target": "com.amazonaws.apigateway#CreateStage" + }, + { + "target": "com.amazonaws.apigateway#CreateUsagePlan" + }, + { + "target": "com.amazonaws.apigateway#CreateUsagePlanKey" + }, + { + "target": "com.amazonaws.apigateway#CreateVpcLink" + }, + { + "target": "com.amazonaws.apigateway#DeleteApiKey" + }, + { + "target": "com.amazonaws.apigateway#DeleteAuthorizer" + }, + { + "target": "com.amazonaws.apigateway#DeleteBasePathMapping" + }, + { + "target": "com.amazonaws.apigateway#DeleteClientCertificate" + }, + { + "target": "com.amazonaws.apigateway#DeleteDeployment" + }, + { + "target": "com.amazonaws.apigateway#DeleteDocumentationPart" + }, + { + "target": "com.amazonaws.apigateway#DeleteDocumentationVersion" + }, + { + "target": "com.amazonaws.apigateway#DeleteDomainName" + }, + { + "target": "com.amazonaws.apigateway#DeleteDomainNameAccessAssociation" + }, + { + "target": "com.amazonaws.apigateway#DeleteGatewayResponse" + }, + { + "target": "com.amazonaws.apigateway#DeleteIntegration" + }, + { + "target": "com.amazonaws.apigateway#DeleteIntegrationResponse" + }, + { + "target": "com.amazonaws.apigateway#DeleteMethod" + }, + { + "target": "com.amazonaws.apigateway#DeleteMethodResponse" + }, + { + "target": "com.amazonaws.apigateway#DeleteModel" + }, + { + "target": "com.amazonaws.apigateway#DeleteRequestValidator" + }, + { + "target": "com.amazonaws.apigateway#DeleteResource" + }, + { + "target": "com.amazonaws.apigateway#DeleteRestApi" + }, + { + "target": "com.amazonaws.apigateway#DeleteStage" + }, + { + "target": "com.amazonaws.apigateway#DeleteUsagePlan" + }, + { + "target": "com.amazonaws.apigateway#DeleteUsagePlanKey" + }, + { + "target": "com.amazonaws.apigateway#DeleteVpcLink" + }, + { + "target": "com.amazonaws.apigateway#FlushStageAuthorizersCache" + }, + { + "target": "com.amazonaws.apigateway#FlushStageCache" + }, + { + "target": "com.amazonaws.apigateway#GenerateClientCertificate" + }, + { + "target": "com.amazonaws.apigateway#GetAccount" + }, + { + "target": "com.amazonaws.apigateway#GetApiKey" + }, + { + "target": "com.amazonaws.apigateway#GetApiKeys" + }, + { + "target": "com.amazonaws.apigateway#GetAuthorizer" + }, + { + "target": "com.amazonaws.apigateway#GetAuthorizers" + }, + { + "target": "com.amazonaws.apigateway#GetBasePathMapping" + }, + { + "target": "com.amazonaws.apigateway#GetBasePathMappings" + }, + { + "target": "com.amazonaws.apigateway#GetClientCertificate" + }, + { + "target": "com.amazonaws.apigateway#GetClientCertificates" + }, + { + "target": "com.amazonaws.apigateway#GetDeployment" + }, + { + "target": "com.amazonaws.apigateway#GetDeployments" + }, + { + "target": "com.amazonaws.apigateway#GetDocumentationPart" + }, + { + "target": "com.amazonaws.apigateway#GetDocumentationParts" + }, + { + "target": "com.amazonaws.apigateway#GetDocumentationVersion" + }, + { + "target": "com.amazonaws.apigateway#GetDocumentationVersions" + }, + { + "target": "com.amazonaws.apigateway#GetDomainName" + }, + { + "target": "com.amazonaws.apigateway#GetDomainNameAccessAssociations" + }, + { + "target": "com.amazonaws.apigateway#GetDomainNames" + }, + { + "target": "com.amazonaws.apigateway#GetExport" + }, + { + "target": "com.amazonaws.apigateway#GetGatewayResponse" + }, + { + "target": "com.amazonaws.apigateway#GetGatewayResponses" + }, + { + "target": "com.amazonaws.apigateway#GetIntegration" + }, + { + "target": "com.amazonaws.apigateway#GetIntegrationResponse" + }, + { + "target": "com.amazonaws.apigateway#GetMethod" + }, + { + "target": "com.amazonaws.apigateway#GetMethodResponse" + }, + { + "target": "com.amazonaws.apigateway#GetModel" + }, + { + "target": "com.amazonaws.apigateway#GetModels" + }, + { + "target": "com.amazonaws.apigateway#GetModelTemplate" + }, + { + "target": "com.amazonaws.apigateway#GetRequestValidator" + }, + { + "target": "com.amazonaws.apigateway#GetRequestValidators" + }, + { + "target": "com.amazonaws.apigateway#GetResource" + }, + { + "target": "com.amazonaws.apigateway#GetResources" + }, + { + "target": "com.amazonaws.apigateway#GetRestApi" + }, + { + "target": "com.amazonaws.apigateway#GetRestApis" + }, + { + "target": "com.amazonaws.apigateway#GetSdk" + }, + { + "target": "com.amazonaws.apigateway#GetSdkType" + }, + { + "target": "com.amazonaws.apigateway#GetSdkTypes" + }, + { + "target": "com.amazonaws.apigateway#GetStage" + }, + { + "target": "com.amazonaws.apigateway#GetStages" + }, + { + "target": "com.amazonaws.apigateway#GetTags" + }, + { + "target": "com.amazonaws.apigateway#GetUsage" + }, + { + "target": "com.amazonaws.apigateway#GetUsagePlan" + }, + { + "target": "com.amazonaws.apigateway#GetUsagePlanKey" + }, + { + "target": "com.amazonaws.apigateway#GetUsagePlanKeys" + }, + { + "target": "com.amazonaws.apigateway#GetUsagePlans" + }, + { + "target": "com.amazonaws.apigateway#GetVpcLink" + }, + { + "target": "com.amazonaws.apigateway#GetVpcLinks" + }, + { + "target": "com.amazonaws.apigateway#ImportApiKeys" + }, + { + "target": "com.amazonaws.apigateway#ImportDocumentationParts" + }, + { + "target": "com.amazonaws.apigateway#ImportRestApi" + }, + { + "target": "com.amazonaws.apigateway#PutGatewayResponse" + }, + { + "target": "com.amazonaws.apigateway#PutIntegration" + }, + { + "target": "com.amazonaws.apigateway#PutIntegrationResponse" + }, + { + "target": "com.amazonaws.apigateway#PutMethod" + }, + { + "target": "com.amazonaws.apigateway#PutMethodResponse" + }, + { + "target": "com.amazonaws.apigateway#PutRestApi" + }, + { + "target": "com.amazonaws.apigateway#RejectDomainNameAccessAssociation" + }, + { + "target": "com.amazonaws.apigateway#TagResource" + }, + { + "target": "com.amazonaws.apigateway#TestInvokeAuthorizer" + }, + { + "target": "com.amazonaws.apigateway#TestInvokeMethod" + }, + { + "target": "com.amazonaws.apigateway#UntagResource" + }, + { + "target": "com.amazonaws.apigateway#UpdateAccount" + }, + { + "target": "com.amazonaws.apigateway#UpdateApiKey" + }, + { + "target": "com.amazonaws.apigateway#UpdateAuthorizer" + }, + { + "target": "com.amazonaws.apigateway#UpdateBasePathMapping" + }, + { + "target": "com.amazonaws.apigateway#UpdateClientCertificate" + }, + { + "target": "com.amazonaws.apigateway#UpdateDeployment" + }, + { + "target": "com.amazonaws.apigateway#UpdateDocumentationPart" + }, + { + "target": "com.amazonaws.apigateway#UpdateDocumentationVersion" + }, + { + "target": "com.amazonaws.apigateway#UpdateDomainName" + }, + { + "target": "com.amazonaws.apigateway#UpdateGatewayResponse" + }, + { + "target": "com.amazonaws.apigateway#UpdateIntegration" + }, + { + "target": "com.amazonaws.apigateway#UpdateIntegrationResponse" + }, + { + "target": "com.amazonaws.apigateway#UpdateMethod" + }, + { + "target": "com.amazonaws.apigateway#UpdateMethodResponse" + }, + { + "target": "com.amazonaws.apigateway#UpdateModel" + }, + { + "target": "com.amazonaws.apigateway#UpdateRequestValidator" + }, + { + "target": "com.amazonaws.apigateway#UpdateResource" + }, + { + "target": "com.amazonaws.apigateway#UpdateRestApi" + }, + { + "target": "com.amazonaws.apigateway#UpdateStage" + }, + { + "target": "com.amazonaws.apigateway#UpdateUsage" + }, + { + "target": "com.amazonaws.apigateway#UpdateUsagePlan" + }, + { + "target": "com.amazonaws.apigateway#UpdateVpcLink" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "API Gateway", + "arnNamespace": "apigateway", + "cloudFormationName": "ApiGateway", + "cloudTrailEventSource": "apigateway.amazonaws.com", + "docId": "apigateway-2015-07-09", + "endpointPrefix": "apigateway" + }, + "aws.auth#sigv4": { + "name": "apigateway" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
", + "smithy.api#title": "Amazon API Gateway", + "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 + ] + } + ], + "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://apigateway-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://apigateway-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://apigateway.{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://apigateway.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 13, + "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" + }, + "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://apigateway-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": [], + "endpoint": { + "url": "https://apigateway-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://apigateway.{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://apigateway.{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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.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://apigateway.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apigateway-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apigateway.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://apigateway.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://apigateway.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://apigateway-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://apigateway-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://apigateway.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apigateway-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://apigateway-fips.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://apigateway.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apigateway.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://apigateway-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://apigateway-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://apigateway.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.apigateway#BadRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.apigateway#String" + } + }, + "traits": { + "smithy.api#documentation": "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.apigateway#BasePathMapping": { + "type": "structure", + "members": { + "basePath": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The base path name that callers of the API must provide as part of the URL after the domain name.
" + } + }, + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
" + } + }, + "stage": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the associated stage.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the base path that callers of the API must provide as part of the URL after the domain name.
" + } + }, + "com.amazonaws.apigateway#BasePathMappings": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfBasePathMapping", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a collection of BasePathMapping resources.
" + } + }, + "com.amazonaws.apigateway#Blob": { + "type": "blob" + }, + "com.amazonaws.apigateway#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.apigateway#CacheClusterSize": { + "type": "enum", + "members": { + "SIZE_0_POINT_5_GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "0.5" + } + }, + "SIZE_1_POINT_6_GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "1.6" + } + }, + "SIZE_6_POINT_1_GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "6.1" + } + }, + "SIZE_13_POINT_5_GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "13.5" + } + }, + "SIZE_28_POINT_4_GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "28.4" + } + }, + "SIZE_58_POINT_2_GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "58.2" + } + }, + "SIZE_118_GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "118" + } + }, + "SIZE_237_GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "237" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns the size of the CacheCluster.
" + } + }, + "com.amazonaws.apigateway#CacheClusterStatus": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_AVAILABLE" + } + }, + "FLUSH_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLUSH_IN_PROGRESS" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns the status of the CacheCluster.
" + } + }, + "com.amazonaws.apigateway#CanarySettings": { + "type": "structure", + "members": { + "percentTraffic": { + "target": "com.amazonaws.apigateway#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The percent (0-100) of traffic diverted to a canary deployment.
" + } + }, + "deploymentId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ID of the canary deployment.
" + } + }, + "stageVariableOverrides": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
" + } + }, + "useStageCache": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings of a canary deployment.
" + } + }, + "com.amazonaws.apigateway#ClientCertificate": { + "type": "structure", + "members": { + "clientCertificateId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the client certificate.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the client certificate.
" + } + }, + "pemEncodedCertificate": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
" + } + }, + "createdDate": { + "target": "com.amazonaws.apigateway#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the client certificate was created.
" + } + }, + "expirationDate": { + "target": "com.amazonaws.apigateway#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the client certificate will expire.
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The collection of tags. Each tag element is associated with a given resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
" + } + }, + "com.amazonaws.apigateway#ClientCertificates": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfClientCertificate", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a collection of ClientCertificate resources.
" + } + }, + "com.amazonaws.apigateway#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.apigateway#String" + } + }, + "traits": { + "smithy.api#documentation": "The request configuration has conflicts. For details, see the accompanying error message.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.apigateway#ConnectionType": { + "type": "enum", + "members": { + "INTERNET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNET" + } + }, + "VPC_LINK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_LINK" + } + } + } + }, + "com.amazonaws.apigateway#ContentHandlingStrategy": { + "type": "enum", + "members": { + "CONVERT_TO_BINARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONVERT_TO_BINARY" + } + }, + "CONVERT_TO_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONVERT_TO_TEXT" + } + } + } + }, + "com.amazonaws.apigateway#CreateApiKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateApiKeyRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#ApiKey" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Create an ApiKey resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/apikeys", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateApiKeyRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the ApiKey.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the ApiKey.
" + } + }, + "enabled": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the ApiKey can be used by callers.
" + } + }, + "generateDistinctId": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
Specifies a value of the API key.
" + } + }, + "stageKeys": { + "target": "com.amazonaws.apigateway#ListOfStageKeys", + "traits": { + "smithy.api#documentation": "DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
" + } + }, + "customerId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
Request to create an ApiKey resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateAuthorizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateAuthorizerRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Authorizer" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Adds a new Authorizer resource to an existing RestApi resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/restapis/{restApiId}/authorizers", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateAuthorizerRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the authorizer.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.apigateway#AuthorizerType", + "traits": { + "smithy.api#documentation": "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
" + } + }, + "authorizerUri": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
" + } + }, + "identitySource": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identity source for which authorization is requested. For a TOKEN or\n COGNITO_USER_POOLS authorizer, this is required and specifies the request\n header mapping expression for the custom header holding the authorization token submitted by\n the client. For example, if the token header name is Auth, the header mapping\n expression is method.request.header.Auth. For the REQUEST\n authorizer, this is required when authorization caching is enabled. The value is a\n comma-separated string of one or more mapping expressions of the specified request parameters.\n For example, if an Auth header, a Name query string parameter are\n defined as identity sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to derive the\n authorization caching key and to perform runtime validation of the REQUEST\n authorizer by verifying all of the identity-related request parameters are present, not null\n and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda\n function, otherwise, it returns a 401 Unauthorized response without calling the Lambda\n function. The valid value is a string of comma-separated mapping expressions of the specified\n request parameters. When the authorization caching is not enabled, this property is\n optional.
A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Request to add a new Authorizer to an existing RestApi resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateBasePathMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateBasePathMappingRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#BasePathMapping" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new BasePathMapping resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/domainnames/{domainName}/basepathmappings", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateBasePathMappingRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The domain name of the BasePathMapping resource to create.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "domainNameId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier for the domain name resource. Required for private custom domain names.
", + "smithy.api#httpQuery": "domainNameId" + } + }, + "basePath": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.
" + } + }, + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#required": {} + } + }, + "stage": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Requests API Gateway to create a new BasePathMapping resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Deployment" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a Deployment resource, which makes a specified RestApi callable over the internet.
", + "smithy.api#http": { + "method": "POST", + "uri": "/restapis/{restApiId}/deployments", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateDeploymentRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "stageName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the Stage resource for the Deployment resource to create.
" + } + }, + "stageDescription": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the Stage resource for the Deployment resource to create.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description for the Deployment resource to create.
" + } + }, + "cacheClusterEnabled": { + "target": "com.amazonaws.apigateway#NullableBoolean", + "traits": { + "smithy.api#documentation": "Enables a cache cluster for the Stage resource specified in the input.
" + } + }, + "cacheClusterSize": { + "target": "com.amazonaws.apigateway#CacheClusterSize", + "traits": { + "smithy.api#documentation": "The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
" + } + }, + "variables": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "A map that defines the stage variables for the Stage resource that is associated\n with the new deployment. Variable names can have alphanumeric and underscore characters, and the values\n must match [A-Za-z0-9-._~:/?#&=,]+.
The input configuration for the canary deployment when the deployment is a canary release deployment.
" + } + }, + "tracingEnabled": { + "target": "com.amazonaws.apigateway#NullableBoolean", + "traits": { + "smithy.api#documentation": "Specifies whether active tracing with X-ray is enabled for the Stage.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Requests API Gateway to create a Deployment resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateDocumentationPart": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateDocumentationPartRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DocumentationPart" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a documentation part.
", + "smithy.api#http": { + "method": "POST", + "uri": "/restapis/{restApiId}/documentation/parts", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateDocumentationPartRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "location": { + "target": "com.amazonaws.apigateway#DocumentationPartLocation", + "traits": { + "smithy.api#documentation": "The location of the targeted API entity of the to-be-created documentation part.
", + "smithy.api#required": {} + } + }, + "properties": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Creates a new documentation part of a given API.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateDocumentationVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateDocumentationVersionRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DocumentationVersion" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a documentation version
", + "smithy.api#http": { + "method": "POST", + "uri": "/restapis/{restApiId}/documentation/versions", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateDocumentationVersionRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documentationVersion": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The version identifier of the new snapshot.
", + "smithy.api#required": {} + } + }, + "stageName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The stage name to be associated with the new documentation snapshot.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A description about the new documentation snapshot.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Creates a new documentation version of a given API.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateDomainNameRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DomainName" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new domain name.
", + "smithy.api#http": { + "method": "POST", + "uri": "/domainnames", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateDomainNameAccessAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateDomainNameAccessAssociationRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DomainNameAccessAssociation" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a domain name access association resource between an access association source and a private custom\n domain name.
", + "smithy.api#http": { + "method": "POST", + "uri": "/domainnameaccessassociations", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateDomainNameAccessAssociationRequest": { + "type": "structure", + "members": { + "domainNameArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\n The ARN of the domain name.\n
", + "smithy.api#required": {} + } + }, + "accessAssociationSourceType": { + "target": "com.amazonaws.apigateway#AccessAssociationSourceType", + "traits": { + "smithy.api#documentation": "\nThe type of the domain name access association source.\n
", + "smithy.api#required": {} + } + }, + "accessAssociationSource": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\nThe identifier of the domain name access association source. For a VPCE, the value is the VPC endpoint ID.\n
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
The name of the DomainName resource.
", + "smithy.api#required": {} + } + }, + "certificateName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The user-friendly name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
" + } + }, + "certificateBody": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint or private endpoint for this domain name provided by your certificate authority.
" + } + }, + "certificatePrivateKey": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
" + } + }, + "certificateChain": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
" + } + }, + "certificateArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.
" + } + }, + "regionalCertificateName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
" + } + }, + "regionalCertificateArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.
" + } + }, + "endpointConfiguration": { + "target": "com.amazonaws.apigateway#EndpointConfiguration", + "traits": { + "smithy.api#documentation": "The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
The Transport Layer Security (TLS) version + cipher suite for this DomainName.
" + } + }, + "endpointAccessMode": { + "target": "com.amazonaws.apigateway#EndpointAccessMode", + "traits": { + "smithy.api#documentation": "\nThe endpoint access mode of the DomainName. Only available for DomainNames that use security policies that start with SecurityPolicy_.\n
The ARN of the public certificate issued by ACM to validate ownership of your custom\n domain. Only required when configuring mutual TLS and using an ACM imported or private CA\n certificate ARN as the regionalCertificateArn.
" + } + }, + "policy": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method\n configuration. Supported only for private custom\n domain names.
\nThe routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to create a new domain name.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateModelRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Model" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Adds a new Model resource to an existing RestApi resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/restapis/{restApiId}/models", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateModelRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The RestApi identifier under which the Model will be created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the model. Must be alphanumeric.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the model.
" + } + }, + "schema": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The schema for the model. For application/json models, this should be JSON schema draft 4 model. The maximum size of the model is 400 KB.
The content-type for the model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to add a new Model to an existing RestApi resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateRequestValidator": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateRequestValidatorRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#RequestValidator" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a RequestValidator of a given RestApi.
", + "smithy.api#http": { + "method": "POST", + "uri": "/restapis/{restApiId}/requestvalidators", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateRequestValidatorRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the to-be-created RequestValidator.
" + } + }, + "validateRequestBody": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).
A Boolean flag to indicate whether to validate request parameters, true, or not false.
Creates a RequestValidator of a given RestApi.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateResourceRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Resource" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a Resource resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/restapis/{restApiId}/resources/{parentId}", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateResourceRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "parentId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The parent resource's identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "pathPart": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The last path segment for this resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Requests API Gateway to create a Resource resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateRestApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateRestApiRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#RestApi" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new RestApi resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/restapis", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateRestApiRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the RestApi.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the RestApi.
" + } + }, + "version": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A version identifier for the API.
" + } + }, + "cloneFrom": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ID of the RestApi that you want to clone from.
" + } + }, + "binaryMediaTypes": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
" + } + }, + "minimumCompressionSize": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
" + } + }, + "apiKeySource": { + "target": "com.amazonaws.apigateway#ApiKeySourceType", + "traits": { + "smithy.api#documentation": "The source of the API key for metering requests according to a usage plan. Valid values\n are: HEADER to read the API key from the X-API-Key header of a\n request. AUTHORIZER to read the API key from the UsageIdentifierKey\n from a custom authorizer.
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.
" + } + }, + "policy": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
Specifies whether clients can invoke your API by using the default execute-api endpoint.\n By default, clients can invoke your API with the default\n https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a\n custom domain name to invoke your API, disable the default endpoint
\nThe Transport Layer Security (TLS) version + cipher suite for this RestApi. \n
" + } + }, + "endpointAccessMode": { + "target": "com.amazonaws.apigateway#EndpointAccessMode", + "traits": { + "smithy.api#documentation": "\nThe endpoint access mode of the RestApi. Only available for RestApis that use security policies that start with SecurityPolicy_.
The POST Request to add a new RestApi resource to your collection.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateStageRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Stage" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new Stage resource that references a pre-existing Deployment for the API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/restapis/{restApiId}/stages", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateStageRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "stageName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
", + "smithy.api#required": {} + } + }, + "deploymentId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the Deployment resource for the Stage resource.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the Stage resource.
" + } + }, + "cacheClusterEnabled": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether cache clustering is enabled for the stage.
" + } + }, + "cacheClusterSize": { + "target": "com.amazonaws.apigateway#CacheClusterSize", + "traits": { + "smithy.api#documentation": "The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
" + } + }, + "variables": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "A map that defines the stage variables for the new Stage resource. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.
The version of the associated API documentation.
" + } + }, + "canarySettings": { + "target": "com.amazonaws.apigateway#CanarySettings", + "traits": { + "smithy.api#documentation": "The canary deployment settings of this stage.
" + } + }, + "tracingEnabled": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether active tracing with X-ray is enabled for the Stage.
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
Requests API Gateway to create a Stage resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateUsagePlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateUsagePlanRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#UsagePlan" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
", + "smithy.api#http": { + "method": "POST", + "uri": "/usageplans", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateUsagePlanKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateUsagePlanKeyRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#UsagePlanKey" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a usage plan key for adding an existing API key to a usage plan.
", + "smithy.api#http": { + "method": "POST", + "uri": "/usageplans/{usagePlanId}/keys", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#CreateUsagePlanKeyRequest": { + "type": "structure", + "members": { + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "keyId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of a UsagePlanKey resource for a plan customer.
", + "smithy.api#required": {} + } + }, + "keyType": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The type of a UsagePlanKey resource for a plan customer.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The POST request to create a usage plan key for adding an existing API key to a usage plan.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateUsagePlanRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the usage plan.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the usage plan.
" + } + }, + "apiStages": { + "target": "com.amazonaws.apigateway#ListOfApiStage", + "traits": { + "smithy.api#documentation": "The associated API stages of the usage plan.
" + } + }, + "throttle": { + "target": "com.amazonaws.apigateway#ThrottleSettings", + "traits": { + "smithy.api#documentation": "The throttling limits of the usage plan.
" + } + }, + "quota": { + "target": "com.amazonaws.apigateway#QuotaSettings", + "traits": { + "smithy.api#documentation": "The quota of the usage plan.
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#CreateVpcLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#CreateVpcLinkRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#VpcLink" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
", + "smithy.api#http": { + "method": "POST", + "uri": "/vpclinks", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#CreateVpcLinkRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name used to label and identify the VPC link.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the VPC link.
" + } + }, + "targetArns": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteApiKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteApiKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the ApiKey resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/apikeys/{apiKey}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteApiKeyRequest": { + "type": "structure", + "members": { + "apiKey": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the ApiKey resource to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to delete the ApiKey resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteAuthorizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteAuthorizerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing Authorizer resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/authorizers/{authorizerId}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteAuthorizerRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "authorizerId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the Authorizer resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to delete an existing Authorizer resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteBasePathMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteBasePathMappingRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the BasePathMapping resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/domainnames/{domainName}/basepathmappings/{basePath}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteBasePathMappingRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The domain name of the BasePathMapping resource to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "domainNameId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\n The identifier for the domain name resource. Supported only for private custom domain names.\n
", + "smithy.api#httpQuery": "domainNameId" + } + }, + "basePath": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The base path name of the BasePathMapping resource to delete.
\nTo specify an empty base path, set this parameter to '(none)'.
A request to delete the BasePathMapping resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteClientCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteClientCertificateRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the ClientCertificate resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/clientcertificates/{clientCertificateId}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteClientCertificateRequest": { + "type": "structure", + "members": { + "clientCertificateId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the ClientCertificate resource to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to delete the ClientCertificate resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteDeploymentRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/deployments/{deploymentId}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteDeploymentRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "deploymentId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the Deployment resource to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Requests API Gateway to delete a Deployment resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteDocumentationPart": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteDocumentationPartRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a documentation part
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/documentation/parts/{documentationPartId}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteDocumentationPartRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documentationPartId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the to-be-deleted documentation part.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Deletes an existing documentation part of an API.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteDocumentationVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteDocumentationVersionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a documentation version.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/documentation/versions/{documentationVersion}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteDocumentationVersionRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documentationVersion": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The version identifier of a to-be-deleted documentation snapshot.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Deletes an existing documentation version of an API.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteDomainNameRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the DomainName resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/domainnames/{domainName}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteDomainNameAccessAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteDomainNameAccessAssociationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the DomainNameAccessAssociation resource.
\nOnly the AWS account that created the DomainNameAccessAssociation resource can delete it. To stop an access association source in another AWS account from accessing your private custom domain name, use the RejectDomainNameAccessAssociation operation.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/domainnameaccessassociations/{domainNameAccessAssociationArn}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteDomainNameAccessAssociationRequest": { + "type": "structure", + "members": { + "domainNameAccessAssociationArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\n The ARN of the domain name access association resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteDomainNameRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the DomainName resource to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "domainNameId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\n The identifier for the domain name resource. Supported only for private custom domain names.\n
", + "smithy.api#httpQuery": "domainNameId" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to delete the DomainName resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteGatewayResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteGatewayResponseRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/gatewayresponses/{responseType}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteGatewayResponseRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "responseType": { + "target": "com.amazonaws.apigateway#GatewayResponseType", + "traits": { + "smithy.api#documentation": "The response type of the associated GatewayResponse.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteIntegrationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Represents a delete integration.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/integration", + "code": 204 + } + } + }, + "com.amazonaws.apigateway#DeleteIntegrationRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a delete integration request's resource identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a delete integration request's HTTP method.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a delete integration request.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteIntegrationResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteIntegrationResponseRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Represents a delete integration response.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/integration/responses/{statusCode}", + "code": 204 + } + } + }, + "com.amazonaws.apigateway#DeleteIntegrationResponseRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a delete integration response request's resource identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a delete integration response request's HTTP method.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", + "traits": { + "smithy.api#documentation": "Specifies a delete integration response request's status code.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a delete integration response request.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteMethod": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteMethodRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing Method resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}", + "code": 204 + } + } + }, + "com.amazonaws.apigateway#DeleteMethodRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Resource identifier for the Method resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The HTTP verb of the Method resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to delete an existing Method resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteMethodResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteMethodResponseRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing MethodResponse resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/responses/{statusCode}", + "code": 204 + } + } + }, + "com.amazonaws.apigateway#DeleteMethodResponseRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Resource identifier for the MethodResponse resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The HTTP verb of the Method resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", + "traits": { + "smithy.api#documentation": "The status code identifier for the MethodResponse resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to delete an existing MethodResponse resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteModelRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a model.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/models/{modelName}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteModelRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the model to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to delete an existing model in an existing RestApi resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteRequestValidator": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteRequestValidatorRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a RequestValidator of a given RestApi.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/requestvalidators/{requestValidatorId}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteRequestValidatorRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "requestValidatorId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the RequestValidator to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Deletes a specified RequestValidator of a given RestApi.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Resource resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/resources/{resourceId}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteResourceRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the Resource resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to delete a Resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteRestApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteRestApiRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified API.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteRestApiRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to delete the specified API from your collection.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteStageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Stage resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/stages/{stageName}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteStageRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "stageName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the Stage resource to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Requests API Gateway to delete a Stage resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteUsagePlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteUsagePlanRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a usage plan of a given plan Id.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/usageplans/{usagePlanId}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteUsagePlanKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteUsagePlanKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a usage plan key and remove the underlying API key from the associated usage plan.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/usageplans/{usagePlanId}/keys/{keyId}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteUsagePlanKeyRequest": { + "type": "structure", + "members": { + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "keyId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Id of the UsagePlanKey resource to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteUsagePlanRequest": { + "type": "structure", + "members": { + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Id of the to-be-deleted usage plan.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The DELETE request to delete a usage plan of a given plan Id.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#DeleteVpcLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#DeleteVpcLinkRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing VpcLink of a specified identifier.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/vpclinks/{vpcLinkId}", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#DeleteVpcLinkRequest": { + "type": "structure", + "members": { + "vpcLinkId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Deletes an existing VpcLink of a specified identifier.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#Deployment": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier for the deployment resource.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description for the deployment resource.
" + } + }, + "createdDate": { + "target": "com.amazonaws.apigateway#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the deployment resource was created.
" + } + }, + "apiSummary": { + "target": "com.amazonaws.apigateway#PathToMapOfMethodSnapshot", + "traits": { + "smithy.api#documentation": "A summary of the RestApi at the date and time that the deployment resource was created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
" + } + }, + "com.amazonaws.apigateway#DeploymentCanarySettings": { + "type": "structure", + "members": { + "percentTraffic": { + "target": "com.amazonaws.apigateway#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The percentage (0.0-100.0) of traffic routed to the canary deployment.
" + } + }, + "stageVariableOverrides": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.
" + } + }, + "useStageCache": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input configuration for a canary deployment.
" + } + }, + "com.amazonaws.apigateway#Deployments": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfDeployment", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.
" + } + }, + "com.amazonaws.apigateway#DocumentationPart": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
" + } + }, + "properties": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., \"{ \\\"description\\\": \\\"The API does ...\\\" }\". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.
A documentation part for a targeted API entity.
" + } + }, + "com.amazonaws.apigateway#DocumentationPartIds": { + "type": "structure", + "members": { + "ids": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A list of the returned documentation part identifiers.
" + } + }, + "warnings": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A list of warning messages reported during import of documentation parts.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of the imported DocumentationPart identifiers.
" + } + }, + "com.amazonaws.apigateway#DocumentationPartLocation": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.apigateway#DocumentationPartType", + "traits": { + "smithy.api#documentation": "The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type.
The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.
The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.
The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.
The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type.
Specifies the target API entity to which the documentation applies.
" + } + }, + "com.amazonaws.apigateway#DocumentationPartLocationStatusCode": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([1-5]\\d\\d|\\*|\\s*)$" + } + }, + "com.amazonaws.apigateway#DocumentationPartType": { + "type": "enum", + "members": { + "API": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API" + } + }, + "AUTHORIZER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZER" + } + }, + "MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL" + } + }, + "RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE" + } + }, + "METHOD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METHOD" + } + }, + "PATH_PARAMETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PATH_PARAMETER" + } + }, + "QUERY_PARAMETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERY_PARAMETER" + } + }, + "REQUEST_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUEST_HEADER" + } + }, + "REQUEST_BODY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUEST_BODY" + } + }, + "RESPONSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESPONSE" + } + }, + "RESPONSE_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESPONSE_HEADER" + } + }, + "RESPONSE_BODY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESPONSE_BODY" + } + } + } + }, + "com.amazonaws.apigateway#DocumentationParts": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfDocumentationPart", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of documentation parts of an API.
" + } + }, + "com.amazonaws.apigateway#DocumentationVersion": { + "type": "structure", + "members": { + "version": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The version identifier of the API documentation snapshot.
" + } + }, + "createdDate": { + "target": "com.amazonaws.apigateway#Timestamp", + "traits": { + "smithy.api#documentation": "The date when the API documentation snapshot is created.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the API documentation snapshot.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A snapshot of the documentation of an API.
" + } + }, + "com.amazonaws.apigateway#DocumentationVersions": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfDocumentationVersion", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of documentation snapshots of an API.
" + } + }, + "com.amazonaws.apigateway#DomainName": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The custom domain name as an API host name, for example, my-api.example.com.
The identifier for the domain name resource. Supported only for private custom domain names.
" + } + }, + "domainNameArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ARN of the domain name.\n
" + } + }, + "certificateName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
" + } + }, + "certificateArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.
" + } + }, + "certificateUploadDate": { + "target": "com.amazonaws.apigateway#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.
" + } + }, + "regionalDomainName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
" + } + }, + "regionalHostedZoneId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
" + } + }, + "regionalCertificateName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the certificate that will be used for validating the regional domain name.
" + } + }, + "regionalCertificateArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
" + } + }, + "distributionDomainName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
" + } + }, + "distributionHostedZoneId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
" + } + }, + "domainNameStatus": { + "target": "com.amazonaws.apigateway#DomainNameStatus", + "traits": { + "smithy.api#documentation": "The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
An optional text message containing detailed information about status of the DomainName migration.
" + } + }, + "securityPolicy": { + "target": "com.amazonaws.apigateway#SecurityPolicy", + "traits": { + "smithy.api#documentation": "The Transport Layer Security (TLS) version + cipher suite for this DomainName.
" + } + }, + "endpointAccessMode": { + "target": "com.amazonaws.apigateway#EndpointAccessMode", + "traits": { + "smithy.api#documentation": "\nThe endpoint access mode of the DomainName. \n
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The collection of tags. Each tag element is associated with a given resource.
" + } + }, + "mutualTlsAuthentication": { + "target": "com.amazonaws.apigateway#MutualTlsAuthentication", + "traits": { + "smithy.api#documentation": "The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway\n performs two-way authentication between the client and the server. Clients must present a\n trusted certificate to access your API.
" + } + }, + "ownershipVerificationCertificateArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ARN of the public certificate issued by ACM to validate ownership of your custom\n domain. Only required when configuring mutual TLS and using an ACM imported or private CA\n certificate ARN as the regionalCertificateArn.
" + } + }, + "managementPolicy": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A stringified JSON policy document that applies to the API Gateway Management service for this DomainName. This policy document controls access for access association sources to create domain name access associations with this DomainName. Supported only for private custom domain names.
" + } + }, + "policy": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method\n configuration. Supported only for private custom\n domain names.
The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a custom domain name as a user-friendly host name of an API (RestApi).
" + } + }, + "com.amazonaws.apigateway#DomainNameAccessAssociation": { + "type": "structure", + "members": { + "domainNameAccessAssociationArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ARN of the domain name access association resource.\n
" + } + }, + "domainNameArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ARN of the domain name.\n
" + } + }, + "accessAssociationSourceType": { + "target": "com.amazonaws.apigateway#AccessAssociationSourceType", + "traits": { + "smithy.api#documentation": "\n The type of the domain name access association source.\n
" + } + }, + "accessAssociationSource": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\n The ARN of the domain name access association source. For a VPCE, the ARN must be a VPC endpoint. \n
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "\nThe collection of tags. Each tag element is associated with a given resource.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a domain name access association between an access association source and a private custom domain name. With a domain name access association, an access association source can invoke a private custom domain name while isolated from the public internet.
" + } + }, + "com.amazonaws.apigateway#DomainNameAccessAssociations": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfDomainNameAccessAssociation", + "traits": { + "smithy.api#documentation": "\nThe current page of elements from this collection.\n
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.\n
", + "smithy.api#httpQuery": "position" + } + } + } + }, + "com.amazonaws.apigateway#DomainNameStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "PENDING_CERTIFICATE_REIMPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CERTIFICATE_REIMPORT" + } + }, + "PENDING_OWNERSHIP_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_OWNERSHIP_VERIFICATION" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.apigateway#DomainNames": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfDomainName", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a collection of DomainName resources.
" + } + }, + "com.amazonaws.apigateway#Double": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.apigateway#EndpointAccessMode": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "STRICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRICT" + } + } + } + }, + "com.amazonaws.apigateway#EndpointConfiguration": { + "type": "structure", + "members": { + "types": { + "target": "com.amazonaws.apigateway#ListOfEndpointType", + "traits": { + "smithy.api#documentation": "A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is \"EDGE\". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.
The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to\n invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the\n PRIVATE endpoint type, only dualstack is supported.
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.
" + } + }, + "com.amazonaws.apigateway#EndpointType": { + "type": "enum", + "members": { + "REGIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGIONAL" + } + }, + "EDGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EDGE" + } + }, + "PRIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIVATE" + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region; and PRIVATE for private APIs.
The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "contentDisposition": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The content-disposition header value in the HTTP response.
", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "body": { + "target": "com.amazonaws.apigateway#Blob", + "traits": { + "smithy.api#documentation": "The binary blob response to GetExport, which contains the export.
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The binary blob response to GetExport, which contains the generated SDK.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.apigateway#FlushStageAuthorizersCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#FlushStageAuthorizersCacheRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Flushes all authorizer cache entries on a stage.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/stages/{stageName}/cache/authorizers", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#FlushStageAuthorizersCacheRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "stageName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the stage to flush.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to flush authorizer cache entries on a specified stage.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#FlushStageCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#FlushStageCacheRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Flushes a stage's cache.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restapis/{restApiId}/stages/{stageName}/cache/data", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#FlushStageCacheRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "stageName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the stage to flush its cache.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Requests API Gateway to flush a stage's cache.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GatewayResponse": { + "type": "structure", + "members": { + "responseType": { + "target": "com.amazonaws.apigateway#GatewayResponseType", + "traits": { + "smithy.api#documentation": "The response type of the associated GatewayResponse.
" + } + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status code for this GatewayResponse.
" + } + }, + "responseParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "Response parameters (paths, query strings and headers) of the GatewayResponse as a\n string-to-string map of key-value pairs.
" + } + }, + "responseTemplates": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
" + } + }, + "defaultResponse": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
" + } + }, + "com.amazonaws.apigateway#GatewayResponseType": { + "type": "enum", + "members": { + "DEFAULT_4XX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT_4XX" + } + }, + "DEFAULT_5XX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT_5XX" + } + }, + "RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_NOT_FOUND" + } + }, + "UNAUTHORIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAUTHORIZED" + } + }, + "INVALID_API_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_API_KEY" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "AUTHORIZER_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZER_FAILURE" + } + }, + "AUTHORIZER_CONFIGURATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZER_CONFIGURATION_ERROR" + } + }, + "INVALID_SIGNATURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_SIGNATURE" + } + }, + "EXPIRED_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED_TOKEN" + } + }, + "MISSING_AUTHENTICATION_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_AUTHENTICATION_TOKEN" + } + }, + "INTEGRATION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTEGRATION_FAILURE" + } + }, + "INTEGRATION_TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTEGRATION_TIMEOUT" + } + }, + "API_CONFIGURATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_CONFIGURATION_ERROR" + } + }, + "UNSUPPORTED_MEDIA_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_MEDIA_TYPE" + } + }, + "BAD_REQUEST_PARAMETERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAD_REQUEST_PARAMETERS" + } + }, + "BAD_REQUEST_BODY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAD_REQUEST_BODY" + } + }, + "REQUEST_TOO_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUEST_TOO_LARGE" + } + }, + "THROTTLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THROTTLED" + } + }, + "QUOTA_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUOTA_EXCEEDED" + } + }, + "WAF_FILTERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WAF_FILTERED" + } + } + } + }, + "com.amazonaws.apigateway#GatewayResponses": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfGatewayResponse", + "traits": { + "smithy.api#documentation": "Returns the entire collection, because of no pagination support.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.
Generates a ClientCertificate resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clientcertificates", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#GenerateClientCertificateRequest": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the ClientCertificate.
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
A request to generate a ClientCertificate resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetAccountRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Account" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the current Account resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/account", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetAccountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Requests API Gateway to get information about the current Account resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetApiKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetApiKeyRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#ApiKey" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the current ApiKey resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/apikeys/{apiKey}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetApiKeyRequest": { + "type": "structure", + "members": { + "apiKey": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the ApiKey resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "includeValue": { + "target": "com.amazonaws.apigateway#NullableBoolean", + "traits": { + "smithy.api#documentation": "A boolean flag to specify whether (true) or not (false) the result contains the key value.
A request to get information about the current ApiKey resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetApiKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetApiKeysRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#ApiKeys" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the current ApiKeys resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/apikeys", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" + } + } + }, + "com.amazonaws.apigateway#GetApiKeysRequest": { + "type": "structure", + "members": { + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + }, + "nameQuery": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of queried API keys.
", + "smithy.api#httpQuery": "name" + } + }, + "customerId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.
", + "smithy.api#httpQuery": "customerId" + } + }, + "includeValues": { + "target": "com.amazonaws.apigateway#NullableBoolean", + "traits": { + "smithy.api#documentation": "A boolean flag to specify whether (true) or not (false) the result contains key values.
A request to get information about the current ApiKeys resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetAuthorizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetAuthorizerRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Authorizer" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Describe an existing Authorizer resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/authorizers/{authorizerId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetAuthorizerRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "authorizerId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the Authorizer resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to describe an existing Authorizer resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetAuthorizers": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetAuthorizersRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Authorizers" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Describe an existing Authorizers resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/authorizers", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetAuthorizersRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "Request to describe an existing Authorizers resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetBasePathMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetBasePathMappingRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#BasePathMapping" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Describe a BasePathMapping resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/domainnames/{domainName}/basepathmappings/{basePath}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetBasePathMappingRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The domain name of the BasePathMapping resource to be described.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "domainNameId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier for the domain name resource. Supported only for private custom domain names.\n
", + "smithy.api#httpQuery": "domainNameId" + } + }, + "basePath": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to describe a BasePathMapping resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetBasePathMappings": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetBasePathMappingsRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#BasePathMappings" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Represents a collection of BasePathMapping resources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/domainnames/{domainName}/basepathmappings", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" + } + } + }, + "com.amazonaws.apigateway#GetBasePathMappingsRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The domain name of a BasePathMapping resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "domainNameId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\n The identifier for the domain name resource. Supported only for private custom domain names.\n
", + "smithy.api#httpQuery": "domainNameId" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to get information about a collection of BasePathMapping resources.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetClientCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetClientCertificateRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#ClientCertificate" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the current ClientCertificate resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clientcertificates/{clientCertificateId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetClientCertificateRequest": { + "type": "structure", + "members": { + "clientCertificateId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the ClientCertificate resource to be described.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to get information about the current ClientCertificate resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetClientCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetClientCertificatesRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#ClientCertificates" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a collection of ClientCertificate resources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clientcertificates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" + } + } + }, + "com.amazonaws.apigateway#GetClientCertificatesRequest": { + "type": "structure", + "members": { + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to get information about a collection of ClientCertificate resources.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Deployment" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a Deployment resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/deployments/{deploymentId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetDeploymentRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "deploymentId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the Deployment resource to get information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "embed": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the \"apisummary\" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
Requests API Gateway to get information about a Deployment resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Deployments" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a Deployments collection.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/deployments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" + } + } + }, + "com.amazonaws.apigateway#GetDeploymentsRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "Requests API Gateway to get information about a Deployments collection.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetDocumentationPart": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetDocumentationPartRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DocumentationPart" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a documentation part.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/documentation/parts/{documentationPartId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetDocumentationPartRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documentationPartId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Gets a specified documentation part of a given API.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetDocumentationParts": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetDocumentationPartsRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DocumentationParts" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets documentation parts.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/documentation/parts", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetDocumentationPartsRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.apigateway#DocumentationPartType", + "traits": { + "smithy.api#documentation": "The type of API entities of the to-be-retrieved documentation parts.
", + "smithy.api#httpQuery": "type" + } + }, + "nameQuery": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of API entities of the to-be-retrieved documentation parts.
", + "smithy.api#httpQuery": "name" + } + }, + "path": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The path of API entities of the to-be-retrieved documentation parts.
", + "smithy.api#httpQuery": "path" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + }, + "locationStatus": { + "target": "com.amazonaws.apigateway#LocationStatusType", + "traits": { + "smithy.api#documentation": "The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetDocumentationVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetDocumentationVersionRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DocumentationVersion" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a documentation version.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/documentation/versions/{documentationVersion}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetDocumentationVersionRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documentationVersion": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The version identifier of the to-be-retrieved documentation snapshot.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Gets a documentation snapshot of an API.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetDocumentationVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetDocumentationVersionsRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DocumentationVersions" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets documentation versions.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/documentation/versions", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetDocumentationVersionsRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "Gets the documentation versions of an API.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetDomainNameRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DomainName" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
", + "smithy.api#http": { + "method": "GET", + "uri": "/domainnames/{domainName}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetDomainNameAccessAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetDomainNameAccessAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DomainNameAccessAssociations" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Represents a collection on DomainNameAccessAssociations resources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/domainnameaccessassociations", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetDomainNameAccessAssociationsRequest": { + "type": "structure", + "members": { + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.\n
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.\n
", + "smithy.api#httpQuery": "limit" + } + }, + "resourceOwner": { + "target": "com.amazonaws.apigateway#ResourceOwner", + "traits": { + "smithy.api#documentation": " The owner of the domain name access association. Use SELF to only list the domain name access associations owned by your own account.\n Use OTHER_ACCOUNTS to list the domain name access associations with your private custom domain names that are owned by other AWS\n accounts.
The name of the DomainName resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "domainNameId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\n The identifier for the domain name resource. Required for private custom domain names.\n
", + "smithy.api#httpQuery": "domainNameId" + } + } + }, + "traits": { + "smithy.api#documentation": "Request to get the name of a DomainName resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetDomainNames": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetDomainNamesRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DomainNames" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Represents a collection of DomainName resources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/domainnames", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" + }, + "smithy.test#smokeTests": [ + { + "id": "GetDomainNamesSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.apigateway#GetDomainNamesRequest": { + "type": "structure", + "members": { + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + }, + "resourceOwner": { + "target": "com.amazonaws.apigateway#ResourceOwner", + "traits": { + "smithy.api#documentation": "The owner of the domain name access association.\n
", + "smithy.api#httpQuery": "resourceOwner" + } + } + }, + "traits": { + "smithy.api#documentation": "Request to describe a collection of DomainName resources.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetExportRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#ExportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Exports a deployed version of a RestApi in a specified format.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/stages/{stageName}/exports/{exportType}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetExportRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "stageName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the Stage that will be exported.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "exportType": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType\n oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool
The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.
Request a new export of a RestApi for a particular Stage.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetGatewayResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetGatewayResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#GatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a GatewayResponse of a specified response type on the given RestApi.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/gatewayresponses/{responseType}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetGatewayResponseRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "responseType": { + "target": "com.amazonaws.apigateway#GatewayResponseType", + "traits": { + "smithy.api#documentation": "The response type of the associated GatewayResponse.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Gets a GatewayResponse of a specified response type on the given RestApi.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetGatewayResponses": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetGatewayResponsesRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#GatewayResponses" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/gatewayresponses", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetGatewayResponsesRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Integration" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Get the integration settings.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/integration", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetIntegrationRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a get integration request's resource identifier
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a get integration request's HTTP method.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a request to get the integration configuration.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetIntegrationResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetIntegrationResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#IntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Represents a get integration response.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/integration/responses/{statusCode}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetIntegrationResponseRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a get integration response request's resource identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a get integration response request's HTTP method.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", + "traits": { + "smithy.api#documentation": "Specifies a get integration response request's status code.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a get integration response request.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetMethod": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetMethodRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Method" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Describe an existing Method resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetMethodRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Resource identifier for the Method resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies the method request's HTTP method type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to describe an existing Method resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetMethodResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetMethodResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#MethodResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a MethodResponse resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/responses/{statusCode}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetMethodResponseRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Resource identifier for the MethodResponse resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The HTTP verb of the Method resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", + "traits": { + "smithy.api#documentation": "The status code for the MethodResponse resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to describe a MethodResponse resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetModelRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Model" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an existing model defined for a RestApi resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/models/{modelName}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetModelRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The RestApi identifier under which the Model exists.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the model as an identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flatten": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.
Request to list information about a model in an existing RestApi resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetModelTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetModelTemplateRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Template" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Generates a sample mapping template that can be used to transform a payload into the structure of a model.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/models/{modelName}/default_template", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetModelTemplateRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the model for which to generate a template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to generate a sample mapping template used to transform the payload.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetModelsRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Models" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Describes existing Models defined for a RestApi resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/models", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" + } + } + }, + "com.amazonaws.apigateway#GetModelsRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "Request to list existing Models defined for a RestApi resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetRequestValidator": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetRequestValidatorRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#RequestValidator" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a RequestValidator of a given RestApi.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/requestvalidators/{requestValidatorId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetRequestValidatorRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "requestValidatorId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the RequestValidator to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Gets a RequestValidator of a given RestApi.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetRequestValidators": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetRequestValidatorsRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#RequestValidators" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the RequestValidators collection of a given RestApi.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/requestvalidators", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetRequestValidatorsRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "Gets the RequestValidators collection of a given RestApi.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetResourceRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Resource" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists information about a resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/resources/{resourceId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetResourceRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier for the Resource resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "embed": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\" string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods.
Request to list information about a resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetResourcesRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Resources" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists information about a collection of Resource resources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/resources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" + } + } + }, + "com.amazonaws.apigateway#GetResourcesRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + }, + "embed": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.
Request to list information about a collection of resources.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetRestApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetRestApiRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#RestApi" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the RestApi resource in the collection.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetRestApiRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The GET request to list an existing RestApi defined for your collection.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetRestApis": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetRestApisRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#RestApis" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the RestApis resources for your collection.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" + } + } + }, + "com.amazonaws.apigateway#GetRestApisRequest": { + "type": "structure", + "members": { + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "The GET request to list existing RestApis defined for your collection.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetSdk": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetSdkRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#SdkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Generates a client SDK for a RestApi and Stage.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/stages/{stageName}/sdks/{sdkType}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetSdkRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "stageName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the Stage that the SDK will use.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sdkType": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.
Request a new generated client SDK for a RestApi and Stage.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetSdkType": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetSdkTypeRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#SdkType" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an SDK type.
", + "smithy.api#http": { + "method": "GET", + "uri": "/sdktypes/{id}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetSdkTypeRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the queried SdkType instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get an SdkType instance.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetSdkTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetSdkTypesRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#SdkTypes" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets SDK types
", + "smithy.api#http": { + "method": "GET", + "uri": "/sdktypes", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetSdkTypesRequest": { + "type": "structure", + "members": { + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "Get the SdkTypes collection.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetStageRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Stage" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a Stage resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/stages/{stageName}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetStageRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "stageName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the Stage resource to get information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Requests API Gateway to get information about a Stage resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetStages": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetStagesRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Stages" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about one or more Stage resources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/restapis/{restApiId}/stages", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetStagesRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "deploymentId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The stages' deployment identifiers.
", + "smithy.api#httpQuery": "deploymentId" + } + } + }, + "traits": { + "smithy.api#documentation": "Requests API Gateway to get information about one or more Stage resources.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetTagsRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Tags" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the Tags collection for a given resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetTagsRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ARN of a resource that can be tagged.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "(Not currently supported) The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "Gets the Tags collection for a given resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetUsage": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetUsageRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Usage" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the usage data of a usage plan in a specified time interval.
", + "smithy.api#http": { + "method": "GET", + "uri": "/usageplans/{usagePlanId}/usage", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" + } + } + }, + "com.amazonaws.apigateway#GetUsagePlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetUsagePlanRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#UsagePlan" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a usage plan of a given plan identifier.
", + "smithy.api#http": { + "method": "GET", + "uri": "/usageplans/{usagePlanId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetUsagePlanKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetUsagePlanKeyRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#UsagePlanKey" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a usage plan key of a given key identifier.
", + "smithy.api#http": { + "method": "GET", + "uri": "/usageplans/{usagePlanId}/keys/{keyId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetUsagePlanKeyRequest": { + "type": "structure", + "members": { + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "keyId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The GET request to get a usage plan key of a given key identifier.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetUsagePlanKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetUsagePlanKeysRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#UsagePlanKeys" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets all the usage plan keys representing the API keys added to a specified usage plan.
", + "smithy.api#http": { + "method": "GET", + "uri": "/usageplans/{usagePlanId}/keys", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" + } + } + }, + "com.amazonaws.apigateway#GetUsagePlanKeysRequest": { + "type": "structure", + "members": { + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + }, + "nameQuery": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A query parameter specifying the name of the to-be-returned usage plan keys.
", + "smithy.api#httpQuery": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetUsagePlanRequest": { + "type": "structure", + "members": { + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the UsagePlan resource to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The GET request to get a usage plan of a given plan identifier.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetUsagePlans": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetUsagePlansRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#UsagePlans" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets all the usage plans of the caller's account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/usageplans", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" + } + } + }, + "com.amazonaws.apigateway#GetUsagePlansRequest": { + "type": "structure", + "members": { + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "keyId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the API key associated with the usage plans.
", + "smithy.api#httpQuery": "keyId" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "The GET request to get all the usage plans of the caller's account.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetUsageRequest": { + "type": "structure", + "members": { + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Id of the usage plan associated with the usage data.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "keyId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Id of the API key associated with the resultant usage data.
", + "smithy.api#httpQuery": "keyId" + } + }, + "startDate": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The starting date (e.g., 2016-01-01) of the usage data.
", + "smithy.api#httpQuery": "startDate", + "smithy.api#required": {} + } + }, + "endDate": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ending date (e.g., 2016-12-31) of the usage data.
", + "smithy.api#httpQuery": "endDate", + "smithy.api#required": {} + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "The GET request to get the usage data of a usage plan in a specified time interval.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetVpcLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetVpcLinkRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#VpcLink" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a specified VPC link under the caller's account in a region.
", + "smithy.api#http": { + "method": "GET", + "uri": "/vpclinks/{vpcLinkId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#GetVpcLinkRequest": { + "type": "structure", + "members": { + "vpcLinkId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Gets a specified VPC link under the caller's account in a region.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#GetVpcLinks": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#GetVpcLinksRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#VpcLinks" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the VpcLinks collection under the caller's account in a selected region.
", + "smithy.api#http": { + "method": "GET", + "uri": "/vpclinks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" + } + } + }, + "com.amazonaws.apigateway#GetVpcLinksRequest": { + "type": "structure", + "members": { + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
", + "smithy.api#httpQuery": "limit" + } + } + }, + "traits": { + "smithy.api#documentation": "Gets the VpcLinks collection under the caller's account in a selected region.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#ImportApiKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#ImportApiKeysRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#ApiKeyIds" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Import API keys from an external source, such as a CSV-formatted file.
", + "smithy.api#http": { + "method": "POST", + "uri": "/apikeys?mode=import", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#ImportApiKeysRequest": { + "type": "structure", + "members": { + "body": { + "target": "com.amazonaws.apigateway#Blob", + "traits": { + "smithy.api#documentation": "The payload of the POST request to import API keys. For the payload format, see API Key File Format.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.apigateway#ApiKeysFormat", + "traits": { + "smithy.api#documentation": "A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.
A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.
The POST request to import API keys from an external source, such as a CSV-formatted file.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#ImportDocumentationParts": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#ImportDocumentationPartsRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DocumentationPartIds" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Imports documentation parts
", + "smithy.api#http": { + "method": "PUT", + "uri": "/restapis/{restApiId}/documentation/parts", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#ImportDocumentationPartsRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "mode": { + "target": "com.amazonaws.apigateway#PutMode", + "traits": { + "smithy.api#documentation": "A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. The default value is merge.
A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Import documentation parts from an external (e.g., OpenAPI) definition file.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#ImportRestApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#ImportRestApiRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#RestApi" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "A feature of the API Gateway control service for creating a new API from an external API definition file.
", + "smithy.api#http": { + "method": "POST", + "uri": "/restapis?mode=import", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#ImportRestApiRequest": { + "type": "structure", + "members": { + "failOnWarnings": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A query parameter to indicate whether to rollback the API creation (true) or not (false)\n when a warning is encountered. The default value is false.
A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.
\n To exclude DocumentationParts from the import, set parameters as ignore=documentation.
To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.
To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.
The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A POST request to import an API to API Gateway using an input of an API definition file.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.apigateway#Integration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.apigateway#IntegrationType", + "traits": { + "smithy.api#documentation": "Specifies an API method integration type. The valid value is one of the following:
\nFor the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
Specifies the integration's HTTP method type. For the Type property, if you specify MOCK, this property is optional. For Lambda integrations, you must set the integration method to POST. For all other types, you must specify this property.
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
\nFor HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL\n\t according to the RFC-3986 specification for standard integrations. If connectionType is VPC_LINK specify the Network Load Balancer DNS name.\n For AWS or AWS_PROXY integrations, the URI is of\n the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}.\n Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the\n integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by\n certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service\n action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing\n {service_api} refers to a supported action {name} plus any required input parameters.\n Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api\n refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services \n service, if applicable. For example, for integration with the S3 API of GetObject, the uri can\n be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or\n arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}\n
The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\\*:user/\\*. To use resource-based permissions on supported Amazon Web Services services, specify null.
A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
" + } + }, + "passthroughBehavior": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies how the method request body of an unmapped content type will be passed through\n the integration request to the back end without transformation. A content type is unmapped if\n no mapping template is defined in the integration or the content type does not match any of\n the mapped content types, as specified in requestTemplates. The valid value is one of the\n following: WHEN_NO_MATCH: passes the method request body through the integration request to\n the back end without transformation when the method request content type does not match any\n content type associated with the mapping templates defined in the integration request.\n WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back\n end without transformation when no mapping template is defined in the integration request. If\n a template is defined when this option is selected, the method request of an unmapped\n content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER: rejects\n the method request with an HTTP 415 Unsupported Media Type response when either the method\n request content type does not match any content type associated with the mapping templates\n defined in the integration request or no mapping template is defined in the integration\n request.
Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.
" + } + }, + "cacheNamespace": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
Specifies the integration's responses.
" + } + }, + "tlsConfig": { + "target": "com.amazonaws.apigateway#TlsConfig", + "traits": { + "smithy.api#documentation": "Specifies the TLS configuration for an integration.
" + } + }, + "responseTransferMode": { + "target": "com.amazonaws.apigateway#ResponseTransferMode", + "traits": { + "smithy.api#documentation": "\nThe response transfer mode of the integration.\n
" + } + }, + "integrationTarget": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\nThe ALB or NLB listener to send the request to. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
Specifies the status code that is used to map the integration response to an existing MethodResponse.
" + } + }, + "selectionPattern": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\\n) character in such cases. If the back end is an Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched.
A key-value map specifying response parameters that are passed to the method response from the back end.\n The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" + } + }, + "contentHandling": { + "target": "com.amazonaws.apigateway#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
" + } + }, + "com.amazonaws.apigateway#IntegrationType": { + "type": "enum", + "members": { + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + }, + "AWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS" + } + }, + "MOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MOCK" + } + }, + "HTTP_PROXY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_PROXY" + } + }, + "AWS_PROXY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_PROXY" + } + } + }, + "traits": { + "smithy.api#documentation": "The integration type. The valid value is HTTP for integrating an API method with an HTTP backend; AWS with any Amazon Web Services service endpoints; MOCK for testing without actually invoking the backend; HTTP_PROXY for integrating with the HTTP proxy integration; AWS_PROXY for integrating with the Lambda proxy integration.
The request exceeded the rate limit. Retry after the specified time period.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.apigateway#ListOfARNs": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#ProviderARN" + } + }, + "com.amazonaws.apigateway#ListOfApiKey": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#ApiKey" + } + }, + "com.amazonaws.apigateway#ListOfApiStage": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#ApiStage" + } + }, + "com.amazonaws.apigateway#ListOfAuthorizer": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#Authorizer" + } + }, + "com.amazonaws.apigateway#ListOfBasePathMapping": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#BasePathMapping" + } + }, + "com.amazonaws.apigateway#ListOfClientCertificate": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#ClientCertificate" + } + }, + "com.amazonaws.apigateway#ListOfDeployment": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#Deployment" + } + }, + "com.amazonaws.apigateway#ListOfDocumentationPart": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#DocumentationPart" + } + }, + "com.amazonaws.apigateway#ListOfDocumentationVersion": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#DocumentationVersion" + } + }, + "com.amazonaws.apigateway#ListOfDomainName": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#DomainName" + } + }, + "com.amazonaws.apigateway#ListOfDomainNameAccessAssociation": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#DomainNameAccessAssociation" + } + }, + "com.amazonaws.apigateway#ListOfEndpointType": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#EndpointType" + } + }, + "com.amazonaws.apigateway#ListOfGatewayResponse": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#GatewayResponse" + } + }, + "com.amazonaws.apigateway#ListOfLong": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#Long" + } + }, + "com.amazonaws.apigateway#ListOfModel": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#Model" + } + }, + "com.amazonaws.apigateway#ListOfPatchOperation": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#PatchOperation" + }, + "traits": { + "smithy.api#documentation": "A list of operations describing the updates to apply to the specified resource. The patches are applied\n in the order specified in the list.
" + } + }, + "com.amazonaws.apigateway#ListOfRequestValidator": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#RequestValidator" + } + }, + "com.amazonaws.apigateway#ListOfResource": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#Resource" + } + }, + "com.amazonaws.apigateway#ListOfRestApi": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#RestApi" + } + }, + "com.amazonaws.apigateway#ListOfSdkConfigurationProperty": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#SdkConfigurationProperty" + } + }, + "com.amazonaws.apigateway#ListOfSdkType": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#SdkType" + } + }, + "com.amazonaws.apigateway#ListOfStage": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#Stage" + } + }, + "com.amazonaws.apigateway#ListOfStageKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#StageKey" + } + }, + "com.amazonaws.apigateway#ListOfString": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#String" + } + }, + "com.amazonaws.apigateway#ListOfUsage": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#ListOfLong" + } + }, + "com.amazonaws.apigateway#ListOfUsagePlan": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#UsagePlan" + } + }, + "com.amazonaws.apigateway#ListOfUsagePlanKey": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#UsagePlanKey" + } + }, + "com.amazonaws.apigateway#ListOfVpcLink": { + "type": "list", + "member": { + "target": "com.amazonaws.apigateway#VpcLink" + } + }, + "com.amazonaws.apigateway#LocationStatusType": { + "type": "enum", + "members": { + "DOCUMENTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENTED" + } + }, + "UNDOCUMENTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNDOCUMENTED" + } + } + } + }, + "com.amazonaws.apigateway#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.apigateway#MapOfApiStageThrottleSettings": { + "type": "map", + "key": { + "target": "com.amazonaws.apigateway#String" + }, + "value": { + "target": "com.amazonaws.apigateway#ThrottleSettings" + } + }, + "com.amazonaws.apigateway#MapOfIntegrationResponse": { + "type": "map", + "key": { + "target": "com.amazonaws.apigateway#String" + }, + "value": { + "target": "com.amazonaws.apigateway#IntegrationResponse" + } + }, + "com.amazonaws.apigateway#MapOfKeyUsages": { + "type": "map", + "key": { + "target": "com.amazonaws.apigateway#String" + }, + "value": { + "target": "com.amazonaws.apigateway#ListOfUsage" + } + }, + "com.amazonaws.apigateway#MapOfMethod": { + "type": "map", + "key": { + "target": "com.amazonaws.apigateway#String" + }, + "value": { + "target": "com.amazonaws.apigateway#Method" + } + }, + "com.amazonaws.apigateway#MapOfMethodResponse": { + "type": "map", + "key": { + "target": "com.amazonaws.apigateway#String" + }, + "value": { + "target": "com.amazonaws.apigateway#MethodResponse" + } + }, + "com.amazonaws.apigateway#MapOfMethodSettings": { + "type": "map", + "key": { + "target": "com.amazonaws.apigateway#String" + }, + "value": { + "target": "com.amazonaws.apigateway#MethodSetting" + } + }, + "com.amazonaws.apigateway#MapOfMethodSnapshot": { + "type": "map", + "key": { + "target": "com.amazonaws.apigateway#String" + }, + "value": { + "target": "com.amazonaws.apigateway#MethodSnapshot" + } + }, + "com.amazonaws.apigateway#MapOfStringToBoolean": { + "type": "map", + "key": { + "target": "com.amazonaws.apigateway#String" + }, + "value": { + "target": "com.amazonaws.apigateway#NullableBoolean" + } + }, + "com.amazonaws.apigateway#MapOfStringToList": { + "type": "map", + "key": { + "target": "com.amazonaws.apigateway#String" + }, + "value": { + "target": "com.amazonaws.apigateway#ListOfString" + } + }, + "com.amazonaws.apigateway#MapOfStringToString": { + "type": "map", + "key": { + "target": "com.amazonaws.apigateway#String" + }, + "value": { + "target": "com.amazonaws.apigateway#String" + } + }, + "com.amazonaws.apigateway#Method": { + "type": "structure", + "members": { + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The method's HTTP verb.
" + } + }, + "authorizationType": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
" + } + }, + "requestValidatorId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of a RequestValidator for request validation.
" + } + }, + "operationName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
" + } + }, + "methodResponses": { + "target": "com.amazonaws.apigateway#MapOfMethodResponse", + "traits": { + "smithy.api#documentation": "Gets a method response associated with a given HTTP status code.
" + } + }, + "methodIntegration": { + "target": "com.amazonaws.apigateway#Integration", + "traits": { + "smithy.api#documentation": "Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
" + } + }, + "authorizationScopes": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
\n Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is\n integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes\n the client input that is passed to the back end through the integration request. A method response returns the output from\n the back end to the client through an integration response. A method request is embodied in a Method resource, whereas\n an integration request is embodied in an Integration resource. On the other hand, a method response is represented\n by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.\n
" + } + }, + "com.amazonaws.apigateway#MethodResponse": { + "type": "structure", + "members": { + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", + "traits": { + "smithy.api#documentation": "The method response's status code.
" + } + }, + "responseParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToBoolean", + "traits": { + "smithy.api#documentation": "A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
" + } + }, + "com.amazonaws.apigateway#MethodSetting": { + "type": "structure", + "members": { + "metricsEnabled": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether Amazon CloudWatch metrics are enabled for this method.
" + } + }, + "loggingLevel": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
" + } + }, + "throttlingBurstLimit": { + "target": "com.amazonaws.apigateway#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Specifies the throttling burst limit.
" + } + }, + "throttlingRateLimit": { + "target": "com.amazonaws.apigateway#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Specifies the throttling rate limit.
" + } + }, + "cachingEnabled": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
" + } + }, + "cacheTtlInSeconds": { + "target": "com.amazonaws.apigateway#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
" + } + }, + "cacheDataEncrypted": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the cached responses are encrypted.
" + } + }, + "requireAuthorizationForCacheControl": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether authorization is required for a cache invalidation request.
" + } + }, + "unauthorizedCacheControlHeaderStrategy": { + "target": "com.amazonaws.apigateway#UnauthorizedCacheControlHeaderStrategy", + "traits": { + "smithy.api#documentation": "Specifies how to handle unauthorized requests for cache invalidation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the method setting properties.
" + } + }, + "com.amazonaws.apigateway#MethodSnapshot": { + "type": "structure", + "members": { + "authorizationType": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
Specifies whether the method requires a valid ApiKey.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a summary of a Method resource, given a particular date and time.
" + } + }, + "com.amazonaws.apigateway#Model": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier for the model resource.
" + } + }, + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the model. Must be an alphanumeric string.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the model.
" + } + }, + "schema": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
The content-type for the model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the data structure of a method's request or response payload.
" + } + }, + "com.amazonaws.apigateway#Models": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfModel", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a collection of Model resources.
" + } + }, + "com.amazonaws.apigateway#MutualTlsAuthentication": { + "type": "structure", + "members": { + "truststoreUri": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example\n s3://bucket-name/key-name. The truststore can contain certificates from public or private\n certificate authorities. To update the truststore, upload a new version to S3, and then update\n your custom domain name to use the new version. To update the truststore, you must have\n permissions to access the S3 object.
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
" + } + }, + "truststoreWarnings": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A list of warnings that API Gateway returns while processing your truststore. Invalid\n certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able\n to access your API. To resolve warnings, upload a new truststore to S3, and then update you\n domain name to use the new version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway\n performs two-way authentication between the client and the server. Clients must present a\n trusted certificate to access your API.
" + } + }, + "com.amazonaws.apigateway#MutualTlsAuthenticationInput": { + "type": "structure", + "members": { + "truststoreUri": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example\n s3://bucket-name/key-name. The truststore can contain certificates from public or private\n certificate authorities. To update the truststore, upload a new version to S3, and then update\n your custom domain name to use the new version. To update the truststore, you must have\n permissions to access the S3 object.
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket
" + } + } + }, + "traits": { + "smithy.api#documentation": "The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway\n performs two-way authentication between the client and the server. Clients must present a\n trusted certificate to access your API.
" + } + }, + "com.amazonaws.apigateway#NotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.apigateway#String" + } + }, + "traits": { + "smithy.api#documentation": "The requested resource is not found. Make sure that the request URI is correct.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.apigateway#NullableBoolean": { + "type": "boolean" + }, + "com.amazonaws.apigateway#NullableInteger": { + "type": "integer" + }, + "com.amazonaws.apigateway#Op": { + "type": "enum", + "members": { + "add": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "add" + } + }, + "remove": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "remove" + } + }, + "replace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "replace" + } + }, + "move": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "move" + } + }, + "copy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "copy" + } + }, + "test": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "test" + } + } + } + }, + "com.amazonaws.apigateway#PatchOperation": { + "type": "structure", + "members": { + "op": { + "target": "com.amazonaws.apigateway#Op", + "traits": { + "smithy.api#documentation": "An update operation to be performed with this PATCH request. The valid value can be\n add, remove, replace or copy. Not all valid operations are supported for a given\n resource. Support of the operations depends on specific operational contexts. Attempts\n to apply an unsupported operation on a resource will return an error message..
" + } + }, + "path": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The op operation's target, as identified by a JSON Pointer value that references a\n location within the targeted resource. For example, if the target resource has an\n updateable property of {\"name\":\"value\"}, the path for this property is /name. If the\n name property value is a JSON object (e.g., {\"name\": {\"child/name\": \"child-value\"}}),\n the path for the child/name property will be /name/child~1name. Any slash (\"/\")\n character appearing in path names must be escaped with \"~1\", as shown in the example\n above. Each op operation can have only one path associated with it.
" + } + }, + "value": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The new target value of the update operation. It is applicable for the add or replace\n operation. When using AWS CLI to update a property of a JSON value, enclose the JSON\n object with a pair of single quotes in a Linux shell, e.g., '{\"a\": ...}'.
" + } + }, + "from": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The copy update operation's source as identified by a JSON-Pointer value referencing\n the location within the targeted resource to copy the value from. For example, to\n promote a canary deployment, you copy the canary deployment ID to the affiliated\n deployment ID by calling a PATCH request on a Stage resource with \"op\":\"copy\",\n \"from\":\"/canarySettings/deploymentId\" and \"path\":\"/deploymentId\".
" + } + } + }, + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + }, + "com.amazonaws.apigateway#PathToMapOfMethodSnapshot": { + "type": "map", + "key": { + "target": "com.amazonaws.apigateway#String" + }, + "value": { + "target": "com.amazonaws.apigateway#MapOfMethodSnapshot" + } + }, + "com.amazonaws.apigateway#ProviderARN": { + "type": "string" + }, + "com.amazonaws.apigateway#PutGatewayResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#PutGatewayResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#GatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/restapis/{restApiId}/gatewayresponses/{responseType}", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#PutGatewayResponseRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "responseType": { + "target": "com.amazonaws.apigateway#GatewayResponseType", + "traits": { + "smithy.api#documentation": "The response type of the associated GatewayResponse
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status code of the GatewayResponse.
" + } + }, + "responseParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
" + } + }, + "responseTemplates": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#PutIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#PutIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Integration" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Sets up a method's integration.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/integration", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#PutIntegrationRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a put integration request's resource ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies the HTTP method for the integration.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "requestHttpMethod", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.apigateway#IntegrationType", + "traits": { + "smithy.api#documentation": "Specifies a put integration input's type.
", + "smithy.api#required": {} + } + }, + "integrationHttpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The HTTP method for the integration.
", + "smithy.api#jsonName": "httpMethod" + } + }, + "uri": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or\n HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the\n RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK,\n or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the\n URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form\n arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here,\n {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated\n Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services\n service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API,\n using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to\n a supported action {name} plus any required input parameters. Alternatively, path can be used\n for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services\n service resource, including the region of the integrated Amazon Web Services service, if applicable. For\n example, for integration with the S3 API of GetObject, the uri can be either\n arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or\n arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.
The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type.
Specifies whether credentials are required for a put integration.
" + } + }, + "requestParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
" + } + }, + "passthroughBehavior": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.\n
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.
" + } + }, + "tlsConfig": { + "target": "com.amazonaws.apigateway#TlsConfig" + }, + "responseTransferMode": { + "target": "com.amazonaws.apigateway#ResponseTransferMode", + "traits": { + "smithy.api#documentation": "\nThe response transfer mode of the integration.\n
" + } + }, + "integrationTarget": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\nThe ALB or NLB listener to send the request to.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Sets up a method's integration.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#PutIntegrationResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#PutIntegrationResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#IntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Represents a put integration.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/integration/responses/{statusCode}", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#PutIntegrationResponseRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a put integration response request's resource identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a put integration response request's HTTP method.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", + "traits": { + "smithy.api#documentation": "Specifies the status code that is used to map the integration response to an existing MethodResponse.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "selectionPattern": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies the selection pattern of a put integration response.
" + } + }, + "responseParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "A key-value map specifying response parameters that are passed to the method response from the back end.\n The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.
Specifies a put integration response's templates.
" + } + }, + "contentHandling": { + "target": "com.amazonaws.apigateway#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a put integration response request.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#PutMethod": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#PutMethodRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Method" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Add a method to an existing Resource resource.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#PutMethodRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Resource identifier for the new Method resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies the method request's HTTP method type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "authorizationType": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.
" + } + }, + "apiKeyRequired": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the method required a valid ApiKey.
" + } + }, + "operationName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.
Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
" + } + }, + "requestValidatorId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of a RequestValidator for validating the method request.
" + } + }, + "authorizationScopes": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
Request to add a method to an existing Resource resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#PutMethodResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#PutMethodResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#MethodResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Adds a MethodResponse to an existing Method resource.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/responses/{statusCode}", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#PutMethodResponseRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Resource identifier for the Method resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The HTTP verb of the Method resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", + "traits": { + "smithy.api#documentation": "The method response's status code.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "responseParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToBoolean", + "traits": { + "smithy.api#documentation": "A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Request to add a MethodResponse to an existing Method resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#PutMode": { + "type": "enum", + "members": { + "Merge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "merge" + } + }, + "Overwrite": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "overwrite" + } + } + } + }, + "com.amazonaws.apigateway#PutRestApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#PutRestApiRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#RestApi" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "A feature of the API Gateway control service for updating an existing API with an input of external API definitions.\n The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/restapis/{restApiId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#PutRestApiRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "mode": { + "target": "com.amazonaws.apigateway#PutMode", + "traits": { + "smithy.api#documentation": "The mode query parameter to specify the update mode. Valid values are \"merge\" and \"overwrite\". By default,\n the update mode is \"merge\".
A query parameter to indicate whether to rollback the API update (true) or not (false)\n when a warning is encountered. The default value is false.
Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A PUT request to update an existing API, with external API definitions specified as the request body.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#QuotaPeriodType": { + "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.apigateway#QuotaSettings": { + "type": "structure", + "members": { + "limit": { + "target": "com.amazonaws.apigateway#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The target maximum number of requests that can be made in a given time period.
" + } + }, + "offset": { + "target": "com.amazonaws.apigateway#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of requests subtracted from the given limit in the initial time period.
" + } + }, + "period": { + "target": "com.amazonaws.apigateway#QuotaPeriodType", + "traits": { + "smithy.api#documentation": "The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\".
" + } + } + }, + "traits": { + "smithy.api#documentation": "Quotas configured for a usage plan.
" + } + }, + "com.amazonaws.apigateway#RejectDomainNameAccessAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#RejectDomainNameAccessAssociationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Rejects a domain name access association with a private custom domain name.
\nTo reject a domain name access association with an access association source in another AWS account, use this operation. To remove a domain name access association with an access association source in your own account, use the DeleteDomainNameAccessAssociation operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/rejectdomainnameaccessassociations", + "code": 202 + } + } + }, + "com.amazonaws.apigateway#RejectDomainNameAccessAssociationRequest": { + "type": "structure", + "members": { + "domainNameAccessAssociationArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ARN of the domain name access association resource.\n
", + "smithy.api#httpQuery": "domainNameAccessAssociationArn", + "smithy.api#required": {} + } + }, + "domainNameArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\nThe ARN of the domain name.\n
", + "smithy.api#httpQuery": "domainNameArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#RequestValidator": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of this RequestValidator.
" + } + }, + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of this RequestValidator
" + } + }, + "validateRequestBody": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
" + } + }, + "validateRequestParameters": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean flag to indicate whether to validate request parameters (true) or not (false).
A set of validation rules for incoming Method requests.
" + } + }, + "com.amazonaws.apigateway#RequestValidators": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfRequestValidator", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of RequestValidator resources of a given RestApi.
" + } + }, + "com.amazonaws.apigateway#Resource": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The resource's identifier.
" + } + }, + "parentId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The parent resource's identifier.
" + } + }, + "pathPart": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The last path segment for this resource.
" + } + }, + "path": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The full path for this resource.
" + } + }, + "resourceMethods": { + "target": "com.amazonaws.apigateway#MapOfMethod", + "traits": { + "smithy.api#documentation": "Gets an API resource's method of a given HTTP verb.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an API resource.
" + } + }, + "com.amazonaws.apigateway#ResourceOwner": { + "type": "enum", + "members": { + "SELF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELF" + } + }, + "OTHER_ACCOUNTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER_ACCOUNTS" + } + } + } + }, + "com.amazonaws.apigateway#Resources": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfResource", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a collection of Resource resources.
" + } + }, + "com.amazonaws.apigateway#ResponseTransferMode": { + "type": "enum", + "members": { + "BUFFERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUFFERED" + } + }, + "STREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAM" + } + } + } + }, + "com.amazonaws.apigateway#RestApi": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The API's identifier. This identifier is unique across all of your APIs in API Gateway.
" + } + }, + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The API's name.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The API's description.
" + } + }, + "createdDate": { + "target": "com.amazonaws.apigateway#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the API was created.
" + } + }, + "version": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A version identifier for the API.
" + } + }, + "warnings": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "The warning messages reported when failonwarnings is turned on during API import.
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
" + } + }, + "minimumCompressionSize": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
" + } + }, + "apiKeySource": { + "target": "com.amazonaws.apigateway#ApiKeySourceType", + "traits": { + "smithy.api#documentation": "The source of the API key for metering requests according to a usage plan. Valid values\n are: >HEADER to read the API key from the X-API-Key header of a\n request. AUTHORIZER to read the API key from the UsageIdentifierKey\n from a custom authorizer.
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.
" + } + }, + "policy": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The collection of tags. Each tag element is associated with a given resource.
" + } + }, + "disableExecuteApiEndpoint": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether clients can invoke your API by using the default execute-api endpoint.\n By default, clients can invoke your API with the default\n https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a\n custom domain name to invoke your API, disable the default endpoint.
The API's root resource ID.
" + } + }, + "securityPolicy": { + "target": "com.amazonaws.apigateway#SecurityPolicy", + "traits": { + "smithy.api#documentation": "\nThe Transport Layer Security (TLS) version + cipher suite for this RestApi. \n
" + } + }, + "endpointAccessMode": { + "target": "com.amazonaws.apigateway#EndpointAccessMode", + "traits": { + "smithy.api#documentation": "\nThe endpoint access mode of the RestApi.\n
" + } + }, + "apiStatus": { + "target": "com.amazonaws.apigateway#ApiStatus", + "traits": { + "smithy.api#documentation": "The ApiStatus of the RestApi.\n
" + } + }, + "apiStatusMessage": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\nThe status message of the RestApi. When the status message is UPDATING you can still invoke it. \n
Represents a REST API.
" + } + }, + "com.amazonaws.apigateway#RestApis": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfRestApi", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.
" + } + }, + "com.amazonaws.apigateway#RoutingMode": { + "type": "enum", + "members": { + "BASE_PATH_MAPPING_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASE_PATH_MAPPING_ONLY" + } + }, + "ROUTING_RULE_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROUTING_RULE_ONLY" + } + }, + "ROUTING_RULE_THEN_BASE_PATH_MAPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROUTING_RULE_THEN_BASE_PATH_MAPPING" + } + } + } + }, + "com.amazonaws.apigateway#SdkConfigurationProperty": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of a an SdkType configuration property.
" + } + }, + "friendlyName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The user-friendly name of an SdkType configuration property.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of an SdkType configuration property.
" + } + }, + "required": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).
The default value of an SdkType configuration property.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A configuration property of an SDK type.
" + } + }, + "com.amazonaws.apigateway#SdkResponse": { + "type": "structure", + "members": { + "contentType": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The content-type header value in the HTTP response.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "contentDisposition": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The content-disposition header value in the HTTP response.
", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "body": { + "target": "com.amazonaws.apigateway#Blob", + "traits": { + "smithy.api#documentation": "The binary blob response to GetSdk, which contains the generated SDK.
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The binary blob response to GetSdk, which contains the generated SDK.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.apigateway#SdkType": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of an SdkType instance.
" + } + }, + "friendlyName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The user-friendly name of an SdkType instance.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of an SdkType.
" + } + }, + "configurationProperties": { + "target": "com.amazonaws.apigateway#ListOfSdkConfigurationProperty", + "traits": { + "smithy.api#documentation": "A list of configuration properties of an SdkType.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A type of SDK that API Gateway can generate.
" + } + }, + "com.amazonaws.apigateway#SdkTypes": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfSdkType", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of SdkType instances.
" + } + }, + "com.amazonaws.apigateway#SecurityPolicy": { + "type": "enum", + "members": { + "TLS_1_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TLS_1_0" + } + }, + "TLS_1_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TLS_1_2" + } + }, + "SecurityPolicy_TLS13_1_3_2025_09": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityPolicy_TLS13_1_3_2025_09" + } + }, + "SecurityPolicy_TLS13_1_3_FIPS_2025_09": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityPolicy_TLS13_1_3_FIPS_2025_09" + } + }, + "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09" + } + }, + "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09" + } + }, + "SecurityPolicy_TLS13_1_2_FIPS_PFS_PQ_2025_09": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityPolicy_TLS13_1_2_FIPS_PFS_PQ_2025_09" + } + }, + "SecurityPolicy_TLS13_1_2_PQ_2025_09": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityPolicy_TLS13_1_2_PQ_2025_09" + } + }, + "SecurityPolicy_TLS13_1_2_2021_06": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityPolicy_TLS13_1_2_2021_06" + } + }, + "SecurityPolicy_TLS13_2025_EDGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityPolicy_TLS13_2025_EDGE" + } + }, + "SecurityPolicy_TLS12_PFS_2025_EDGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityPolicy_TLS12_PFS_2025_EDGE" + } + }, + "SecurityPolicy_TLS12_2018_EDGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityPolicy_TLS12_2018_EDGE" + } + } + } + }, + "com.amazonaws.apigateway#ServiceUnavailableException": { + "type": "structure", + "members": { + "retryAfterSeconds": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#httpHeader": "Retry-After" + } + }, + "message": { + "target": "com.amazonaws.apigateway#String" + } + }, + "traits": { + "smithy.api#documentation": "The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.apigateway#Stage": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the Deployment that the stage points to.
" + } + }, + "clientCertificateId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of a client certificate for an API stage.
" + } + }, + "stageName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The stage's description.
" + } + }, + "cacheClusterEnabled": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
" + } + }, + "cacheClusterStatus": { + "target": "com.amazonaws.apigateway#CacheClusterStatus", + "traits": { + "smithy.api#documentation": "The status of the cache cluster for the stage, if enabled.
" + } + }, + "methodSettings": { + "target": "com.amazonaws.apigateway#MapOfMethodSettings", + "traits": { + "smithy.api#documentation": "A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\\*/\\* for overriding all methods in the stage.
A map that defines the stage variables for a Stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
The version of the associated API documentation.
" + } + }, + "accessLogSettings": { + "target": "com.amazonaws.apigateway#AccessLogSettings", + "traits": { + "smithy.api#documentation": "Settings for logging access in this stage.
" + } + }, + "canarySettings": { + "target": "com.amazonaws.apigateway#CanarySettings", + "traits": { + "smithy.api#documentation": "Settings for the canary deployment in this stage.
" + } + }, + "tracingEnabled": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether active tracing with X-ray is enabled for the Stage.
" + } + }, + "webAclArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ARN of the WebAcl associated with the Stage.
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The collection of tags. Each tag element is associated with a given resource.
" + } + }, + "createdDate": { + "target": "com.amazonaws.apigateway#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the stage was created.
" + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.apigateway#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the stage last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a unique identifier for a version of a deployed RestApi that is callable by users.
" + } + }, + "com.amazonaws.apigateway#StageKey": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
" + } + }, + "stageName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The stage name associated with the stage key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to a unique stage identified in the format {restApiId}/{stage}.
The current page of elements from this collection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of Stage resources that are associated with the ApiKey resource.
" + } + }, + "com.amazonaws.apigateway#StatusCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "The status code.
", + "smithy.api#pattern": "^[1-5]\\d\\d$" + } + }, + "com.amazonaws.apigateway#String": { + "type": "string" + }, + "com.amazonaws.apigateway#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Adds or updates a tag on a given resource.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/tags/{resourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.apigateway#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ARN of a resource that can be tagged.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
Adds or updates a tag on a given resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#Tags": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The collection of tags. Each tag element is associated with a given resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of tags. Each tag element is associated with a given resource.
" + } + }, + "com.amazonaws.apigateway#Template": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Apache Velocity Template Language (VTL) template content used for the template resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a mapping template used to transform a payload.
" + } + }, + "com.amazonaws.apigateway#TestInvokeAuthorizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#TestInvokeAuthorizerRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#TestInvokeAuthorizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
", + "smithy.api#http": { + "method": "POST", + "uri": "/restapis/{restApiId}/authorizers/{authorizerId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#TestInvokeAuthorizerRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "authorizerId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a test invoke authorizer request's Authorizer ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "headers": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
" + } + }, + "multiValueHeaders": { + "target": "com.amazonaws.apigateway#MapOfStringToList", + "traits": { + "smithy.api#documentation": "The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
" + } + }, + "pathWithQueryString": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
" + } + }, + "body": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The simulated request body of an incoming invocation request.
" + } + }, + "stageVariables": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "A key-value map of stage variables to simulate an invocation on a deployed Stage.
" + } + }, + "additionalContext": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "A key-value map of additional context variables.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Make a request to simulate the invocation of an Authorizer.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#TestInvokeAuthorizerResponse": { + "type": "structure", + "members": { + "clientStatus": { + "target": "com.amazonaws.apigateway#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
" + } + }, + "log": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The API Gateway execution log for the test authorizer request.
" + } + }, + "latency": { + "target": "com.amazonaws.apigateway#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The execution latency, in ms, of the test authorizer request.
" + } + }, + "principalId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The principal identity returned by the Authorizer
" + } + }, + "policy": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The JSON policy document returned by the Authorizer
" + } + }, + "authorization": { + "target": "com.amazonaws.apigateway#MapOfStringToList", + "traits": { + "smithy.api#documentation": "The authorization response.
" + } + }, + "claims": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the response of the test invoke request for a custom Authorizer
", + "smithy.api#output": {} + } + }, + "com.amazonaws.apigateway#TestInvokeMethod": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#TestInvokeMethodRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#TestInvokeMethodResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
", + "smithy.api#http": { + "method": "POST", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#TestInvokeMethodRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a test invoke method request's resource ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies a test invoke method request's HTTP method.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "pathWithQueryString": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
" + } + }, + "body": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The simulated request body of an incoming invocation request.
" + } + }, + "headers": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "A key-value map of headers to simulate an incoming invocation request.
" + } + }, + "multiValueHeaders": { + "target": "com.amazonaws.apigateway#MapOfStringToList", + "traits": { + "smithy.api#documentation": "The headers as a map from string to list of values to simulate an incoming invocation request.
" + } + }, + "clientCertificateId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
" + } + }, + "stageVariables": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "A key-value map of stage variables to simulate an invocation on a deployed Stage.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Make a request to simulate the invocation of a Method.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#TestInvokeMethodResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.apigateway#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status code.
" + } + }, + "body": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The body of the HTTP response.
" + } + }, + "headers": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The headers of the HTTP response.
" + } + }, + "multiValueHeaders": { + "target": "com.amazonaws.apigateway#MapOfStringToList", + "traits": { + "smithy.api#documentation": "The headers of the HTTP response as a map from string to list of values.
" + } + }, + "log": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The API Gateway execution log for the test invoke request.
" + } + }, + "latency": { + "target": "com.amazonaws.apigateway#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The execution latency, in ms, of the test invoke request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the response of the test invoke request in the HTTP method.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.apigateway#ThrottleSettings": { + "type": "structure", + "members": { + "burstLimit": { + "target": "com.amazonaws.apigateway#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
" + } + }, + "rateLimit": { + "target": "com.amazonaws.apigateway#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The API target request rate limit.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The API request rate limits.
" + } + }, + "com.amazonaws.apigateway#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.apigateway#TlsConfig": { + "type": "structure", + "members": { + "insecureSkipVerification": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is\n issued by a supported certificate authority. This isn’t recommended, but it enables you to\n use certificates that are signed by private certificate authorities, or certificates\n that are self-signed. If enabled, API Gateway still performs basic certificate\n validation, which includes checking the certificate's expiration date, hostname, and\n presence of a root certificate authority. Supported only for HTTP and\n HTTP_PROXY integrations.
Enabling insecureSkipVerification isn't recommended, especially for integrations with public\n HTTPS endpoints. If you enable insecureSkipVerification, you increase the risk of man-in-the-middle attacks.
Specifies the TLS configuration for an integration.
" + } + }, + "com.amazonaws.apigateway#TooManyRequestsException": { + "type": "structure", + "members": { + "retryAfterSeconds": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#httpHeader": "Retry-After" + } + }, + "message": { + "target": "com.amazonaws.apigateway#String" + } + }, + "traits": { + "smithy.api#documentation": "The request has reached its throttling limit. Retry after the specified time period.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.apigateway#UnauthorizedCacheControlHeaderStrategy": { + "type": "enum", + "members": { + "FAIL_WITH_403": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAIL_WITH_403" + } + }, + "SUCCEED_WITH_RESPONSE_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEED_WITH_RESPONSE_HEADER" + } + }, + "SUCCEED_WITHOUT_RESPONSE_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEED_WITHOUT_RESPONSE_HEADER" + } + } + } + }, + "com.amazonaws.apigateway#UnauthorizedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.apigateway#String" + } + }, + "traits": { + "smithy.api#documentation": "The request is denied because the caller has insufficient permissions.
", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.apigateway#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Removes a tag from a given resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.apigateway#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ARN of a resource that can be tagged.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "The Tag keys to delete.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Removes a tag from a given resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateAccountRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Account" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Changes information about the current Account resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/account", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateAccountRequest": { + "type": "structure", + "members": { + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Requests API Gateway to change information about the current Account resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateApiKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateApiKeyRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#ApiKey" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Changes information about an ApiKey resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/apikeys/{apiKey}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateApiKeyRequest": { + "type": "structure", + "members": { + "apiKey": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the ApiKey resource to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to change information about an ApiKey resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateAuthorizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateAuthorizerRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Authorizer" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Authorizer resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/authorizers/{authorizerId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateAuthorizerRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "authorizerId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the Authorizer resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Request to update an existing Authorizer resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateBasePathMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateBasePathMappingRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#BasePathMapping" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Changes information about the BasePathMapping resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/domainnames/{domainName}/basepathmappings/{basePath}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateBasePathMappingRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The domain name of the BasePathMapping resource to change.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "domainNameId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\n The identifier for the domain name resource. Supported only for private custom domain names.\n
", + "smithy.api#httpQuery": "domainNameId" + } + }, + "basePath": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The base path of the BasePathMapping resource to change.
\nTo specify an empty base path, set this parameter to '(none)'.
For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to change information about the BasePathMapping resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateClientCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateClientCertificateRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#ClientCertificate" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Changes information about an ClientCertificate resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/clientcertificates/{clientCertificateId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateClientCertificateRequest": { + "type": "structure", + "members": { + "clientCertificateId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the ClientCertificate resource to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to change information about an ClientCertificate resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Deployment" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Changes information about a Deployment resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/deployments/{deploymentId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateDeploymentRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "deploymentId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The replacement identifier for the Deployment resource to change information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Requests API Gateway to change information about a Deployment resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateDocumentationPart": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateDocumentationPartRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DocumentationPart" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a documentation part.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/documentation/parts/{documentationPartId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateDocumentationPartRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documentationPartId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the to-be-updated documentation part.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Updates an existing documentation part of a given API.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateDocumentationVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateDocumentationVersionRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DocumentationVersion" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a documentation version.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/documentation/versions/{documentationVersion}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateDocumentationVersionRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documentationVersion": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The version identifier of the to-be-updated documentation version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Updates an existing documentation version of an API.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateDomainNameRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#DomainName" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Changes information about the DomainName resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/domainnames/{domainName}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateDomainNameRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the DomainName resource to be changed.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "domainNameId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "\n The identifier for the domain name resource. Supported only for private custom domain names.\n
", + "smithy.api#httpQuery": "domainNameId" + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to change information about the DomainName resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateGatewayResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateGatewayResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#GatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a GatewayResponse of a specified response type on the given RestApi.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/gatewayresponses/{responseType}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateGatewayResponseRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "responseType": { + "target": "com.amazonaws.apigateway#GatewayResponseType", + "traits": { + "smithy.api#documentation": "The response type of the associated GatewayResponse.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Updates a GatewayResponse of a specified response type on the given RestApi.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Integration" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Represents an update integration.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/integration", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateIntegrationRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Represents an update integration request's resource identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Represents an update integration request's HTTP method.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an update integration request.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateIntegrationResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateIntegrationResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#IntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Represents an update integration response.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/integration/responses/{statusCode}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateIntegrationResponseRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies an update integration response request's resource identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "Specifies an update integration response request's HTTP method.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", + "traits": { + "smithy.api#documentation": "Specifies an update integration response request's status code.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an update integration response request.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateMethod": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateMethodRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Method" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Method resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateMethodRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Resource identifier for the Method resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The HTTP verb of the Method resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Request to update an existing Method resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateMethodResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateMethodResponseRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#MethodResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing MethodResponse resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/responses/{statusCode}", + "code": 201 + } + } + }, + "com.amazonaws.apigateway#UpdateMethodResponseRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Resource identifier for the MethodResponse resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The HTTP verb of the Method resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", + "traits": { + "smithy.api#documentation": "The status code for the MethodResponse resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to update an existing MethodResponse resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateModelRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Model" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Changes information about a model. The maximum size of the model is 400 KB.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/models/{modelName}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateModelRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the model to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Request to update an existing model in an existing RestApi resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateRequestValidator": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateRequestValidatorRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#RequestValidator" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a RequestValidator of a given RestApi.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/requestvalidators/{requestValidatorId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateRequestValidatorRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "requestValidatorId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of RequestValidator to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Updates a RequestValidator of a given RestApi.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateResourceRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Resource" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Changes information about a Resource resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/resources/{resourceId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateResourceRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the Resource resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Request to change information about a Resource resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateRestApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateRestApiRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#RestApi" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Changes information about the specified API.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateRestApiRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Request to update an existing RestApi resource in your collection.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateStageRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Stage" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Changes information about a Stage resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/restapis/{restApiId}/stages/{stageName}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateStageRequest": { + "type": "structure", + "members": { + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "stageName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of the Stage resource to change information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Requests API Gateway to change information about a Stage resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateUsage": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateUsageRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#Usage" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/usageplans/{usagePlanId}/keys/{keyId}/usage", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateUsagePlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateUsagePlanRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#UsagePlan" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a usage plan of a given plan Id.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/usageplans/{usagePlanId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateUsagePlanRequest": { + "type": "structure", + "members": { + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Id of the to-be-updated usage plan.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The PATCH request to update a usage plan of a given plan Id.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateUsageRequest": { + "type": "structure", + "members": { + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Id of the usage plan associated with the usage data.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "keyId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#UpdateVpcLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigateway#UpdateVpcLinkRequest" + }, + "output": { + "target": "com.amazonaws.apigateway#VpcLink" + }, + "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, + { + "target": "com.amazonaws.apigateway#TooManyRequestsException" + }, + { + "target": "com.amazonaws.apigateway#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing VpcLink of a specified identifier.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/vpclinks/{vpcLinkId}", + "code": 200 + } + } + }, + "com.amazonaws.apigateway#UpdateVpcLinkRequest": { + "type": "structure", + "members": { + "vpcLinkId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "patchOperations": { + "target": "com.amazonaws.apigateway#ListOfPatchOperation", + "traits": { + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Updates an existing VpcLink of a specified identifier.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.apigateway#Usage": { + "type": "structure", + "members": { + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The plan Id associated with this usage data.
" + } + }, + "startDate": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The starting date of the usage data.
" + } + }, + "endDate": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The ending date of the usage data.
" + } + }, + "items": { + "target": "com.amazonaws.apigateway#MapOfKeyUsages", + "traits": { + "smithy.api#documentation": "The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., \"values\" : { \"{api_key}\" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].
The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the usage data of a usage plan.
" + } + }, + "com.amazonaws.apigateway#UsagePlan": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of a UsagePlan resource.
" + } + }, + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of a usage plan.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of a usage plan.
" + } + }, + "apiStages": { + "target": "com.amazonaws.apigateway#ListOfApiStage", + "traits": { + "smithy.api#documentation": "The associated API stages of a usage plan.
" + } + }, + "throttle": { + "target": "com.amazonaws.apigateway#ThrottleSettings", + "traits": { + "smithy.api#documentation": "A map containing method level throttling information for API stage in a usage plan.
" + } + }, + "quota": { + "target": "com.amazonaws.apigateway#QuotaSettings", + "traits": { + "smithy.api#documentation": "The target maximum number of permitted requests per a given unit time interval.
" + } + }, + "productCode": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The collection of tags. Each tag element is associated with a given resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. \n In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. \n Consider using Amazon Web Services Budgets to monitor costs \n and WAF to manage API requests.
" + } + }, + "com.amazonaws.apigateway#UsagePlanKey": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The Id of a usage plan key.
" + } + }, + "type": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The type of a usage plan key. Currently, the valid key type is API_KEY.
The value of a usage plan key.
" + } + }, + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name of a usage plan key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a usage plan key to identify a plan customer.
" + } + }, + "com.amazonaws.apigateway#UsagePlanKeys": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfUsagePlanKey", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
" + } + }, + "com.amazonaws.apigateway#UsagePlans": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfUsagePlan", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a collection of usage plans for an AWS account.
" + } + }, + "com.amazonaws.apigateway#VpcLink": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
" + } + }, + "name": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The name used to label and identify the VPC link.
" + } + }, + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The description of the VPC link.
" + } + }, + "targetArns": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.
" + } + }, + "status": { + "target": "com.amazonaws.apigateway#VpcLinkStatus", + "traits": { + "smithy.api#documentation": "The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.
A description about the VPC link status.
" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The collection of tags. Each tag element is associated with a given resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
" + } + }, + "com.amazonaws.apigateway#VpcLinkStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.apigateway#VpcLinks": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.apigateway#ListOfVpcLink", + "traits": { + "smithy.api#documentation": "The current page of elements from this collection.
", + "smithy.api#jsonName": "item" + } + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "The current pagination position in the paged result set.
", + "smithy.api#httpQuery": "position" + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of VPC links under the caller's account in a region.
" + } + } + } +} diff --git a/codegen/aws-models/bedrock-agent-runtime.json b/codegen/aws-models/bedrock-agent-runtime.json new file mode 100644 index 0000000..ac18e23 --- /dev/null +++ b/codegen/aws-models/bedrock-agent-runtime.json @@ -0,0 +1,15811 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.bedrockagentruntime#APISchema": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagentruntime#S3Identifier", + "traits": { + "smithy.api#documentation": "Contains details about the S3 object containing the OpenAPI schema for the action group.
" + } + }, + "payload": { + "target": "com.amazonaws.bedrockagentruntime#Payload", + "traits": { + "smithy.api#documentation": "The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
" + } + }, + "com.amazonaws.bedrockagentruntime#AWSResourceARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagentruntime#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The request is denied because of missing access permissions. Check your permissions and retry your request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bedrockagentruntime#ActionGroupExecutor": { + "type": "union", + "members": { + "lambda": { + "target": "com.amazonaws.bedrockagentruntime#LambdaResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + }, + "customControl": { + "target": "com.amazonaws.bedrockagentruntime#CustomControlMethod", + "traits": { + "smithy.api#documentation": " To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.
Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" + } + }, + "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput": { + "type": "structure", + "members": { + "actionGroupName": { + "target": "com.amazonaws.bedrockagentruntime#ActionGroupName", + "traits": { + "smithy.api#documentation": "The name of the action group.
" + } + }, + "verb": { + "target": "com.amazonaws.bedrockagentruntime#Verb", + "traits": { + "smithy.api#documentation": "The API method being used, based off the action group.
" + } + }, + "apiPath": { + "target": "com.amazonaws.bedrockagentruntime#ApiPath", + "traits": { + "smithy.api#documentation": "The path to the API to call, based off the action group.
" + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagentruntime#Parameters", + "traits": { + "smithy.api#documentation": "The parameters in the Lambda input event.
" + } + }, + "requestBody": { + "target": "com.amazonaws.bedrockagentruntime#RequestBody", + "traits": { + "smithy.api#documentation": "The parameters in the request body for the Lambda input event.
" + } + }, + "function": { + "target": "com.amazonaws.bedrockagentruntime#Function", + "traits": { + "smithy.api#documentation": "The function in the action group to call.
" + } + }, + "executionType": { + "target": "com.amazonaws.bedrockagentruntime#ExecutionType", + "traits": { + "smithy.api#documentation": "How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.
" + } + }, + "invocationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.
Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagentruntime#ActionGroupInvocationOutput": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentruntime#ActionGroupOutputString", + "traits": { + "smithy.api#documentation": "The JSON-formatted string returned by the API invoked by the action group.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the action group output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the JSON-formatted string returned by the API invoked by the action group.
" + } + }, + "com.amazonaws.bedrockagentruntime#ActionGroupName": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ActionGroupOutputString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ActionGroupSignature": { + "type": "enum", + "members": { + "AMAZON_USERINPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON.UserInput" + } + }, + "AMAZON_CODEINTERPRETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON.CodeInterpreter" + } + }, + "ANTHROPIC_COMPUTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANTHROPIC.Computer" + } + }, + "ANTHROPIC_BASH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANTHROPIC.Bash" + } + }, + "ANTHROPIC_TEXTEDITOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANTHROPIC.TextEditor" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#ActionGroupSignatureParams": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "max": 100 + } + } + } + }, + "com.amazonaws.bedrockagentruntime#ActionInvocationType": { + "type": "enum", + "members": { + "RESULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESULT" + } + }, + "USER_CONFIRMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_CONFIRMATION" + } + }, + "USER_CONFIRMATION_AND_RESULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_CONFIRMATION_AND_RESULT" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFieldsKey" + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFieldsValue" + } + }, + "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFieldsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFieldsValue": { + "type": "document" + }, + "com.amazonaws.bedrockagentruntime#AgentActionGroup": { + "type": "structure", + "members": { + "actionGroupName": { + "target": "com.amazonaws.bedrockagentruntime#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the action group.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentruntime#ResourceDescription", + "traits": { + "smithy.api#documentation": "A description of the action group.
" + } + }, + "parentActionGroupSignature": { + "target": "com.amazonaws.bedrockagentruntime#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.
ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" + } + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagentruntime#APISchema", + "traits": { + "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" + } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagentruntime#FunctionSchema", + "traits": { + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + } + }, + "parentActionGroupSignatureParams": { + "target": "com.amazonaws.bedrockagentruntime#ActionGroupSignatureParams", + "traits": { + "smithy.api#documentation": "The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Contains details of the inline agent's action group.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgentActionGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgentActionGroup" + } + }, + "com.amazonaws.bedrockagentruntime#AgentAliasArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagentruntime#AgentAliasId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagentruntime#AgentCollaboration": { + "type": "enum", + "members": { + "SUPERVISOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPERVISOR" + } + }, + "SUPERVISOR_ROUTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPERVISOR_ROUTER" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#AgentCollaboratorInputPayload": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#PayloadType", + "traits": { + "smithy.api#documentation": "The input type.
" + } + }, + "text": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorPayloadString", + "traits": { + "smithy.api#documentation": "Input text.
" + } + }, + "returnControlResults": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlResults", + "traits": { + "smithy.api#documentation": "An action invocation result.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for an agent collaborator. The input can be text or an action invocation result.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgentCollaboratorInvocationInput": { + "type": "structure", + "members": { + "agentCollaboratorName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The collaborator's name.
" + } + }, + "agentCollaboratorAliasArn": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasArn", + "traits": { + "smithy.api#documentation": "The collaborator's alias ARN.
" + } + }, + "input": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorInputPayload", + "traits": { + "smithy.api#documentation": "Text or action invocation result input for the collaborator.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An agent collaborator invocation input.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgentCollaboratorInvocationOutput": { + "type": "structure", + "members": { + "agentCollaboratorName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The output's agent collaborator name.
" + } + }, + "agentCollaboratorAliasArn": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasArn", + "traits": { + "smithy.api#documentation": "The output's agent collaborator alias ARN.
" + } + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorOutputPayload", + "traits": { + "smithy.api#documentation": "The output's output.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the output from the agent collaborator.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Output from an agent collaborator.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgentCollaboratorOutputPayload": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#PayloadType", + "traits": { + "smithy.api#documentation": "The type of output.
" + } + }, + "text": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorPayloadString", + "traits": { + "smithy.api#documentation": "Text output.
" + } + }, + "returnControlPayload": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlPayload", + "traits": { + "smithy.api#documentation": "An action invocation result.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Output from an agent collaborator. The output can be text or an action invocation result.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgentCollaboratorPayloadString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#AgentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagentruntime#AgentTraces": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#TracePart" + } + }, + "com.amazonaws.bedrockagentruntime#AgentVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveAction": { + "type": "structure", + "members": { + "retrieve": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveActionDetails", + "traits": { + "smithy.api#documentation": "Details of the retrieve action.
" + } + }, + "fullDocumentExpansion": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveFullDocExpansionDetails", + "traits": { + "smithy.api#documentation": "Details of a full document expansion action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An action taken during agentic retrieval.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveActionDetails": { + "type": "structure", + "members": { + "inputQuery": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessageContent", + "traits": { + "smithy.api#documentation": "The input query used for retrieval.
", + "smithy.api#required": {} + } + }, + "sourceRetrievers": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetrieverList", + "traits": { + "smithy.api#documentation": "The list of source retrievers targeted by this action.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details of a retrieve action including the query and target retrievers.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveActions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveAction", + "traits": { + "smithy.api#documentation": "A single retrieval action.
" + } + }, + "traits": { + "smithy.api#documentation": "List of actions taken during an agentic retrieval step.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveBedrockGuardrailConfiguration": { + "type": "structure", + "members": { + "guardrailId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail.
", + "smithy.api#length": { + "max": 64 + }, + "smithy.api#pattern": "^[a-z0-9]+$", + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the guardrail to use.
", + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a Bedrock guardrail applied during agentic retrieval.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveBedrockRerankingConfiguration": { + "type": "structure", + "members": { + "modelConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveBedrockRerankingModelConfiguration", + "traits": { + "smithy.api#documentation": "The model configuration containing the model ARN.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a Bedrock reranking model.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveBedrockRerankingModelConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the Bedrock reranking model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Model configuration for a Bedrock reranking model.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitation": { + "type": "structure", + "members": { + "startIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Character offset start in the answer text.
", + "smithy.api#required": {} + } + }, + "endIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Character offset end (exclusive) in the answer text.
", + "smithy.api#required": {} + } + }, + "references": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitationReferenceList", + "traits": { + "smithy.api#documentation": "References to results that support this span.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A citation mapping a span of the generated answer to supporting results.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitationList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitation" + }, + "traits": { + "smithy.api#documentation": "List of citations.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitationReference": { + "type": "structure", + "members": { + "resultIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Index into the results array on the same event.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to a specific result item.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitationReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitationReference" + }, + "traits": { + "smithy.api#documentation": "List of citation references.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveConfiguration": { + "type": "structure", + "members": { + "foundationModelType": { + "target": "com.amazonaws.bedrockagentruntime#FoundationModelType", + "traits": { + "smithy.api#default": "MANAGED", + "smithy.api#documentation": "The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.
" + } + }, + "foundationModelConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#FoundationModelConfiguration", + "traits": { + "smithy.api#documentation": "The foundation model configuration. Required when foundationModelType is CUSTOM.
" + } + }, + "rerankingModelType": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveRerankingModelType", + "traits": { + "smithy.api#documentation": "The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.
" + } + }, + "rerankingConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveRerankingConfiguration", + "traits": { + "smithy.api#documentation": "The reranking model configuration. Required when rerankingModelType is CUSTOM.
" + } + }, + "maxAgentIteration": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 5, + "smithy.api#documentation": "The maximum number of agent iterations for retrieval.
", + "smithy.api#range": { + "min": 2 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for the agentic retrieval operation.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveFailure": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A message describing the failure.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A failure that occurred during agentic retrieval.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveFailures": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveFailure", + "traits": { + "smithy.api#documentation": "A single failure.
" + } + }, + "traits": { + "smithy.api#documentation": "List of failures that occurred during agentic retrieval.
", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveFullDocExpansionDetails": { + "type": "structure", + "members": { + "documentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the document to expand.
" + } + }, + "sourceRetriever": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetriever", + "traits": { + "smithy.api#documentation": "The source retriever associated with the document.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of a full document expansion action.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveGeneratedResponse": { + "type": "structure", + "members": { + "answer": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The generated answer text.
", + "smithy.api#required": {} + } + }, + "citations": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitationList", + "traits": { + "smithy.api#documentation": "Citations mapping spans of the answer to supporting results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The generated response synthesized from retrieved results.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveGuardrailWarning": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailAction", + "traits": { + "smithy.api#documentation": "The action taken by the guardrail.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A message describing the guardrail evaluation result.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A warning generated by a guardrail during agentic retrieval.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessage": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessageContent", + "traits": { + "smithy.api#documentation": "The content of the message.
", + "smithy.api#required": {} + } + }, + "role": { + "target": "com.amazonaws.bedrockagentruntime#ConversationRole", + "traits": { + "smithy.api#documentation": "The role of the message sender (e.g., user or assistant).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A message in the agentic retrieval conversation.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessageContent": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text content of the message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The content of an agentic retrieval message.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessage", + "traits": { + "smithy.api#documentation": "A single message in the conversation.
" + } + }, + "traits": { + "smithy.api#documentation": "List of messages in the agentic retrieval conversation.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveMetadata": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The metadata key.
" + } + }, + "value": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The metadata value.
" + } + }, + "traits": { + "smithy.api#documentation": "Metadata key-value pairs associated with a retrieved item.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrievePolicyConfiguration": { + "type": "structure", + "members": { + "bedrockGuardrailConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveBedrockGuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for Bedrock guardrails to apply during retrieval.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Policy configuration for agentic retrieval.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveRerankingConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveRerankingConfigurationType", + "traits": { + "smithy.api#documentation": "The type of reranking configuration.
", + "smithy.api#required": {} + } + }, + "bedrockRerankingConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveBedrockRerankingConfiguration", + "traits": { + "smithy.api#documentation": "The Bedrock reranking model configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for the reranking model.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveRerankingConfigurationType": { + "type": "enum", + "members": { + "BEDROCK_RERANKING_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_RERANKING_MODEL" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of reranking configuration.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveRerankingModelType": { + "type": "enum", + "members": { + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of reranking model.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveResponseEvent": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The generated text chunk.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A chunk of the generated answer text.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveResultEvent": { + "type": "structure", + "members": { + "results": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveResults", + "traits": { + "smithy.api#documentation": "The list of retrieved result items.
", + "smithy.api#required": {} + } + }, + "generatedResponse": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveGeneratedResponse", + "traits": { + "smithy.api#documentation": "The generated response. Present only when generateResponse is true.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "Opaque continuation token for paginated results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An event containing agentic retrieval results.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveResultItem": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalContent", + "traits": { + "smithy.api#documentation": "The retrieved content.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMetadata", + "traits": { + "smithy.api#documentation": "Metadata associated with the retrieved item.
" + } + }, + "sourceRetriever": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetriever", + "traits": { + "smithy.api#documentation": "The source retriever that produced this result.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A single item from the agentic retrieval results.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveResults": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveResultItem", + "traits": { + "smithy.api#documentation": "A single retrieval result item.
" + } + }, + "traits": { + "smithy.api#documentation": "List of agentic retrieval result items.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceMetadata": { + "type": "structure", + "members": { + "identifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the retrieval source.
" + } + }, + "retrievalType": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveType", + "traits": { + "smithy.api#documentation": "The type of retrieval source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata about a retrieval source.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceMetadata", + "traits": { + "smithy.api#documentation": "Metadata for a retrieval source.
" + } + }, + "traits": { + "smithy.api#documentation": "List of retrieval source metadata.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetriever": { + "type": "structure", + "members": { + "identifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the source retriever.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A source retriever that produced retrieval results.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetrieverList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetriever", + "traits": { + "smithy.api#documentation": "A source retriever.
" + } + }, + "traits": { + "smithy.api#documentation": "List of source retrievers.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "The step is currently in progress.
", + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "The step completed successfully.
", + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "The step failed.
", + "smithy.api#enumValue": "FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of an agentic retrieval step.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveStep": { + "type": "enum", + "members": { + "PLANNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "The planning phase of retrieval.
", + "smithy.api#enumValue": "Planning" + } + }, + "RETRIEVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "The retrieval phase where data is fetched.
", + "smithy.api#enumValue": "Retrieval" + } + }, + "SPECULATIVE_RETRIEVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A speculative retrieval phase for optimization.
", + "smithy.api#enumValue": "SpeculativeRetrieval" + } + }, + "FULL_DOCUMENT_EXPANSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "The full document expansion phase.
", + "smithy.api#enumValue": "FullDocumentExpansion" + } + } + }, + "traits": { + "smithy.api#documentation": "The step in the agentic retrieval process.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information from one or more knowledge bases using an agentic approach. Agentic retrieval uses a foundation model to intelligently decompose complex queries into sub-queries and iteratively retrieve relevant information from your knowledge bases. This approach improves retrieval accuracy for complex, multi-step questions that a single retrieval pass might not fully address.
The operation returns results through a stream that includes retrieval results, trace events for visibility into the process, and a generated response synthesized from the results by default, which can be turned off.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agenticRetrieveStream" + } + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamRequest": { + "type": "structure", + "members": { + "messages": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessages", + "traits": { + "smithy.api#documentation": "The list of messages for the agentic retrieval conversation.
", + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "retrievers": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrievers", + "traits": { + "smithy.api#documentation": "The list of retrievers to use for agentic retrieval.
", + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "agenticRetrieveConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveConfiguration", + "traits": { + "smithy.api#documentation": "Configuration settings for the agentic retrieval operation.
", + "smithy.api#required": {} + } + }, + "policyConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrievePolicyConfiguration", + "traits": { + "smithy.api#documentation": "Policy configuration for guardrails and content filtering.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "Opaque continuation token for paginated results.
" + } + }, + "userContext": { + "target": "com.amazonaws.bedrockagentruntime#UserContext", + "traits": { + "smithy.api#documentation": "Contains information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.
" + } + }, + "generateResponse": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": true, + "smithy.api#documentation": "Whether to generate a response based on the retrieved results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Request structure for the agentic retrieve stream operation.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStream" + } + ] + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamResponse": { + "type": "structure", + "members": { + "stream": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamResponseOutput", + "traits": { + "smithy.api#documentation": "The output stream containing retrieval results and trace events.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response structure for the agentic retrieve stream operation.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamResponseOutput": { + "type": "union", + "members": { + "result": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveResultEvent", + "traits": { + "smithy.api#documentation": "A retrieval result event containing the retrieved items.
" + } + }, + "traceEvent": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceEvent", + "traits": { + "smithy.api#documentation": "A trace event providing visibility into the retrieval process.
" + } + }, + "responseEvent": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveResponseEvent", + "traits": { + "smithy.api#documentation": "A chunk of the generated answer. Emitted only when generateResponse is true.
" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "An internal server error occurred.
" + } + }, + "validationException": { + "target": "com.amazonaws.bedrockagentruntime#ValidationException", + "traits": { + "smithy.api#documentation": "The request validation failed.
" + } + }, + "resourceNotFoundException": { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", + "traits": { + "smithy.api#documentation": "The specified resource was not found.
" + } + }, + "serviceQuotaExceededException": { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", + "traits": { + "smithy.api#documentation": "The service quota has been exceeded.
" + } + }, + "throttlingException": { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "The request was throttled.
" + } + }, + "accessDeniedException": { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", + "traits": { + "smithy.api#documentation": "Access to the resource was denied.
" + } + }, + "conflictException": { + "target": "com.amazonaws.bedrockagentruntime#ConflictException", + "traits": { + "smithy.api#documentation": "A conflict occurred with the current state of the resource.
" + } + }, + "dependencyFailedException": { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", + "traits": { + "smithy.api#documentation": "A dependency failed during the operation.
" + } + }, + "badGatewayException": { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", + "traits": { + "smithy.api#documentation": "A bad gateway error occurred.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The streaming output for agentic retrieval, containing results, traces, and errors.
", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceEvent": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace event.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The timestamp when the trace event occurred.
", + "smithy.api#required": {} + } + }, + "attributes": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceEventAttributes", + "traits": { + "smithy.api#documentation": "The attributes describing the trace event details.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A trace event providing visibility into the agentic retrieval process.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceEventAttributes": { + "type": "structure", + "members": { + "step": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStep", + "traits": { + "smithy.api#documentation": "The current step in the retrieval process.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStatus", + "traits": { + "smithy.api#documentation": "The status of the current step.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A human-readable message describing the trace event.
", + "smithy.api#required": {} + } + }, + "actions": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveActions", + "traits": { + "smithy.api#documentation": "The list of actions taken during this step.
" + } + }, + "warnings": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveWarnings", + "traits": { + "smithy.api#documentation": "Warnings generated during this step.
" + } + }, + "failures": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveFailures", + "traits": { + "smithy.api#documentation": "Failures that occurred during this step.
" + } + }, + "retrievalMetadata": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceMetadataList", + "traits": { + "smithy.api#documentation": "Metadata about the retrieval sources used.
" + } + }, + "retrievalResponse": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceResults", + "traits": { + "smithy.api#documentation": "The retrieval results from this step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Attributes describing the details of an agentic retrieval trace event.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceResultItem": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalContent", + "traits": { + "smithy.api#documentation": "The retrieved content.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMetadata", + "traits": { + "smithy.api#documentation": "Metadata associated with the retrieved item.
" + } + }, + "sourceRetriever": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetriever", + "traits": { + "smithy.api#documentation": "The source retriever that produced this result.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A result item from an agentic retrieval trace.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceResults": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceResultItem", + "traits": { + "smithy.api#documentation": "A single trace result item.
" + } + }, + "traits": { + "smithy.api#documentation": "List of trace result items from agentic retrieval.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveType": { + "type": "enum", + "members": { + "BEDROCK_KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A Bedrock knowledge base retrieval source.
", + "smithy.api#enumValue": "BedrockKnowledgeBase" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of retrieval source.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveWarning": { + "type": "union", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveWarningMessage", + "traits": { + "smithy.api#documentation": "A general warning message.
" + } + }, + "guardrail": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveGuardrailWarning", + "traits": { + "smithy.api#documentation": "A warning from a guardrail evaluation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A warning generated during agentic retrieval.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveWarningMessage": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The warning message text.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A general warning message from agentic retrieval.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrieveWarnings": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveWarning", + "traits": { + "smithy.api#documentation": "A single warning.
" + } + }, + "traits": { + "smithy.api#documentation": "List of warnings generated during agentic retrieval.
", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetriever": { + "type": "structure", + "members": { + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the retriever's purpose.
" + } + }, + "configuration": { + "target": "com.amazonaws.bedrockagentruntime#RetrieverConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for this retriever.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A retriever used in agentic retrieval.
" + } + }, + "com.amazonaws.bedrockagentruntime#AgenticRetrievers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetriever", + "traits": { + "smithy.api#documentation": "A retriever configuration.
" + } + }, + "traits": { + "smithy.api#documentation": "List of retrievers for agentic retrieval.
" + } + }, + "com.amazonaws.bedrockagentruntime#AmazonBedrockAgentRunTimeService": { + "type": "service", + "version": "2023-07-26", + "resources": [ + { + "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#FlowResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#GenerateQueryResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#GetDocumentContentResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InferenceResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InlineAgentResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#MemoryResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#OptimizePromptResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#RerankResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateStreamResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#RetrieveResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#SessionResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#TaggingResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Bedrock Agent Runtime", + "arnNamespace": "bedrock", + "endpointPrefix": "bedrock-agent-runtime", + "cloudTrailEventSource": "bedrock.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "bedrock" + }, + "aws.protocols#restJson1": { + "http": [ + "h2", + "http/1.1" + ], + "eventStreamHttp": [ + "h2", + "http/1.1" + ] + }, + "smithy.api#documentation": "Contains APIs related to model invocation and querying of knowledge bases.
", + "smithy.api#title": "Agents for Amazon Bedrock 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 + ] + } + ], + "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://bedrock-agent-runtime-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://bedrock-agent-runtime-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://bedrock-agent-runtime.{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://bedrock-agent-runtime.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 13, + "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" + }, + "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": [], + "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" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-runtime.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-runtime.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-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://bedrock-agent-runtime-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://bedrock-agent-runtime.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-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://bedrock-agent-runtime-fips.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://bedrock-agent-runtime.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://bedrock-agent-runtime.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 enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-runtime-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://bedrock-agent-runtime.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.bedrockagentruntime#AnalyzePromptEvent": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A message describing the analysis of the prompt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An event in which the prompt was analyzed in preparation for optimization.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ApiContentMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#PropertyParameters" + } + }, + "com.amazonaws.bedrockagentruntime#ApiInvocationInput": { + "type": "structure", + "members": { + "actionGroup": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The action group that the API operation belongs to.
", + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The HTTP method of the API operation.
" + } + }, + "apiPath": { + "target": "com.amazonaws.bedrockagentruntime#ApiPath", + "traits": { + "smithy.api#documentation": "The path to the API operation.
" + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagentruntime#ApiParameters", + "traits": { + "smithy.api#documentation": "The parameters to provide for the API request, as the agent elicited from the user.
" + } + }, + "requestBody": { + "target": "com.amazonaws.bedrockagentruntime#ApiRequestBody", + "traits": { + "smithy.api#documentation": "The request body to provide for the API request, as the agent elicited from the user.
" + } + }, + "actionInvocationType": { + "target": "com.amazonaws.bedrockagentruntime#ActionInvocationType", + "traits": { + "smithy.api#documentation": "Contains information about the API operation to invoke.
" + } + }, + "agentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The agent's ID.
" + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagentruntime#Name", + "traits": { + "smithy.api#documentation": "The agent collaborator's name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the API operation that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
The name of the parameter.
" + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data type for the parameter.
" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a parameter to provide to the API request.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrockagentruntime#ApiParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#ApiParameter" + } + }, + "com.amazonaws.bedrockagentruntime#ApiPath": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ApiRequestBody": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.bedrockagentruntime#ApiContentMap", + "traits": { + "smithy.api#documentation": "The content of the request body. The key of the object in this field is a media type defining the format of the request body.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request body to provide for the API request, as the agent elicited from the user.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrockagentruntime#ApiResult": { + "type": "structure", + "members": { + "actionGroup": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The action group that the API operation belongs to.
", + "smithy.api#required": {} + } + }, + "httpMethod": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The HTTP method for the API operation.
" + } + }, + "apiPath": { + "target": "com.amazonaws.bedrockagentruntime#ApiPath", + "traits": { + "smithy.api#documentation": "The path to the API operation.
" + } + }, + "confirmationState": { + "target": "com.amazonaws.bedrockagentruntime#ConfirmationState", + "traits": { + "smithy.api#documentation": "Controls the API operations or functions to invoke based on the user confirmation.
" + } + }, + "responseState": { + "target": "com.amazonaws.bedrockagentruntime#ResponseState", + "traits": { + "smithy.api#documentation": "Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
" + } + }, + "httpStatusCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "http status code from API execution response (for example: 200, 400, 500).
" + } + }, + "responseBody": { + "target": "com.amazonaws.bedrockagentruntime#ResponseBody", + "traits": { + "smithy.api#documentation": "The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.
The agent's ID.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the API operation that was called from the action group and the response body that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
A list of citations and related information for a part of an agent response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains citations for a part of an agent response.
" + } + }, + "com.amazonaws.bedrockagentruntime#AudioSegment": { + "type": "structure", + "members": { + "s3Uri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The S3 URI where this specific audio segment is stored in the multimodal storage destination.
", + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "transcription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text transcription of the audio segment content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an audio segment retrieved from a knowledge base, including its location and transcription.
This data type is used in the following API operations:
Retrieve response – in the audio field
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
" + } + } + }, + "traits": { + "smithy.api#documentation": "There was an issue with a dependency due to a server issue. Retry your request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502 + } + }, + "com.amazonaws.bedrockagentruntime#BasePromptTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#BedrockFoundationModelConfiguration": { + "type": "structure", + "members": { + "modelConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#BedrockFoundationModelModelConfiguration", + "traits": { + "smithy.api#documentation": "The model configuration containing the model ARN.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a Bedrock foundation model.
" + } + }, + "com.amazonaws.bedrockagentruntime#BedrockFoundationModelModelConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the Bedrock foundation model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Model configuration for a Bedrock foundation model.
" + } + }, + "com.amazonaws.bedrockagentruntime#BedrockModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" + } + }, + "com.amazonaws.bedrockagentruntime#BedrockModelConfigurations": { + "type": "structure", + "members": { + "performanceConfig": { + "target": "com.amazonaws.bedrockagentruntime#PerformanceConfiguration", + "traits": { + "smithy.api#documentation": "The performance configuration for the model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for a model called with InvokeAgent.
" + } + }, + "com.amazonaws.bedrockagentruntime#BedrockRerankingConfiguration": { + "type": "structure", + "members": { + "numberOfResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of results to return after reranking.
", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "modelConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#BedrockRerankingModelConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a reranker model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for an Amazon Bedrock reranker model.
" + } + }, + "com.amazonaws.bedrockagentruntime#BedrockRerankingModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$" + } + }, + "com.amazonaws.bedrockagentruntime#BedrockRerankingModelConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the reranker model.
", + "smithy.api#required": {} + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "A JSON object whose keys are request fields for the model and whose values are values for those fields.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a reranker model.
" + } + }, + "com.amazonaws.bedrockagentruntime#BedrockSessionContentBlock": { + "type": "union", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text in the invocation step.
", + "smithy.api#length": { + "min": 1 + } + } + }, + "image": { + "target": "com.amazonaws.bedrockagentruntime#ImageBlock", + "traits": { + "smithy.api#documentation": "The image in the invocation step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a session in the payLoad of the PutInvocationStep API operation. You retrieve the content with the GetInvocationStep API operation.
For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#BedrockSessionContentBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#BedrockSessionContentBlock" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentruntime#ByteContentBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10485760 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ByteContentDoc": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.bedrockagentruntime#Identifier", + "traits": { + "smithy.api#documentation": "The file name of the document contained in the wrapper object.
", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.bedrockagentruntime#ContentType", + "traits": { + "smithy.api#documentation": "The MIME type of the document contained in the wrapper object.
", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.bedrockagentruntime#ByteContentBlob", + "traits": { + "smithy.api#documentation": "The byte value of the file to upload, encoded as a Base-64 string.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This property contains the document to chat with, along with its attributes.
" + } + }, + "com.amazonaws.bedrockagentruntime#ByteContentFile": { + "type": "structure", + "members": { + "mediaType": { + "target": "com.amazonaws.bedrockagentruntime#MimeType", + "traits": { + "smithy.api#documentation": "The MIME type of data contained in the file used for chat.
", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.bedrockagentruntime#ByteContentBlob", + "traits": { + "smithy.api#documentation": "The raw bytes of the file to attach. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The property contains the file to chat with, along with its attributes.
" + } + }, + "com.amazonaws.bedrockagentruntime#Caller": { + "type": "union", + "members": { + "agentAliasArn": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasArn", + "traits": { + "smithy.api#documentation": "The caller's agent alias ARN.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a caller.
" + } + }, + "com.amazonaws.bedrockagentruntime#CallerChain": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Caller" + } + }, + "com.amazonaws.bedrockagentruntime#Citation": { + "type": "structure", + "members": { + "generatedResponsePart": { + "target": "com.amazonaws.bedrockagentruntime#GeneratedResponsePart", + "traits": { + "smithy.api#documentation": "Contains the generated response and metadata
" + } + }, + "retrievedReferences": { + "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences", + "traits": { + "smithy.api#documentation": "Contains metadata about the sources cited for the generated response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
This data type is used in the following API operations:
InvokeAgent response – in the citations field
RetrieveAndGenerate response – in the citations field
The citation.
" + } + }, + "generatedResponsePart": { + "target": "com.amazonaws.bedrockagentruntime#GeneratedResponsePart", + "traits": { + "smithy.api#documentation": "The generated response to the citation event.
" + } + }, + "retrievedReferences": { + "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences", + "traits": { + "smithy.api#documentation": "The retrieved references of the citation event.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A citation event.
" + } + }, + "com.amazonaws.bedrockagentruntime#Citations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Citation" + } + }, + "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationInput": { + "type": "structure", + "members": { + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The code for the code interpreter to use.
" + } + }, + "files": { + "target": "com.amazonaws.bedrockagentruntime#Files", + "traits": { + "smithy.api#documentation": "Files that are uploaded for code interpreter to use.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the code interpreter being invoked.
" + } + }, + "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationOutput": { + "type": "structure", + "members": { + "executionOutput": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Contains the successful output returned from code execution
" + } + }, + "executionError": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Contains the error returned from code execution.
" + } + }, + "files": { + "target": "com.amazonaws.bedrockagentruntime#Files", + "traits": { + "smithy.api#documentation": "Contains output files, if generated by code execution.
" + } + }, + "executionTimeout": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if the execution of the code timed out.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the output from the code interpreter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the JSON-formatted string returned by the API invoked by the code interpreter.
" + } + }, + "com.amazonaws.bedrockagentruntime#CollaborationInstruction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Collaborator": { + "type": "structure", + "members": { + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.
" + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagentruntime#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The foundation model used by the inline collaborator agent.
", + "smithy.api#required": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagentruntime#Instruction", + "traits": { + "smithy.api#documentation": "Instruction that tell the inline collaborator agent what it should do and how it should interact with users.
", + "smithy.api#required": {} + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagentruntime#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" + } + }, + "actionGroups": { + "target": "com.amazonaws.bedrockagentruntime#AgentActionGroups", + "traits": { + "smithy.api#documentation": "List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
" + } + }, + "knowledgeBases": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBases", + "traits": { + "smithy.api#documentation": "Knowledge base associated with the inline collaborator agent.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailConfigurationWithArn", + "traits": { + "smithy.api#documentation": "Details of the guardwrail associated with the inline collaborator.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see Advanced prompts.
" + } + }, + "agentCollaboration": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboration", + "traits": { + "smithy.api#documentation": "Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
" + } + }, + "collaboratorConfigurations": { + "target": "com.amazonaws.bedrockagentruntime#CollaboratorConfigurations", + "traits": { + "smithy.api#documentation": "Settings of the collaborator agent.
" + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagentruntime#Name", + "traits": { + "smithy.api#documentation": " Name of the inline collaborator agent which must be the same name as specified for collaboratorName.
List of inline collaborators.
" + } + }, + "com.amazonaws.bedrockagentruntime#CollaboratorConfiguration": { + "type": "structure", + "members": { + "collaboratorName": { + "target": "com.amazonaws.bedrockagentruntime#Name", + "traits": { + "smithy.api#documentation": " Name of the inline collaborator agent which must be the same name as specified for agentName.
Instructions that tell the inline collaborator agent what it should do and how it should interact with users.
", + "smithy.api#required": {} + } + }, + "agentAliasArn": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inline collaborator agent.
" + } + }, + "relayConversationHistory": { + "target": "com.amazonaws.bedrockagentruntime#RelayConversationHistory", + "traits": { + "smithy.api#documentation": "A relay conversation history for the inline collaborator agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings of an inline collaborator agent.
" + } + }, + "com.amazonaws.bedrockagentruntime#CollaboratorConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#CollaboratorConfiguration" + } + }, + "com.amazonaws.bedrockagentruntime#Collaborators": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Collaborator" + } + }, + "com.amazonaws.bedrockagentruntime#ConditionResultEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the condition node that evaluated the conditions.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the condition evaluation occurred.
", + "smithy.api#required": {} + } + }, + "satisfiedConditions": { + "target": "com.amazonaws.bedrockagentruntime#SatisfiedConditions", + "traits": { + "smithy.api#documentation": "A list of conditions that were satisfied during the evaluation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a condition evaluation result during a flow execution. This event is generated when a condition node in the flow evaluates its conditions.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
There was a conflict performing an operation. Resolve the conflict and retry your request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.bedrockagentruntime#ContentBlock": { + "type": "union", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The block's text.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A content block.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ContentBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#ContentBlock" + } + }, + "com.amazonaws.bedrockagentruntime#ContentBody": { + "type": "structure", + "members": { + "body": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The body of the API response.
" + } + }, + "images": { + "target": "com.amazonaws.bedrockagentruntime#ImageInputs", + "traits": { + "smithy.api#documentation": "Lists details, including format and source, for the image in the response from the function call. You can specify only one image and the function in the returnControlInvocationResults must be a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Contains the body of the API response.
This data type is used in the following API operations:
In the returnControlInvocationResults field of the InvokeAgent request
The conversation's messages.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A conversation history.
" + } + }, + "com.amazonaws.bedrockagentruntime#ConversationRole": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user" + } + }, + "ASSISTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "assistant" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#CreateInvocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#CreateInvocationRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#CreateInvocationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Related APIs
", + "smithy.api#http": { + "code": 201, + "method": "PUT", + "uri": "/sessions/{sessionIdentifier}/invocations/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentruntime#CreateInvocationRequest": { + "type": "structure", + "members": { + "invocationId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "A unique identifier for the invocation in UUID format.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentruntime#InvocationDescription", + "traits": { + "smithy.api#documentation": "A description for the interactions in the invocation. For example, \"User asking about weather in Seattle\".
" + } + }, + "sessionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier for the associated session for the invocation. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The unique identifier for the session associated with the invocation.
", + "smithy.api#required": {} + } + }, + "invocationId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier for the invocation.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the invocation was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#CreateSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#CreateSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#CreateSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex. Sessions enable you to save the state of conversations at checkpoints, with the added security and infrastructure of Amazon Web Services. For more information, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
By default, Amazon Bedrock uses Amazon Web Services-managed keys for session encryption, including session metadata, or you can use your own KMS key. For more information, see Amazon Bedrock session encryption.
You use a session to store state and conversation history for generative AI applications built with open-source frameworks. For Amazon Bedrock Agents, the service automatically manages conversation context and associates them with the agent-specific sessionId you specify in the InvokeAgent API operation.
Related APIs:
", + "smithy.api#http": { + "code": 201, + "method": "PUT", + "uri": "/sessions/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentruntime#CreateSessionRequest": { + "type": "structure", + "members": { + "sessionMetadata": { + "target": "com.amazonaws.bedrockagentruntime#SessionMetadataMap", + "traits": { + "smithy.api#documentation": "A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.
" + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see Amazon Bedrock session encryption.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentruntime#TagsMap", + "traits": { + "smithy.api#documentation": "Specify the key-value pairs for the tags that you want to attach to the session.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#CreateSessionResponse": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier for the session.
", + "smithy.api#required": {} + } + }, + "sessionArn": { + "target": "com.amazonaws.bedrockagentruntime#SessionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created session.
", + "smithy.api#required": {} + } + }, + "sessionStatus": { + "target": "com.amazonaws.bedrockagentruntime#SessionStatus", + "traits": { + "smithy.api#documentation": "The current status of the session.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the session was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#CreationMode": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "OVERRIDDEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDDEN" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#CustomControlMethod": { + "type": "enum", + "members": { + "RETURN_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETURN_CONTROL" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#CustomOrchestration": { + "type": "structure", + "members": { + "executor": { + "target": "com.amazonaws.bedrockagentruntime#OrchestrationExecutor", + "traits": { + "smithy.api#documentation": "The structure of the executor invoking the actions in custom orchestration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of the custom orchestration configured for the agent.
" + } + }, + "com.amazonaws.bedrockagentruntime#CustomOrchestrationTrace": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace.
" + } + }, + "event": { + "target": "com.amazonaws.bedrockagentruntime#CustomOrchestrationTraceEvent", + "traits": { + "smithy.api#documentation": "The event details used with the custom orchestration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The trace behavior for the custom orchestration.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#CustomOrchestrationTraceEvent": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text that prompted the event at this step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#DataSourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagentruntime#DateTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "Time Stamp.", + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.bedrockagentruntime#DeleteAgentMemory": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#DeleteAgentMemoryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#DeleteAgentMemoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes memory from the specified memory identifier.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/agentAliases/{agentAliasId}/memories" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentruntime#DeleteAgentMemoryRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagentruntime#AgentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent to which the alias belongs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of an alias of an agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "memoryId": { + "target": "com.amazonaws.bedrockagentruntime#MemoryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the memory.
", + "smithy.api#httpQuery": "memoryId" + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "The unique session identifier of the memory.
", + "smithy.api#httpQuery": "sessionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#DeleteAgentMemoryResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#DeleteSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#DeleteSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#DeleteSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a session that you ended. You can't delete a session with an ACTIVE status. To delete an active session, you must first end it with the EndSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
The unique identifier for the session to be deleted. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
" + } + } + }, + "traits": { + "smithy.api#documentation": "There was an issue with a dependency. Check the resource configurations and retry the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 424 + } + }, + "com.amazonaws.bedrockagentruntime#DocumentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1825 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.bedrockagentruntime#DocumentOutputFormat": { + "type": "enum", + "members": { + "RAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RAW" + } + }, + "EXTRACTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTRACTED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#EndSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#EndSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#EndSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Ends the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/sessions/{sessionIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentruntime#EndSessionRequest": { + "type": "structure", + "members": { + "sessionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier for the session to end. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The unique identifier of the session you ended.
", + "smithy.api#required": {} + } + }, + "sessionArn": { + "target": "com.amazonaws.bedrockagentruntime#SessionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the session you ended.
", + "smithy.api#required": {} + } + }, + "sessionStatus": { + "target": "com.amazonaws.bedrockagentruntime#SessionStatus", + "traits": { + "smithy.api#documentation": "The current status of the session you ended.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#ExecutionType": { + "type": "enum", + "members": { + "LAMBDA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA" + } + }, + "RETURN_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETURN_CONTROL" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#ExternalSource": { + "type": "structure", + "members": { + "sourceType": { + "target": "com.amazonaws.bedrockagentruntime#ExternalSourceType", + "traits": { + "smithy.api#documentation": "The source type of the external source wrapper object.
", + "smithy.api#required": {} + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagentruntime#S3ObjectDoc", + "traits": { + "smithy.api#documentation": "The S3 location of the external source wrapper object.
" + } + }, + "byteContent": { + "target": "com.amazonaws.bedrockagentruntime#ByteContentDoc", + "traits": { + "smithy.api#documentation": "The identifier, contentType, and data of the external source wrapper object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The unique external source of the content contained in the wrapper object.
" + } + }, + "com.amazonaws.bedrockagentruntime#ExternalSourceType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "BYTE_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYTE_CONTENT" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#ExternalSources": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#ExternalSource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentruntime#ExternalSourcesGenerationConfiguration": { + "type": "structure", + "members": { + "promptTemplate": { + "target": "com.amazonaws.bedrockagentruntime#PromptTemplate", + "traits": { + "smithy.api#documentation": "Contain the textPromptTemplate string for the external source wrapper object.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The configuration details for the guardrail.
" + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrockagentruntime#InferenceConfig", + "traits": { + "smithy.api#documentation": "Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
" + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.
" + } + }, + "performanceConfig": { + "target": "com.amazonaws.bedrockagentruntime#PerformanceConfiguration", + "traits": { + "smithy.api#documentation": "The latency configuration for the model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the generation configuration of the external source wrapper object.
" + } + }, + "com.amazonaws.bedrockagentruntime#ExternalSourcesRetrieveAndGenerateConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The model Amazon Resource Name (ARN) for the external source wrapper object in the retrieveAndGenerate function.
The document for the external source wrapper object in the retrieveAndGenerate function.
The prompt used with the external source wrapper object with the retrieveAndGenerate function.
The configurations of the external source wrapper object in the retrieveAndGenerate function.
The unique identifier of the trace.
" + } + }, + "failureReason": { + "target": "com.amazonaws.bedrockagentruntime#FailureReasonString", + "traits": { + "smithy.api#documentation": "The reason the interaction failed.
" + } + }, + "failureCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The failure code for the trace.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Information about the failure that occurred.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the failure of the interaction.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FieldForReranking": { + "type": "structure", + "members": { + "fieldName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of a metadata field to include in or exclude from consideration when reranking.
", + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information for a metadata field to include in or exclude from consideration when reranking.
" + } + }, + "com.amazonaws.bedrockagentruntime#FieldsForReranking": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FieldForReranking" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FileBody": { + "type": "blob", + "traits": { + "smithy.api#length": { + "max": 1000000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FilePart": { + "type": "structure", + "members": { + "files": { + "target": "com.amazonaws.bedrockagentruntime#OutputFiles", + "traits": { + "smithy.api#documentation": "Files containing intermediate response for the user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains intermediate response for code interpreter if any files have been generated.
" + } + }, + "com.amazonaws.bedrockagentruntime#FileSource": { + "type": "structure", + "members": { + "sourceType": { + "target": "com.amazonaws.bedrockagentruntime#FileSourceType", + "traits": { + "smithy.api#documentation": "The source type of the files to attach.
", + "smithy.api#required": {} + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagentruntime#S3ObjectFile", + "traits": { + "smithy.api#documentation": "The s3 location of the files to attach.
" + } + }, + "byteContent": { + "target": "com.amazonaws.bedrockagentruntime#ByteContentFile", + "traits": { + "smithy.api#documentation": "The data and the text of the attached files.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The source file of the content contained in the wrapper object.
" + } + }, + "com.amazonaws.bedrockagentruntime#FileSourceType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "BYTE_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYTE_CONTENT" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#FileUseCase": { + "type": "enum", + "members": { + "CODE_INTERPRETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODE_INTERPRETER" + } + }, + "CHAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHAT" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#Files": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrockagentruntime#FilterAttribute": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrockagentruntime#FilterKey", + "traits": { + "smithy.api#documentation": "The name that the metadata attribute must match.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#FilterValue", + "traits": { + "smithy.api#documentation": "The value to which to compare the value of the metadata attribute.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrockagentruntime#FilterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentruntime#FilterValue": { + "type": "document" + }, + "com.amazonaws.bedrockagentruntime#FinalResponse": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentruntime#FinalResponseString", + "traits": { + "smithy.api#documentation": "The text in the response to the user.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the invoke agent operation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the response to the user.
" + } + }, + "com.amazonaws.bedrockagentruntime#FinalResponseString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" + } + }, + "com.amazonaws.bedrockagentruntime#FlowCompletionEvent": { + "type": "structure", + "members": { + "completionReason": { + "target": "com.amazonaws.bedrockagentruntime#FlowCompletionReason", + "traits": { + "smithy.api#documentation": "The reason that the flow completed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about why a flow completed.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowCompletionReason": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "INPUT_REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPUT_REQUIRED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowControlNodeType": { + "type": "enum", + "members": { + "ITERATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Iterator" + } + }, + "LOOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Loop" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowErrorCode": { + "type": "enum", + "members": { + "VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION" + } + }, + "INTERNAL_SERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER" + } + }, + "NODE_EXECUTION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NODE_EXECUTION_FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowExecutionContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The document content of the field, which can contain text or structured data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the content of an flow execution input or output field.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node in the flow where the error occurred (if applicable).
" + } + }, + "error": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionErrorType", + "traits": { + "smithy.api#documentation": "The error code for the type of error that occurred.
" + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A descriptive message that provides details about the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an error that occurred during an flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about the inputs provided to the flow at the start of execution.
" + } + }, + "flowOutputEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionOutputEvent", + "traits": { + "smithy.api#documentation": "Contains information about the outputs produced by the flow at the end of execution.
" + } + }, + "nodeInputEvent": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputEvent", + "traits": { + "smithy.api#documentation": "Contains information about the inputs provided to a specific node during execution.
" + } + }, + "nodeOutputEvent": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputEvent", + "traits": { + "smithy.api#documentation": "Contains information about the outputs produced by a specific node during execution.
" + } + }, + "conditionResultEvent": { + "target": "com.amazonaws.bedrockagentruntime#ConditionResultEvent", + "traits": { + "smithy.api#documentation": "Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.
" + } + }, + "nodeFailureEvent": { + "target": "com.amazonaws.bedrockagentruntime#NodeFailureEvent", + "traits": { + "smithy.api#documentation": "Contains information about a failure that occurred at a specific node during execution.
" + } + }, + "flowFailureEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowFailureEvent", + "traits": { + "smithy.api#documentation": "Contains information about a failure that occurred at the flow level during execution.
" + } + }, + "nodeActionEvent": { + "target": "com.amazonaws.bedrockagentruntime#NodeActionEvent", + "traits": { + "smithy.api#documentation": "Contains information about an action (operation) called by a node during execution.
" + } + }, + "nodeDependencyEvent": { + "target": "com.amazonaws.bedrockagentruntime#NodeDependencyEvent", + "traits": { + "smithy.api#documentation": "Contains information about an internal trace of a specific node during execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an event that occurred during an flow execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node that receives the inputs.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the inputs are provided.
", + "smithy.api#required": {} + } + }, + "fields": { + "target": "com.amazonaws.bedrockagentruntime#FlowInputFields", + "traits": { + "smithy.api#documentation": "A list of input fields provided to the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the inputs provided to the flow at the start of a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node that produces the outputs.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the outputs are produced.
", + "smithy.api#required": {} + } + }, + "fields": { + "target": "com.amazonaws.bedrockagentruntime#FlowOutputFields", + "traits": { + "smithy.api#documentation": "A list of output fields produced by the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the outputs produced by the flow during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
", + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow alias used for the execution.
", + "smithy.api#required": {} + } + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagentruntime#Version", + "traits": { + "smithy.api#documentation": "The version of the flow used for the execution.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionStatus", + "traits": { + "smithy.api#documentation": "The current status of the flow execution.
Flow executions time out after 24 hours.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the flow execution was created.
", + "smithy.api#required": {} + } + }, + "endedAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a flow execution, including its status, timestamps, and identifiers.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The timestamp when the failure occurred.
", + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.bedrockagentruntime#FlowErrorCode", + "traits": { + "smithy.api#documentation": "The error code that identifies the type of failure that occurred.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A descriptive message that provides details about the failure.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a failure that occurred at the flow level during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the flow input node that begins the prompt flow.
", + "smithy.api#required": {} + } + }, + "nodeOutputName": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputName", + "traits": { + "smithy.api#documentation": "The name of the output from the flow input node that begins the prompt flow.
" + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowInputContent", + "traits": { + "smithy.api#documentation": "Contains information about an input into the prompt flow.
", + "smithy.api#required": {} + } + }, + "nodeInputName": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputName", + "traits": { + "smithy.api#documentation": "The name of the input from the flow input node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an input into the prompt flow and where to send it.
" + } + }, + "com.amazonaws.bedrockagentruntime#FlowInputContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The input to send to the prompt flow input node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an input into the flow.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowInputField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputName", + "traits": { + "smithy.api#documentation": "The name of the input field as defined in the flow's input schema.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionContent", + "traits": { + "smithy.api#documentation": "The content of the input field, which can contain text or structured data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an input field provided to a flow during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The requested additional input to send back to the multi-turn flow node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The content structure containing input information for multi-turn flow interactions.
" + } + }, + "com.amazonaws.bedrockagentruntime#FlowMultiTurnInputRequestEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the node in the flow that is requesting the input.
", + "smithy.api#required": {} + } + }, + "nodeType": { + "target": "com.amazonaws.bedrockagentruntime#NodeType", + "traits": { + "smithy.api#documentation": "The type of the node in the flow that is requesting the input.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowMultiTurnInputContent", + "traits": { + "smithy.api#documentation": "The content payload containing the input request details for the multi-turn interaction.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response object from the flow multi-turn node requesting additional information.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowNodeIODataType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Number" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Boolean" + } + }, + "OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Object" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Array" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowNodeInputCategory": { + "type": "enum", + "members": { + "LOOP_CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoopCondition" + } + }, + "RETURN_VALUE_TO_LOOP_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReturnValueToLoopStart" + } + }, + "EXIT_LOOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExitLoop" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowNodeInputExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowNodeInputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagentruntime#FlowNodeOutputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagentruntime#FlowOutputContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The content in the output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the content in an output from prompt flow invocation.
" + } + }, + "com.amazonaws.bedrockagentruntime#FlowOutputEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the flow output node that the output is from.
", + "smithy.api#required": {} + } + }, + "nodeType": { + "target": "com.amazonaws.bedrockagentruntime#NodeType", + "traits": { + "smithy.api#documentation": "The type of the node that the output is from.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowOutputContent", + "traits": { + "smithy.api#documentation": "The content in the output.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an output from prompt flow invoction.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowOutputField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputName", + "traits": { + "smithy.api#documentation": "The name of the output field as defined in the flow's output schema.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionContent", + "traits": { + "smithy.api#documentation": "The content of the output field, which can contain text or structured data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an output field produced by a flow during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about an output from flow invocation.
" + } + }, + "flowCompletionEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowCompletionEvent", + "traits": { + "smithy.api#documentation": "Contains information about why the flow completed.
" + } + }, + "flowTraceEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceEvent", + "traits": { + "smithy.api#documentation": "Contains information about a trace, which tracks an input or output for a node in the flow.
" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "An internal server error occurred. Retry your request.
" + } + }, + "validationException": { + "target": "com.amazonaws.bedrockagentruntime#ValidationException", + "traits": { + "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
" + } + }, + "resourceNotFoundException": { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", + "traits": { + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" + } + }, + "serviceQuotaExceededException": { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", + "traits": { + "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
" + } + }, + "throttlingException": { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
" + } + }, + "accessDeniedException": { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", + "traits": { + "smithy.api#documentation": "The request is denied because of missing access permissions. Check your permissions and retry your request.
" + } + }, + "conflictException": { + "target": "com.amazonaws.bedrockagentruntime#ConflictException", + "traits": { + "smithy.api#documentation": "There was a conflict performing an operation. Resolve the conflict and retry your request.
" + } + }, + "dependencyFailedException": { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", + "traits": { + "smithy.api#documentation": "There was an issue with a dependency. Check the resource configurations and retry the request.
" + } + }, + "badGatewayException": { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", + "traits": { + "smithy.api#documentation": "There was an issue with a dependency due to a server issue. Retry your request.
" + } + }, + "flowMultiTurnInputRequestEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowMultiTurnInputRequestEvent", + "traits": { + "smithy.api#documentation": "The event stream containing the multi-turn input request information from the flow.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output of the flow.
", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTrace": { + "type": "union", + "members": { + "nodeInputTrace": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputEvent", + "traits": { + "smithy.api#documentation": "Contains information about the input into a node.
" + } + }, + "nodeOutputTrace": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputEvent", + "traits": { + "smithy.api#documentation": "Contains information about the output from a node.
" + } + }, + "conditionNodeResultTrace": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceConditionNodeResultEvent", + "traits": { + "smithy.api#documentation": "Contains information about an output from a condition node.
" + } + }, + "nodeActionTrace": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeActionEvent", + "traits": { + "smithy.api#documentation": "Contains information about an action (operation) called by a node.
" + } + }, + "nodeDependencyTrace": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceDependencyEvent", + "traits": { + "smithy.api#documentation": "Contains information about an internal trace of a node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceCondition": { + "type": "structure", + "members": { + "conditionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the condition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a condition that was satisfied. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceConditionNodeResultEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the condition node.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date and time that the trace was returned.
", + "smithy.api#required": {} + } + }, + "satisfiedConditions": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceConditions", + "traits": { + "smithy.api#documentation": "An array of objects containing information about the conditions that were satisfied.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an output from a condition node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceCondition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceDependencyEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the node that generated the dependency trace.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date and time that the dependency trace was generated.
", + "smithy.api#required": {} + } + }, + "traceElements": { + "target": "com.amazonaws.bedrockagentruntime#TraceElements", + "traits": { + "smithy.api#documentation": "The trace elements containing detailed information about the dependency.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a dependency trace event in the flow.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceEvent": { + "type": "structure", + "members": { + "trace": { + "target": "com.amazonaws.bedrockagentruntime#FlowTrace", + "traits": { + "smithy.api#documentation": "The trace object containing information about an input or output for a node in the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a trace, which tracks an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
" + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeActionEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the node that called the operation.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date and time that the operation was called.
", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the request that the node made to the operation.
", + "smithy.api#required": {} + } + }, + "serviceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the service that the node called.
", + "smithy.api#required": {} + } + }, + "operationName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the operation that the node called.
", + "smithy.api#required": {} + } + }, + "operationRequest": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The request payload sent to the downstream service.
" + } + }, + "operationResponse": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The response payload received from the downstream service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes, agent nodes, and Amazon Web Services Lambda nodes.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The content of the node input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the content of the node input. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the node that received the input.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date and time that the trace was returned.
", + "smithy.api#required": {} + } + }, + "fields": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputFields", + "traits": { + "smithy.api#documentation": "An array of objects containing information about each field in the input.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputExecutionChain": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputExecutionChainItem" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputExecutionChainItem": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the node in the execution chain.
", + "smithy.api#required": {} + } + }, + "index": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The index position of this item in the execution chain.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#FlowControlNodeType", + "traits": { + "smithy.api#documentation": "The type of execution chain item. Supported values are Iterator and Loop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an item in the execution chain for flow trace node input tracking.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputField": { + "type": "structure", + "members": { + "nodeInputName": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputName", + "traits": { + "smithy.api#documentation": "The name of the node input.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputContent", + "traits": { + "smithy.api#documentation": "The content of the node input.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputSource", + "traits": { + "smithy.api#documentation": "The source node that provides input data to this field.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "The data type of the input field for compatibility validation.
" + } + }, + "category": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputCategory", + "traits": { + "smithy.api#documentation": "The category of the input field.
" + } + }, + "executionChain": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputExecutionChain", + "traits": { + "smithy.api#documentation": "The execution path through nested nodes like iterators and loops.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a field in the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputFields": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputSource": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the source node that provides the input data.
", + "smithy.api#required": {} + } + }, + "outputFieldName": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "The name of the output field from the source node.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputExpression", + "traits": { + "smithy.api#documentation": "The expression used to extract data from the source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the source of input data for a flow trace node field.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The content of the node output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the content of the node output. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
" + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the node that yielded the output.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date and time that the trace was returned.
", + "smithy.api#required": {} + } + }, + "fields": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputFields", + "traits": { + "smithy.api#documentation": "An array of objects containing information about each field in the output.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputField": { + "type": "structure", + "members": { + "nodeOutputName": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputName", + "traits": { + "smithy.api#documentation": "The name of the node output.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputContent", + "traits": { + "smithy.api#documentation": "The content of the node output.
", + "smithy.api#required": {} + } + }, + "next": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputNextList", + "traits": { + "smithy.api#documentation": "The next node that receives output data from this field.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "The data type of the output field for compatibility validation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a field in the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputFields": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputNext": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the next node that receives the output data.
", + "smithy.api#required": {} + } + }, + "inputFieldName": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "The name of the input field in the next node that receives the data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the next node that receives output data from a flow trace.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputNextList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputNext" + } + }, + "com.amazonaws.bedrockagentruntime#FoundationModelConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#FoundationModelConfigurationType", + "traits": { + "smithy.api#documentation": "The type of foundation model configuration.
", + "smithy.api#required": {} + } + }, + "bedrockFoundationModelConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#BedrockFoundationModelConfiguration", + "traits": { + "smithy.api#documentation": "The Bedrock foundation model configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for the foundation model.
" + } + }, + "com.amazonaws.bedrockagentruntime#FoundationModelConfigurationType": { + "type": "enum", + "members": { + "BEDROCK_FOUNDATION_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_FOUNDATION_MODEL" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of foundation model configuration.
" + } + }, + "com.amazonaws.bedrockagentruntime#FoundationModelType": { + "type": "enum", + "members": { + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of foundation model.
" + } + }, + "com.amazonaws.bedrockagentruntime#Function": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FunctionDefinition": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentruntime#ResourceName", + "traits": { + "smithy.api#documentation": "A name for the function.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentruntime#FunctionDescription", + "traits": { + "smithy.api#documentation": "A description of the function and its purpose.
" + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagentruntime#ParameterMap", + "traits": { + "smithy.api#documentation": "The parameters that the agent elicits from the user to fulfill the function.
" + } + }, + "requireConfirmation": { + "target": "com.amazonaws.bedrockagentruntime#RequireConfirmation", + "traits": { + "smithy.api#documentation": "Contains information if user confirmation is required to invoke the function.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
" + } + }, + "com.amazonaws.bedrockagentruntime#FunctionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1200 + } + } + }, + "com.amazonaws.bedrockagentruntime#FunctionInvocationInput": { + "type": "structure", + "members": { + "actionGroup": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The action group that the function belongs to.
", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagentruntime#FunctionParameters", + "traits": { + "smithy.api#documentation": "A list of parameters of the function.
" + } + }, + "function": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the function.
" + } + }, + "actionInvocationType": { + "target": "com.amazonaws.bedrockagentruntime#ActionInvocationType", + "traits": { + "smithy.api#documentation": "Contains information about the function to invoke,
" + } + }, + "agentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The agent's ID.
" + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagentruntime#Name", + "traits": { + "smithy.api#documentation": "The collaborator's name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
The name of the parameter.
" + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The data type of the parameter.
" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a parameter of the function.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
The action group that the function belongs to.
", + "smithy.api#required": {} + } + }, + "confirmationState": { + "target": "com.amazonaws.bedrockagentruntime#ConfirmationState", + "traits": { + "smithy.api#documentation": "Contains the user confirmation information about the function that was called.
" + } + }, + "function": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the function that was called.
" + } + }, + "responseBody": { + "target": "com.amazonaws.bedrockagentruntime#ResponseBody", + "traits": { + "smithy.api#documentation": "The response from the function call using the parameters. The response might be returned directly or from the Lambda function. Specify TEXT or IMAGES. The key of the object is the content type. You can only specify one type. If you specify IMAGES, you can specify only one image. You can specify images only when the function in the returnControlInvocationResults is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
" + } + }, + "agentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The agent's ID.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the function that was called from the action group and the response that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
A list of functions that each define an action in the action group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + } + }, + "com.amazonaws.bedrockagentruntime#Functions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FunctionDefinition" + } + }, + "com.amazonaws.bedrockagentruntime#GenerateQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#GenerateQueryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#GenerateQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Generates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/generateQuery" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#GenerateQueryRequest": { + "type": "structure", + "members": { + "queryGenerationInput": { + "target": "com.amazonaws.bedrockagentruntime#QueryGenerationInput", + "traits": { + "smithy.api#documentation": "Specifies information about a natural language query to transform into SQL.
", + "smithy.api#required": {} + } + }, + "transformationConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#TransformationConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for transforming the natural language query into SQL.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#GenerateQueryResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#GenerateQuery" + } + ] + }, + "com.amazonaws.bedrockagentruntime#GenerateQueryResponse": { + "type": "structure", + "members": { + "queries": { + "target": "com.amazonaws.bedrockagentruntime#GeneratedQueries", + "traits": { + "smithy.api#documentation": "A list of objects, each of which defines a generated query that can correspond to the natural language queries.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#GeneratedQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GeneratedQuery" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.bedrockagentruntime#GeneratedQuery": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#GeneratedQueryType", + "traits": { + "smithy.api#documentation": "The type of transformed query.
" + } + }, + "sql": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "An SQL query that corresponds to the natural language query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a query generated for a natural language query.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GeneratedQueryType": { + "type": "enum", + "members": { + "REDSHIFT_SQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDSHIFT_SQL" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GeneratedResponsePart": { + "type": "structure", + "members": { + "textResponsePart": { + "target": "com.amazonaws.bedrockagentruntime#TextResponsePart", + "traits": { + "smithy.api#documentation": "Contains metadata about a textual part of the generated response that is accompanied by a citation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains metadata about a part of the generated response that is accompanied by a citation.
This data type is used in the following API operations:
InvokeAgent response – in the generatedResponsePart field
RetrieveAndGenerate response – in the generatedResponsePart field
Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$ variable. For more information, see Use placeholder variables in the user guide.
The configuration details for the guardrail.
" + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrockagentruntime#InferenceConfig", + "traits": { + "smithy.api#documentation": "Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
" + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
" + } + }, + "performanceConfig": { + "target": "com.amazonaws.bedrockagentruntime#PerformanceConfiguration", + "traits": { + "smithy.api#documentation": "The latency configuration for the model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for response generation based on the knowledge base query results.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrockagentruntime#GetAgentMemory": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#GetAgentMemoryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#GetAgentMemoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the sessions stored in the memory of the agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentAliases/{agentAliasId}/memories" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxItems", + "items": "memoryContents" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetAgentMemoryRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The unique identifier of the agent to which the alias belongs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of an alias of an agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "memoryType": { + "target": "com.amazonaws.bedrockagentruntime#MemoryType", + "traits": { + "smithy.api#documentation": "The type of memory.
", + "smithy.api#httpQuery": "memoryType", + "smithy.api#required": {} + } + }, + "memoryId": { + "target": "com.amazonaws.bedrockagentruntime#MemoryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the memory.
", + "smithy.api#httpQuery": "memoryId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetAgentMemoryResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Contains details of the sessions stored in the memory
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetDocumentContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#GetDocumentContentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#GetDocumentContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the content of an ingested document from a knowledge base. Returns a pre-signed URL for secure document access.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/documents/{documentId}/content" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetDocumentContentRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that contains the document.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagentruntime#DataSourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source that contains the document.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documentId": { + "target": "com.amazonaws.bedrockagentruntime#DocumentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the document to retrieve content for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "outputFormat": { + "target": "com.amazonaws.bedrockagentruntime#DocumentOutputFormat", + "traits": { + "smithy.api#documentation": "The output format for the document content. RAW returns the original file. EXTRACTED returns parsed text as JSON. Defaults to RAW.
The MIME type of the document content. For RAW format, this is the original file type (for example, application/pdf). For EXTRACTED format, this is always application/json.
A pre-signed URL for downloading the document content. The URL expires after 5 minutes.
", + "smithy.api#required": {} + } + }, + "documentContentLength": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The size of the document content in bytes available at the pre-signed URL.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the flow definition snapshot used for a flow execution. The snapshot represents the flow metadata and definition as it existed at the time the execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow alias used for the flow execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshotResponse": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow alias used for the flow execution.
", + "smithy.api#required": {} + } + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagentruntime#Version", + "traits": { + "smithy.api#documentation": "The version of the flow used for the flow execution.
", + "smithy.api#required": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that's used by the flow execution.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The flow definition used for the flow execution, including the nodes, connections, and configuration at the time when the execution started.
The definition returns as a string that follows the structure of a FlowDefinition object.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetFlowExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#GetFlowExecutionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#GetFlowExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetFlowExecutionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow alias used for the execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow execution to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetFlowExecutionResponse": { + "type": "structure", + "members": { + "executionArn": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionStatus", + "traits": { + "smithy.api#documentation": "The current status of the flow execution.
Flow executions time out after 24 hours.
", + "smithy.api#required": {} + } + }, + "startedAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the flow execution started.
", + "smithy.api#required": {} + } + }, + "endedAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
" + } + }, + "errors": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionErrors", + "traits": { + "smithy.api#documentation": "A list of errors that occurred during the flow execution. Each error includes an error code, message, and the node where the error occurred, if applicable.
" + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow alias used for the execution.
", + "smithy.api#required": {} + } + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagentruntime#Version", + "traits": { + "smithy.api#documentation": "The version of the flow used for the execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetInvocationStep": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#GetInvocationStepRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#GetInvocationStepResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/sessions/{sessionIdentifier}/invocationSteps/{invocationStepId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetInvocationStepRequest": { + "type": "structure", + "members": { + "invocationIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#InvocationIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier for the invocation in UUID format.
", + "smithy.api#required": {} + } + }, + "invocationStepId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier (in UUID format) for the specific invocation step to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier for the invocation step's associated session. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The complete details of the requested invocation step.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#GetSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#GetSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/sessions/{sessionIdentifier}/" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetSessionRequest": { + "type": "structure", + "members": { + "sessionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the session to retrieve. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The unique identifier for the session in UUID format.
", + "smithy.api#required": {} + } + }, + "sessionArn": { + "target": "com.amazonaws.bedrockagentruntime#SessionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the session.
", + "smithy.api#required": {} + } + }, + "sessionStatus": { + "target": "com.amazonaws.bedrockagentruntime#SessionStatus", + "traits": { + "smithy.api#documentation": "The current status of the session.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the session was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the session was last modified.
", + "smithy.api#required": {} + } + }, + "sessionMetadata": { + "target": "com.amazonaws.bedrockagentruntime#SessionMetadataMap", + "traits": { + "smithy.api#documentation": "A map of key-value pairs containing attributes persisted across the session.
" + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see Amazon Bedrock session encryption.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuadrailAction": { + "type": "enum", + "members": { + "INTERVENED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERVENED" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailAction": { + "type": "enum", + "members": { + "INTERVENED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERVENED" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailAssessment": { + "type": "structure", + "members": { + "topicPolicy": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailTopicPolicyAssessment", + "traits": { + "smithy.api#documentation": "Topic policy details of the Guardrail.
" + } + }, + "contentPolicy": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailContentPolicyAssessment", + "traits": { + "smithy.api#documentation": "Content policy details of the Guardrail.
" + } + }, + "wordPolicy": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAssessment", + "traits": { + "smithy.api#documentation": "Word policy details of the Guardrail.
" + } + }, + "sensitiveInformationPolicy": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAssessment", + "traits": { + "smithy.api#documentation": "Sensitive Information policy details of Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Assessment details of the content analyzed by Guardrails.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailAssessmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailAssessment" + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailConfiguration": { + "type": "structure", + "members": { + "guardrailId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the guardrail.
", + "smithy.api#length": { + "max": 64 + }, + "smithy.api#pattern": "^[a-z0-9]+$", + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for the guardrail.
" + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailConfigurationWithArn": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailIdentifierWithArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the guardrail.
", + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for the guardrail.
" + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailContentFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailContentFilterType", + "traits": { + "smithy.api#documentation": "The type of content detected in the filter by the Guardrail.
" + } + }, + "confidence": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailContentFilterConfidence", + "traits": { + "smithy.api#documentation": "The confidence level regarding the content detected in the filter by the Guardrail.
" + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailContentPolicyAction", + "traits": { + "smithy.api#documentation": "The action placed on the content by the Guardrail filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the content filter used in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailContentFilterConfidence": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailContentFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailContentFilter" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailContentFilterType": { + "type": "enum", + "members": { + "INSULTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSULTS" + } + }, + "HATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HATE" + } + }, + "SEXUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEXUAL" + } + }, + "VIOLENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIOLENCE" + } + }, + "MISCONDUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISCONDUCT" + } + }, + "PROMPT_ATTACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROMPT_ATTACK" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailContentPolicyAction": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailContentPolicyAssessment": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailContentFilterList", + "traits": { + "smithy.api#documentation": "The filter details of the policy assessment used in the Guardrails filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the policy assessment in the Guardrails filter.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailCustomWord": { + "type": "structure", + "members": { + "match": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The match details for the custom word filter in the Guardrail.
" + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAction", + "traits": { + "smithy.api#documentation": "The action details for the custom word filter in the Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The custom word details for the filter in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailCustomWordList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailCustomWord" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailEvent": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuadrailAction", + "traits": { + "smithy.api#documentation": "The guardrail action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A guardrail event.
" + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailIdentifierWithArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailManagedWord": { + "type": "structure", + "members": { + "match": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The match details for the managed word filter in the Guardrail.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailManagedWordType", + "traits": { + "smithy.api#documentation": "The type details for the managed word filter in the Guardrail.
" + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAction", + "traits": { + "smithy.api#documentation": "The action details for the managed word filter in the Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The managed word details for the filter in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailManagedWordList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailManagedWord" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailManagedWordType": { + "type": "enum", + "members": { + "PROFANITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFANITY" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityType", + "traits": { + "smithy.api#documentation": "The type of PII the Guardrail filter has identified and removed.
" + } + }, + "match": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The match to settings in the Guardrail filter to identify and remove PII.
" + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAction", + "traits": { + "smithy.api#documentation": "The action of the Guardrail filter to identify and remove PII.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Guardrail filter to identify and remove personally identifiable information (PII).
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityFilter" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityType": { + "type": "enum", + "members": { + "ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDRESS" + } + }, + "AGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGE" + } + }, + "AWS_ACCESS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_ACCESS_KEY" + } + }, + "AWS_SECRET_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SECRET_KEY" + } + }, + "CA_HEALTH_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_HEALTH_NUMBER" + } + }, + "CA_SOCIAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_SOCIAL_INSURANCE_NUMBER" + } + }, + "CREDIT_DEBIT_CARD_CVV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_CVV" + } + }, + "CREDIT_DEBIT_CARD_EXPIRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_EXPIRY" + } + }, + "CREDIT_DEBIT_CARD_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_NUMBER" + } + }, + "DRIVER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRIVER_ID" + } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + }, + "INTERNATIONAL_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNATIONAL_BANK_ACCOUNT_NUMBER" + } + }, + "IP_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_ADDRESS" + } + }, + "LICENSE_PLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LICENSE_PLATE" + } + }, + "MAC_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAC_ADDRESS" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD" + } + }, + "PHONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE" + } + }, + "PIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PIN" + } + }, + "SWIFT_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SWIFT_CODE" + } + }, + "UK_NATIONAL_HEALTH_SERVICE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_HEALTH_SERVICE_NUMBER" + } + }, + "UK_NATIONAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_INSURANCE_NUMBER" + } + }, + "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" + } + }, + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USERNAME" + } + }, + "US_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_BANK_ACCOUNT_NUMBER" + } + }, + "US_BANK_ROUTING_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_BANK_ROUTING_NUMBER" + } + }, + "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" + } + }, + "US_PASSPORT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_PASSPORT_NUMBER" + } + }, + "US_SOCIAL_SECURITY_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_SOCIAL_SECURITY_NUMBER" + } + }, + "VEHICLE_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VEHICLE_IDENTIFICATION_NUMBER" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailRegexFilter": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name details for the regex filter used in the Guardrail.
" + } + }, + "regex": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The regex details for the regex filter used in the Guardrail.
" + } + }, + "match": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The match details for the regex filter used in the Guardrail.
" + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAction", + "traits": { + "smithy.api#documentation": "The action details for the regex filter used in the Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details for the regex filter used in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailRegexFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailRegexFilter" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAction": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + }, + "ANONYMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANONYMIZED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAssessment": { + "type": "structure", + "members": { + "piiEntities": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityFilterList", + "traits": { + "smithy.api#documentation": "The details of the PII entities used in the sensitive policy assessment for the Guardrail.
" + } + }, + "regexes": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailRegexFilterList", + "traits": { + "smithy.api#documentation": "The details of the regexes used in the sensitive policy assessment for the Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the sensitive policy assessment used in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailTopic": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name details on a specific topic in the Guardrail.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailTopicType", + "traits": { + "smithy.api#documentation": "The type details on a specific topic in the Guardrail.
" + } + }, + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailTopicPolicyAction", + "traits": { + "smithy.api#documentation": "The action details on a specific topic in the Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details for a specific topic defined in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailTopicList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailTopic" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailTopicPolicyAction": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailTopicPolicyAssessment": { + "type": "structure", + "members": { + "topics": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailTopicList", + "traits": { + "smithy.api#documentation": "The topic details of the policy assessment used in the Guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the policy assessment used in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailTopicType": { + "type": "enum", + "members": { + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailTrace": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailAction", + "traits": { + "smithy.api#documentation": "The trace action details used with the Guardrail.
" + } + }, + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The details of the trace Id used in the Guardrail Trace.
" + } + }, + "inputAssessments": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailAssessmentList", + "traits": { + "smithy.api#documentation": "The details of the input assessments used in the Guardrail Trace.
" + } + }, + "outputAssessments": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailAssessmentList", + "traits": { + "smithy.api#documentation": "The details of the output assessments used in the Guardrail Trace.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the Guardrail output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The trace details used in the Guardrail.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAction": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAssessment": { + "type": "structure", + "members": { + "customWords": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailCustomWordList", + "traits": { + "smithy.api#documentation": "The custom word details for words defined in the Guardrail filter.
" + } + }, + "managedWordLists": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailManagedWordList", + "traits": { + "smithy.api#documentation": "The managed word lists for words defined in the Guardrail filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The assessment details for words defined in the Guardrail filter.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Identifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ImageBlock": { + "type": "structure", + "members": { + "format": { + "target": "com.amazonaws.bedrockagentruntime#ImageFormat", + "traits": { + "smithy.api#documentation": "The format of the image.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagentruntime#ImageSource", + "traits": { + "smithy.api#documentation": "The source for the image.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Image content for an invocation step.
" + } + }, + "com.amazonaws.bedrockagentruntime#ImageFormat": { + "type": "enum", + "members": { + "PNG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "png" + } + }, + "JPEG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jpeg" + } + }, + "GIF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gif" + } + }, + "WEBP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "webp" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#ImageInput": { + "type": "structure", + "members": { + "format": { + "target": "com.amazonaws.bedrockagentruntime#ImageInputFormat", + "traits": { + "smithy.api#documentation": "The type of image in the result.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagentruntime#ImageInputSource", + "traits": { + "smithy.api#documentation": "The source of the image in the result.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an image in the result from a function in the action group invocation. You can specify images only when the function is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
" + } + }, + "com.amazonaws.bedrockagentruntime#ImageInputFormat": { + "type": "enum", + "members": { + "PNG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "png" + } + }, + "JPEG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jpeg" + } + }, + "GIF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gif" + } + }, + "WEBP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "webp" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#ImageInputSource": { + "type": "union", + "members": { + "bytes": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.
", + "smithy.api#length": { + "min": 1 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the source of an input image in the result from a function in the action group invocation.
" + } + }, + "com.amazonaws.bedrockagentruntime#ImageInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#ImageInput" + } + }, + "com.amazonaws.bedrockagentruntime#ImageSource": { + "type": "union", + "members": { + "bytes": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.
", + "smithy.api#length": { + "min": 1 + } + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagentruntime#S3Location", + "traits": { + "smithy.api#documentation": "The path to the Amazon S3 bucket where the image is stored.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The source for an image.
" + } + }, + "com.amazonaws.bedrockagentruntime#ImplicitFilterConfiguration": { + "type": "structure", + "members": { + "metadataAttributes": { + "target": "com.amazonaws.bedrockagentruntime#MetadataAttributeSchemaList", + "traits": { + "smithy.api#documentation": "Metadata that can be used in a filter.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The model that generates the filter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for implicit filtering, where a model generates a metadata filter based on the prompt.
" + } + }, + "com.amazonaws.bedrockagentruntime#InferenceConfig": { + "type": "structure", + "members": { + "textInferenceConfig": { + "target": "com.amazonaws.bedrockagentruntime#TextInferenceConfig", + "traits": { + "smithy.api#documentation": "Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for inference settings when generating responses using RetrieveAndGenerate.
" + } + }, + "com.amazonaws.bedrockagentruntime#InferenceConfiguration": { + "type": "structure", + "members": { + "temperature": { + "target": "com.amazonaws.bedrockagentruntime#Temperature", + "traits": { + "smithy.api#documentation": "The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagentruntime#TopP", + "traits": { + "smithy.api#documentation": "While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
The maximum number of tokens allowed in the generated response.
" + } + }, + "stopSequences": { + "target": "com.amazonaws.bedrockagentruntime#StopSequences", + "traits": { + "smithy.api#documentation": "A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
" + } + }, + "com.amazonaws.bedrockagentruntime#InferenceResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#InvokeAgent" + } + ] + }, + "com.amazonaws.bedrockagentruntime#InlineAgentFilePart": { + "type": "structure", + "members": { + "files": { + "target": "com.amazonaws.bedrockagentruntime#OutputFiles", + "traits": { + "smithy.api#documentation": "Files containing intermediate response for the user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains intermediate response for code interpreter if any files have been generated.
" + } + }, + "com.amazonaws.bedrockagentruntime#InlineAgentPayloadPart": { + "type": "structure", + "members": { + "bytes": { + "target": "com.amazonaws.bedrockagentruntime#PartBody", + "traits": { + "smithy.api#documentation": "A part of the agent response in bytes.
" + } + }, + "attribution": { + "target": "com.amazonaws.bedrockagentruntime#Attribution", + "traits": { + "smithy.api#documentation": "Contains citations for a part of an agent response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a part of an agent response and citations for it.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#InlineAgentResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#InvokeInlineAgent" + } + ] + }, + "com.amazonaws.bedrockagentruntime#InlineAgentResponseStream": { + "type": "union", + "members": { + "chunk": { + "target": "com.amazonaws.bedrockagentruntime#InlineAgentPayloadPart", + "traits": { + "smithy.api#documentation": "Contains a part of an agent response and citations for it.
" + } + }, + "trace": { + "target": "com.amazonaws.bedrockagentruntime#InlineAgentTracePart", + "traits": { + "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" + } + }, + "returnControl": { + "target": "com.amazonaws.bedrockagentruntime#InlineAgentReturnControlPayload", + "traits": { + "smithy.api#documentation": "Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "An internal server error occurred. Retry your request.
" + } + }, + "validationException": { + "target": "com.amazonaws.bedrockagentruntime#ValidationException", + "traits": { + "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
" + } + }, + "resourceNotFoundException": { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", + "traits": { + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" + } + }, + "serviceQuotaExceededException": { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", + "traits": { + "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
" + } + }, + "throttlingException": { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
" + } + }, + "accessDeniedException": { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", + "traits": { + "smithy.api#documentation": "The request is denied because of missing access permissions. Check your permissions and retry your request.
" + } + }, + "conflictException": { + "target": "com.amazonaws.bedrockagentruntime#ConflictException", + "traits": { + "smithy.api#documentation": "There was a conflict performing an operation. Resolve the conflict and retry your request.
" + } + }, + "dependencyFailedException": { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", + "traits": { + "smithy.api#documentation": "There was an issue with a dependency. Check the resource configurations and retry the request.
" + } + }, + "badGatewayException": { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", + "traits": { + "smithy.api#documentation": "There was an issue with a dependency due to a server issue. Retry your request.
" + } + }, + "files": { + "target": "com.amazonaws.bedrockagentruntime#InlineAgentFilePart", + "traits": { + "smithy.api#documentation": "Contains intermediate response for code interpreter if any files have been generated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The response from invoking the agent and associated citations and trace information.
", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockagentruntime#InlineAgentReturnControlPayload": { + "type": "structure", + "members": { + "invocationInputs": { + "target": "com.amazonaws.bedrockagentruntime#InvocationInputs", + "traits": { + "smithy.api#documentation": "A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
" + } + }, + "invocationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the InvokeAgent response API operation.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#InlineAgentTracePart": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the session with the agent.
" + } + }, + "trace": { + "target": "com.amazonaws.bedrockagentruntime#Trace", + "traits": { + "smithy.api#documentation": "Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
" + } + }, + "callerChain": { + "target": "com.amazonaws.bedrockagentruntime#CallerChain", + "traits": { + "smithy.api#documentation": "The caller chain for the trace part.
" + } + }, + "eventTime": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time that trace occurred.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagentruntime#Name", + "traits": { + "smithy.api#documentation": "The collaborator name for the trace part.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#InlineBedrockModelConfigurations": { + "type": "structure", + "members": { + "performanceConfig": { + "target": "com.amazonaws.bedrockagentruntime#PerformanceConfiguration", + "traits": { + "smithy.api#documentation": "The latency configuration for the model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for a model called with InvokeInlineAgent.
" + } + }, + "com.amazonaws.bedrockagentruntime#InlineSessionState": { + "type": "structure", + "members": { + "sessionAttributes": { + "target": "com.amazonaws.bedrockagentruntime#SessionAttributesMap", + "traits": { + "smithy.api#documentation": "Contains attributes that persist across a session and the values of those attributes.
" + } + }, + "promptSessionAttributes": { + "target": "com.amazonaws.bedrockagentruntime#PromptSessionAttributesMap", + "traits": { + "smithy.api#documentation": "Contains attributes that persist across a session and the values of those attributes.
" + } + }, + "returnControlInvocationResults": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults", + "traits": { + "smithy.api#documentation": "Contains information about the results from the action group invocation. For more information, see Return control to the agent developer.
If you include this field in the sessionState field, the inputText field will be ignored.
The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeInlineAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer.
Contains information about the files used by code interpreter.
" + } + }, + "conversationHistory": { + "target": "com.amazonaws.bedrockagentruntime#ConversationHistory", + "traits": { + "smithy.api#documentation": "Contains the conversation history that persist across sessions.
" + } + } + }, + "traits": { + "smithy.api#documentation": " Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeInlineAgent request. Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. For more information, see Control session context
The name of the source file.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagentruntime#FileSource", + "traits": { + "smithy.api#documentation": "Specifies where the files are located.
", + "smithy.api#required": {} + } + }, + "useCase": { + "target": "com.amazonaws.bedrockagentruntime#FileUseCase", + "traits": { + "smithy.api#documentation": "Specifies how the source files will be used by the code interpreter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of the source files.
" + } + }, + "com.amazonaws.bedrockagentruntime#InputFiles": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#InputFile" + } + }, + "com.amazonaws.bedrockagentruntime#InputImage": { + "type": "structure", + "members": { + "format": { + "target": "com.amazonaws.bedrockagentruntime#InputImageFormat", + "traits": { + "smithy.api#documentation": "The format of the input image. Supported formats include png, gif, jpeg, and webp.
", + "smithy.api#required": {} + } + }, + "inlineContent": { + "target": "com.amazonaws.bedrockagentruntime#ByteContentBlob", + "traits": { + "smithy.api#documentation": "The base64-encoded image data for inline image content. Maximum size is 5MB.
", + "smithy.api#length": { + "min": 1, + "max": 5242880 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the image data for multimodal knowledge base queries, including format and content.
This data type is used in the following API operations:
Retrieve request – in the image field
Contains information about the text prompt to optimize.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the prompt to optimize.
" + } + }, + "com.amazonaws.bedrockagentruntime#InputQueryType": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#InputText": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 25000000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Instruction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 40 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + }, + "reason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for the exception. If the reason is BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE, the model invocation service is unavailable. Retry your request.
An internal server error occurred. Retry your request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockagentruntime#InvocationDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagentruntime#InvocationIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.bedrockagentruntime#InvocationInput": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace.
" + } + }, + "invocationType": { + "target": "com.amazonaws.bedrockagentruntime#InvocationType", + "traits": { + "smithy.api#documentation": "Specifies whether the agent is invoking an action group or a knowledge base.
" + } + }, + "actionGroupInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput", + "traits": { + "smithy.api#documentation": "Contains information about the action group to be invoked.
" + } + }, + "knowledgeBaseLookupInput": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInput", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base to look up and the query to be made.
" + } + }, + "codeInterpreterInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationInput", + "traits": { + "smithy.api#documentation": "Contains information about the code interpreter to be invoked.
" + } + }, + "agentCollaboratorInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorInvocationInput", + "traits": { + "smithy.api#documentation": "The collaborator's invocation input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information pertaining to the action group or knowledge base that is being invoked.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#InvocationInputMember": { + "type": "union", + "members": { + "apiInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#ApiInvocationInput", + "traits": { + "smithy.api#documentation": "Contains information about the API operation that the agent predicts should be called.
" + } + }, + "functionInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#FunctionInvocationInput", + "traits": { + "smithy.api#documentation": "Contains information about the function that the agent predicts should be called.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the API operation or function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
The result from the API response from the action group invocation.
" + } + }, + "functionResult": { + "target": "com.amazonaws.bedrockagentruntime#FunctionResult", + "traits": { + "smithy.api#documentation": "The result from the function from the action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A result from the invocation of an action. For more information, see Return control to the agent developer and Control session context.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrockagentruntime#InvocationStep": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier of the session containing the invocation step.
", + "smithy.api#required": {} + } + }, + "invocationId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier (in UUID format) for the invocation that includes the invocation step.
", + "smithy.api#required": {} + } + }, + "invocationStepId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier (in UUID format) for the invocation step.
", + "smithy.api#required": {} + } + }, + "invocationStepTime": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the invocation step was created.
", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.bedrockagentruntime#InvocationStepPayload", + "traits": { + "smithy.api#documentation": "Payload content, such as text and images, for the invocation step.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stores fine-grained state checkpoints, including text and images, for each interaction in an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" + } + }, + "com.amazonaws.bedrockagentruntime#InvocationStepPayload": { + "type": "union", + "members": { + "contentBlocks": { + "target": "com.amazonaws.bedrockagentruntime#BedrockSessionContentBlocks", + "traits": { + "smithy.api#documentation": "The content for the invocation step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Payload content, such as text and images, for the invocation step.
" + } + }, + "com.amazonaws.bedrockagentruntime#InvocationStepResource": { + "type": "resource", + "identifiers": { + "sessionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier" + }, + "invocationIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#InvocationIdentifier" + }, + "invocationStepId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentruntime#PutInvocationStep" + }, + "read": { + "target": "com.amazonaws.bedrockagentruntime#GetInvocationStep" + }, + "list": { + "target": "com.amazonaws.bedrockagentruntime#ListInvocationSteps" + } + }, + "com.amazonaws.bedrockagentruntime#InvocationStepSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#InvocationStepSummary" + } + }, + "com.amazonaws.bedrockagentruntime#InvocationStepSummary": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier for the session associated with the invocation step.
", + "smithy.api#required": {} + } + }, + "invocationId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "A unique identifier for the invocation in UUID format.
", + "smithy.api#required": {} + } + }, + "invocationStepId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier (in UUID format) for the invocation step.
", + "smithy.api#required": {} + } + }, + "invocationStepTime": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the invocation step was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" + } + }, + "com.amazonaws.bedrockagentruntime#InvocationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#InvocationSummary" + } + }, + "com.amazonaws.bedrockagentruntime#InvocationSummary": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier for the session associated with the invocation.
", + "smithy.api#required": {} + } + }, + "invocationId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "A unique identifier for the invocation in UUID format.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the invocation was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" + } + }, + "com.amazonaws.bedrockagentruntime#InvocationType": { + "type": "enum", + "members": { + "ACTION_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTION_GROUP" + } + }, + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE" + } + }, + "FINISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINISH" + } + }, + "ACTION_GROUP_CODE_INTERPRETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTION_GROUP_CODE_INTERPRETER" + } + }, + "AGENT_COLLABORATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_COLLABORATOR" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#InvokeAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#InvokeAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#InvokeAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ModelNotReadyException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sends a prompt for the agent to process and respond to. Note the following fields for the request:
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response contains both chunk and trace attributes.
The final response is returned in the bytes field of the chunk object. The InvokeAgent returns one chunk for the entire interaction.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
Contains parameters that specify various attributes of the session. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
The unique identifier of the agent to use.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", + "traits": { + "smithy.api#documentation": "The alias of the agent to use.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the session. Use the same value across requests to continue the same conversation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "endSession": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to end the session with the agent or not.
" + } + }, + "enableTrace": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
" + } + }, + "inputText": { + "target": "com.amazonaws.bedrockagentruntime#InputText", + "traits": { + "smithy.api#documentation": "The prompt text to send the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
The unique identifier of the agent memory.
" + } + }, + "bedrockModelConfigurations": { + "target": "com.amazonaws.bedrockagentruntime#BedrockModelConfigurations", + "traits": { + "smithy.api#documentation": "Model performance settings for the request.
" + } + }, + "streamingConfigurations": { + "target": "com.amazonaws.bedrockagentruntime#StreamingConfigurations", + "traits": { + "smithy.api#documentation": "Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
Specifies parameters that control how the service populates the agent prompt for an InvokeAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
The ARN of the resource making the request.
", + "smithy.api#httpHeader": "x-amz-source-arn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#InvokeAgentResponse": { + "type": "structure", + "members": { + "completion": { + "target": "com.amazonaws.bedrockagentruntime#ResponseStream", + "traits": { + "smithy.api#documentation": "The agent's response to the user prompt.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.bedrockagentruntime#MimeType", + "traits": { + "smithy.api#documentation": "The MIME type of the input data in the request. The default value is application/json.
The unique identifier of the session with the agent.
", + "smithy.api#httpHeader": "x-amz-bedrock-agent-session-id", + "smithy.api#required": {} + } + }, + "memoryId": { + "target": "com.amazonaws.bedrockagentruntime#MemoryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent memory.
", + "smithy.api#httpHeader": "x-amz-bedrock-agent-memory-id" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#InvokeFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#InvokeFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#InvokeFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeFlow.
The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "inputs": { + "target": "com.amazonaws.bedrockagentruntime#FlowInputs", + "traits": { + "smithy.api#documentation": "A list of objects, each containing information about an input into the flow.
", + "smithy.api#required": {} + } + }, + "enableTrace": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
" + } + }, + "modelPerformanceConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ModelPerformanceConfiguration", + "traits": { + "smithy.api#documentation": "Model performance settings for the request.
" + } + }, + "executionId": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionId", + "traits": { + "smithy.api#documentation": "The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#InvokeFlowResponse": { + "type": "structure", + "members": { + "responseStream": { + "target": "com.amazonaws.bedrockagentruntime#FlowResponseStream", + "traits": { + "smithy.api#documentation": "The output of the flow, returned as a stream. If there's an error, the error is returned.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionId", + "traits": { + "smithy.api#documentation": "The unique identifier for the current flow execution.
", + "smithy.api#httpHeader": "x-amz-bedrock-flow-execution-id" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#InvokeInlineAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#InvokeInlineAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#InvokeInlineAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.
Specify the following fields for security purposes.
(Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.
" + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagentruntime#ModelIdentifier", + "traits": { + "smithy.api#documentation": " The model identifier (ID) of the model to use for orchestration by the inline agent. For example, meta.llama3-1-70b-instruct-v1:0.
The instructions that tell the inline agent what it should do and how it should interact with users.
", + "smithy.api#required": {} + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagentruntime#SessionTTL", + "traits": { + "smithy.api#documentation": " The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.
" + } + }, + "actionGroups": { + "target": "com.amazonaws.bedrockagentruntime#AgentActionGroups", + "traits": { + "smithy.api#documentation": "A list of action groups with each action group defining the action the inline agent needs to carry out.
" + } + }, + "knowledgeBases": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBases", + "traits": { + "smithy.api#documentation": "Contains information of the knowledge bases to associate with.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailConfigurationWithArn", + "traits": { + "smithy.api#documentation": "The guardrails to assign to the inline agent.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
" + } + }, + "agentCollaboration": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboration", + "traits": { + "smithy.api#documentation": "Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.
" + } + }, + "collaboratorConfigurations": { + "target": "com.amazonaws.bedrockagentruntime#CollaboratorConfigurations", + "traits": { + "smithy.api#documentation": "Settings for an inline agent collaborator called with InvokeInlineAgent.
" + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagentruntime#Name", + "traits": { + "smithy.api#documentation": "The name for the agent.
" + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the session. Use the same value across requests to continue the same conversation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "endSession": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to end the session with the inline agent or not.
" + } + }, + "enableTrace": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.
" + } + }, + "inputText": { + "target": "com.amazonaws.bedrockagentruntime#InputText", + "traits": { + "smithy.api#documentation": "The prompt text to send to the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
Specifies parameters that control how the service populates the agent prompt for an InvokeInlineAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
List of collaborator inline agents.
" + } + }, + "bedrockModelConfigurations": { + "target": "com.amazonaws.bedrockagentruntime#InlineBedrockModelConfigurations", + "traits": { + "smithy.api#documentation": "Model settings for the request.
" + } + }, + "orchestrationType": { + "target": "com.amazonaws.bedrockagentruntime#OrchestrationType", + "traits": { + "smithy.api#documentation": "Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
" + } + }, + "customOrchestration": { + "target": "com.amazonaws.bedrockagentruntime#CustomOrchestration", + "traits": { + "smithy.api#documentation": "Contains details of the custom orchestration configured for the agent.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#InvokeInlineAgentResponse": { + "type": "structure", + "members": { + "completion": { + "target": "com.amazonaws.bedrockagentruntime#InlineAgentResponseStream", + "traits": { + "smithy.api#documentation": "The inline agent's response to the user prompt.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.bedrockagentruntime#MimeType", + "traits": { + "smithy.api#documentation": "The MIME type of the input data in the request. The default value is application/json.
", + "smithy.api#httpHeader": "x-amzn-bedrock-agent-content-type", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the session with the agent.
", + "smithy.api#httpHeader": "x-amz-bedrock-agent-session-id", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBase": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", + "traits": { + "smithy.api#documentation": "The unique identifier for a knowledge base associated with the inline agent.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentruntime#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the knowledge base associated with the inline agent.
", + "smithy.api#required": {} + } + }, + "retrievalConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "The configurations to apply to the knowledge base during query. For more information, see Query configurations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the knowledge base associated withe inline agent.
" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", + "traits": { + "smithy.api#documentation": "The unique identifier for a knowledge base attached to the agent.
", + "smithy.api#required": {} + } + }, + "retrievalConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "The configurations to apply to the knowledge base during query. For more information, see Query configurations.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations to apply to a knowledge base attached to the agent during query. For more information, see Knowledge base retrieval configurations.
" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 2048 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]{10}$|^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:knowledge-base/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInput": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInputString", + "traits": { + "smithy.api#documentation": "The query made to the knowledge base.
" + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagentruntime#TraceKnowledgeBaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to look up.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base to look up and the query to be made.
" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInputString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupOutput": { + "type": "structure", + "members": { + "retrievedReferences": { + "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences", + "traits": { + "smithy.api#documentation": "Contains metadata about the sources cited for the generated response.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the knowledge base output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the results from looking up the knowledge base.
" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseQuery": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseQueryType", + "traits": { + "smithy.api#default": "TEXT", + "smithy.api#documentation": "The type of query being performed.
" + } + }, + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The text of the query made to the knowledge base.
", + "smithy.api#length": { + "max": 20000 + } + } + }, + "image": { + "target": "com.amazonaws.bedrockagentruntime#InputImage", + "traits": { + "smithy.api#documentation": "An image to include in the knowledge base query for multimodal retrieval.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the query made to the knowledge base.
This data type is used in the following API operations:
Retrieve request – in the retrievalQuery field
Contains details about how the results from the vector search should be returned. For more information, see Query configurations.
" + } + }, + "managedSearchConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ManagedSearchConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for managed search. For more information, see Query configurations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for knowledge base query. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the retrievalConfiguration field
RetrieveAndGenerate request – in the retrievalConfiguration field
Contains information about the content of the chunk.
", + "smithy.api#required": {} + } + }, + "location": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation", + "traits": { + "smithy.api#documentation": "Contains information about the location of the data source.
" + } + }, + "score": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The level of relevance of the result to the query.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultMetadata", + "traits": { + "smithy.api#documentation": "Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
" + } + }, + "documentId": { + "target": "com.amazonaws.bedrockagentruntime#DocumentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the document. Use with GetDocumentContent to retrieve the full document.
Details about a result from querying the knowledge base.
This data type is used in the following API operations:
Retrieve response – in the retrievalResults field
The unique identifier of the knowledge base that is queried.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the foundation model or inference profile used to generate a response.
", + "smithy.api#required": {} + } + }, + "retrievalConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for how to retrieve and return the knowledge base query.
" + } + }, + "generationConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#GenerationConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for response generation based on the knowledge base query results.
" + } + }, + "orchestrationConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#OrchestrationConfiguration", + "traits": { + "smithy.api#documentation": "Settings for how the model processes the prompt prior to retrieval and generation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the resource being queried.
This data type is used in the following API operations:
Retrieve request – in the knowledgeBaseConfiguration field
RetrieveAndGenerate request – in the knowledgeBaseConfiguration field
The unique identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "retrievalOverrides": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalOverrides", + "traits": { + "smithy.api#documentation": "Overrides for retrieval behavior such as filters and result limits.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for retrieving from a Bedrock knowledge base.
" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseVectorSearchConfiguration": { + "type": "structure", + "members": { + "numberOfResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 5, + "smithy.api#documentation": "The number of source chunks to retrieve.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "overrideSearchType": { + "target": "com.amazonaws.bedrockagentruntime#SearchType", + "traits": { + "smithy.api#documentation": "By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.
Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
" + } + }, + "rerankingConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#VectorSearchRerankingConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for reranking the retrieved results. For more information, see Improve the relevance of query responses with a reranker model.
" + } + }, + "implicitFilterConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ImplicitFilterConfiguration", + "traits": { + "smithy.api#documentation": "Settings for implicit filtering.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations for how to perform the search query and return results. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the vectorSearchConfiguration field
RetrieveAndGenerate request – in the vectorSearchConfiguration field
Lists events that occurred during a flow execution. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow alias used for the execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentruntime#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of events to return in a single response. If more events exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next set of results. This value is returned in the response if more results are available.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "eventType": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionEventType", + "traits": { + "smithy.api#documentation": "The type of events to retrieve. Specify Node for node-level events or Flow for flow-level events.
A list of events that occurred during the flow execution. Events can include node inputs and outputs, flow inputs and outputs, condition results, and failure events.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next set of results. This value is returned if more results are available.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#ListFlowExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#ListFlowExecutionsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#ListFlowExecutionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN).
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The unique identifier of the flow to list executions for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow alias to list executions for.
", + "smithy.api#httpQuery": "flowAliasIdentifier" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentruntime#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of flow executions to return in a single response. If more executions exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
A token to retrieve the next set of results. This value is returned in the response if more results are available.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#ListFlowExecutionsResponse": { + "type": "structure", + "members": { + "flowExecutionSummaries": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionSummaries", + "traits": { + "smithy.api#documentation": "A list of flow execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next set of results. This value is returned if more results are available.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#ListInvocationSteps": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#ListInvocationStepsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#ListInvocationStepsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/sessions/{sessionIdentifier}/invocationSteps/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "invocationStepSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#ListInvocationStepsRequest": { + "type": "structure", + "members": { + "invocationIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#InvocationIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier (in UUID format) for the invocation to list invocation steps for.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The unique identifier for the session associated with the invocation steps. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
A list of summaries for each invocation step associated with a session and if you specified it, an invocation within the session.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/sessions/{sessionIdentifier}/invocations/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "invocationSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#ListInvocationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The unique identifier for the session to list invocations for. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
A list of invocation summaries associated with the session.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/sessions/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "sessionSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#ListSessionsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagentruntime#MaxResults", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of summaries for each session in your Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
List all the tags for the resource you specify.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagentruntime#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which to list tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.bedrockagentruntime#TagsMap", + "traits": { + "smithy.api#documentation": "The key-value pairs for the tags associated with the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#ManagedSearchBedrockRerankingConfiguration": { + "type": "structure", + "members": { + "modelConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ManagedSearchBedrockRerankingModelConfiguration", + "traits": { + "smithy.api#documentation": "The model configuration containing the model ARN for reranking.
", + "smithy.api#required": {} + } + }, + "numberOfRerankedResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of results to return after reranking.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#MetadataConfigurationForReranking", + "traits": { + "smithy.api#documentation": "The metadata configuration for reranking.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a Bedrock reranking model used in managed search.
" + } + }, + "com.amazonaws.bedrockagentruntime#ManagedSearchBedrockRerankingModelConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrockagentruntime#BedrockRerankingModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the Bedrock reranking model.
", + "smithy.api#required": {} + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "Additional request fields to pass to the reranking model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Model configuration for a Bedrock reranking model used in managed search.
" + } + }, + "com.amazonaws.bedrockagentruntime#ManagedSearchConfiguration": { + "type": "structure", + "members": { + "numberOfResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of results to retrieve.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "filter": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalFilter" + }, + "rerankingModelType": { + "target": "com.amazonaws.bedrockagentruntime#RerankingModelType", + "traits": { + "smithy.api#documentation": "The type of reranking model to use when reranking results retrieved from the managed search. Use CUSTOM to specify a model, MANAGED to use the service default, or NONE to disable reranking.
Contains configurations for reranking the results retrieved from the managed search.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for managed search in a knowledge base. Managed search automatically determines the best search strategy based on your data store configuration.
" + } + }, + "com.amazonaws.bedrockagentruntime#ManagedSearchRerankingConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#ManagedSearchRerankingConfigurationType", + "traits": { + "smithy.api#documentation": "The type of reranking configuration.
", + "smithy.api#required": {} + } + }, + "bedrockRerankingConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ManagedSearchBedrockRerankingConfiguration", + "traits": { + "smithy.api#documentation": "The Bedrock reranking model configuration for managed search.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for the reranking model used in managed search.
" + } + }, + "com.amazonaws.bedrockagentruntime#ManagedSearchRerankingConfigurationType": { + "type": "enum", + "members": { + "BEDROCK_RERANKING_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_RERANKING_MODEL" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of reranking configuration for managed search.
" + } + }, + "com.amazonaws.bedrockagentruntime#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Max Results.", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagentruntime#MaxTokens": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65536 + } + } + }, + "com.amazonaws.bedrockagentruntime#MaximumLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 8192 + } + } + }, + "com.amazonaws.bedrockagentruntime#Memories": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Memory" + } + }, + "com.amazonaws.bedrockagentruntime#Memory": { + "type": "union", + "members": { + "sessionSummary": { + "target": "com.amazonaws.bedrockagentruntime#MemorySessionSummary", + "traits": { + "smithy.api#documentation": "Contains summary of a session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains sessions summaries.
" + } + }, + "com.amazonaws.bedrockagentruntime#MemoryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._:-]+$" + } + }, + "com.amazonaws.bedrockagentruntime#MemoryResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#DeleteAgentMemory" + }, + { + "target": "com.amazonaws.bedrockagentruntime#GetAgentMemory" + } + ] + }, + "com.amazonaws.bedrockagentruntime#MemorySessionSummary": { + "type": "structure", + "members": { + "memoryId": { + "target": "com.amazonaws.bedrockagentruntime#MemoryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the memory where the session summary is stored.
" + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "The identifier for this session.
" + } + }, + "sessionStartTime": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The start time for this session.
" + } + }, + "sessionExpiryTime": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time when the memory duration for the session is set to end.
" + } + }, + "summaryText": { + "target": "com.amazonaws.bedrockagentruntime#SummaryText", + "traits": { + "smithy.api#documentation": "The summarized text for this session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of a session summary.
" + } + }, + "com.amazonaws.bedrockagentruntime#MemoryType": { + "type": "enum", + "members": { + "SESSION_SUMMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SESSION_SUMMARY" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#Message": { + "type": "structure", + "members": { + "role": { + "target": "com.amazonaws.bedrockagentruntime#ConversationRole", + "traits": { + "smithy.api#documentation": "The message's role.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#ContentBlocks", + "traits": { + "smithy.api#documentation": "The message's content.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a message.
" + } + }, + "com.amazonaws.bedrockagentruntime#Messages": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Message" + } + }, + "com.amazonaws.bedrockagentruntime#Metadata": { + "type": "structure", + "members": { + "startTime": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "In the final response, startTime is the start time of the agent invocation operation.
In the final response, endTime is the end time of the agent invocation operation.
The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter). It represents how long the individual invocation took.
" + } + }, + "operationTotalTimeMs": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The total time it took for the agent to complete execution. This field is only set for the final response.
" + } + }, + "clientRequestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique identifier associated with the downstream invocation. This ID can be used for tracing, debugging, and identifying specific invocations in customer logs or systems.
" + } + }, + "usage": { + "target": "com.amazonaws.bedrockagentruntime#Usage", + "traits": { + "smithy.api#documentation": "Specific to model invocation and contains details about the usage of a foundation model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the execution process for different types of invocations, such as model invocation, knowledge base invocation, agent collaborator invocation, guardrail invocation, and code interpreter Invocation.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#MetadataAttributeSchema": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The attribute's key.
", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#AttributeType", + "traits": { + "smithy.api#documentation": "The attribute's type.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The attribute's description.
", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a metadata attribute.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#MetadataAttributeSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#MetadataAttributeSchema" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bedrockagentruntime#MetadataConfigurationForReranking": { + "type": "structure", + "members": { + "selectionMode": { + "target": "com.amazonaws.bedrockagentruntime#RerankingMetadataSelectionMode", + "traits": { + "smithy.api#documentation": "Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify SELECTIVE, include the selectiveModeConfiguration field.
Contains configurations for the metadata fields to include or exclude when considering reranking.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the metadata to use in reranking.
" + } + }, + "com.amazonaws.bedrockagentruntime#MimeType": { + "type": "string" + }, + "com.amazonaws.bedrockagentruntime#ModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+))$|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)$" + } + }, + "com.amazonaws.bedrockagentruntime#ModelInvocationInput": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace.
" + } + }, + "text": { + "target": "com.amazonaws.bedrockagentruntime#PromptText", + "traits": { + "smithy.api#documentation": "The text that prompted the agent at this step.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#PromptType", + "traits": { + "smithy.api#documentation": "The step in the agent sequence.
" + } + }, + "overrideLambda": { + "target": "com.amazonaws.bedrockagentruntime#LambdaArn", + "traits": { + "smithy.api#documentation": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
" + } + }, + "promptCreationMode": { + "target": "com.amazonaws.bedrockagentruntime#CreationMode", + "traits": { + "smithy.api#documentation": "Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.
Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
" + } + }, + "parserMode": { + "target": "com.amazonaws.bedrockagentruntime#CreationMode", + "traits": { + "smithy.api#documentation": "Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.
The identifier of a foundation model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the pre-processing step.
The type matches the agent step.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.
", + "smithy.api#error": "client", + "smithy.api#httpError": 424 + } + }, + "com.amazonaws.bedrockagentruntime#ModelPerformanceConfiguration": { + "type": "structure", + "members": { + "performanceConfig": { + "target": "com.amazonaws.bedrockagentruntime#PerformanceConfiguration", + "traits": { + "smithy.api#documentation": "The latency configuration for the model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The performance configuration for a model called with InvokeFlow.
" + } + }, + "com.amazonaws.bedrockagentruntime#Name": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockagentruntime#NodeActionEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the node that called the operation.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date and time that the operation was called.
", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the request that the node made to the operation.
", + "smithy.api#required": {} + } + }, + "serviceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the service that the node called.
", + "smithy.api#required": {} + } + }, + "operationName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the operation that the node called.
", + "smithy.api#required": {} + } + }, + "operationRequest": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The request payload sent to the downstream service.
" + } + }, + "operationResponse": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The response payload received from the downstream service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an action (operation) called by a node during execution.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NodeDependencyEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the node that generated the dependency trace.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date and time that the dependency trace was generated.
", + "smithy.api#required": {} + } + }, + "traceElements": { + "target": "com.amazonaws.bedrockagentruntime#NodeTraceElements", + "traits": { + "smithy.api#documentation": "The trace elements containing detailed information about the node execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an internal trace of a specific node during execution.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NodeErrorCode": { + "type": "enum", + "members": { + "VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION" + } + }, + "DEPENDENCY_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPENDENCY_FAILED" + } + }, + "BAD_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAD_GATEWAY" + } + }, + "INTERNAL_SERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#NodeExecutionContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The document content of the field, which can contain text or structured data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the content of a flow node's input or output field for a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node where the failure occurred.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the node failure occurred.
", + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.bedrockagentruntime#NodeErrorCode", + "traits": { + "smithy.api#documentation": "The error code that identifies the type of failure that occurred at the node.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A descriptive message that provides details about the node failure.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a failure that occurred at a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node that received the inputs.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the inputs were provided to the node.
", + "smithy.api#required": {} + } + }, + "fields": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputFields", + "traits": { + "smithy.api#documentation": "A list of input fields provided to the node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the inputs provided to a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node in the execution chain.
", + "smithy.api#required": {} + } + }, + "index": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The index position of this item in the execution chain.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#FlowControlNodeType", + "traits": { + "smithy.api#documentation": "The type of execution chain item. Supported values are Iterator and Loop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an item in the execution chain for node input tracking.
" + } + }, + "com.amazonaws.bedrockagentruntime#NodeInputField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputName", + "traits": { + "smithy.api#documentation": "The name of the input field as defined in the node's input schema.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#NodeExecutionContent", + "traits": { + "smithy.api#documentation": "The content of the input field, which can contain text or structured data.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputSource", + "traits": { + "smithy.api#documentation": "The source node that provides input data to this field.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "The data type of the input field for compatibility validation.
" + } + }, + "category": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputCategory", + "traits": { + "smithy.api#documentation": "The category of the input field.
" + } + }, + "executionChain": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputExecutionChain", + "traits": { + "smithy.api#documentation": "The execution path through nested nodes like iterators and loops.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an input field provided to a node during a flow execution.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NodeInputFields": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentruntime#NodeInputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" + } + }, + "com.amazonaws.bedrockagentruntime#NodeInputSource": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the source node that provides the input data.
", + "smithy.api#required": {} + } + }, + "outputFieldName": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "The name of the output field from the source node.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputExpression", + "traits": { + "smithy.api#documentation": "The expression used to extract data from the source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the source of input data for a node field.
" + } + }, + "com.amazonaws.bedrockagentruntime#NodeName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" + } + }, + "com.amazonaws.bedrockagentruntime#NodeOutputEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "The name of the node that produced the outputs.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the outputs were produced by the node.
", + "smithy.api#required": {} + } + }, + "fields": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputFields", + "traits": { + "smithy.api#documentation": "A list of output fields produced by the node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the outputs produced by a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the output field as defined in the node's output schema.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#NodeExecutionContent", + "traits": { + "smithy.api#documentation": "The content of the output field, which can contain text or structured data.
", + "smithy.api#required": {} + } + }, + "next": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputNextList", + "traits": { + "smithy.api#documentation": "The next node that receives output data from this field.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "The data type of the output field for compatibility validation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an output field produced by a node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the next node that receives the output data.
", + "smithy.api#required": {} + } + }, + "inputFieldName": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "The name of the input field in the next node that receives the data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the next node that receives output data.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NodeOutputNextList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputNext" + } + }, + "com.amazonaws.bedrockagentruntime#NodeTraceElements": { + "type": "union", + "members": { + "agentTraces": { + "target": "com.amazonaws.bedrockagentruntime#AgentTraces", + "traits": { + "smithy.api#documentation": "Agent trace information for the node execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains trace elements for node execution tracking.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NodeType": { + "type": "enum", + "members": { + "FLOW_INPUT_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FlowInputNode" + } + }, + "FLOW_OUTPUT_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FlowOutputNode" + } + }, + "LAMBDA_FUNCTION_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LambdaFunctionNode" + } + }, + "KNOWLEDGE_BASE_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KnowledgeBaseNode" + } + }, + "PROMPT_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PromptNode" + } + }, + "CONDITION_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConditionNode" + } + }, + "LEX_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LexNode" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.bedrockagentruntime#Observation": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#Type", + "traits": { + "smithy.api#documentation": "Specifies what kind of information the agent returns in the observation. The following values are possible.
ACTION_GROUP – The agent returns the result of an action group.
KNOWLEDGE_BASE – The agent returns information from a knowledge base.
FINISH – The agent returns a final response to the user with no follow-up.
ASK_USER – The agent asks the user a question.
REPROMPT – The agent prompts the user again for the same information.
Contains the JSON-formatted string returned by the API invoked by the action group.
" + } + }, + "agentCollaboratorInvocationOutput": { + "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorInvocationOutput", + "traits": { + "smithy.api#documentation": "A collaborator's invocation output.
" + } + }, + "knowledgeBaseLookupOutput": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupOutput", + "traits": { + "smithy.api#documentation": "Contains details about the results from looking up the knowledge base.
" + } + }, + "finalResponse": { + "target": "com.amazonaws.bedrockagentruntime#FinalResponse", + "traits": { + "smithy.api#documentation": "Contains details about the response to the user.
" + } + }, + "repromptResponse": { + "target": "com.amazonaws.bedrockagentruntime#RepromptResponse", + "traits": { + "smithy.api#documentation": "Contains details about the response to reprompt the input.
" + } + }, + "codeInterpreterInvocationOutput": { + "target": "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationOutput", + "traits": { + "smithy.api#documentation": "Contains the JSON-formatted string returned by the API invoked by the code interpreter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the result or output of an action group or knowledge base, or the response to the user.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#OptimizePrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#OptimizePromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#OptimizePromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Optimizes a prompt for the task that you specify. For more information, see Optimize a prompt in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/optimize-prompt" + } + } + }, + "com.amazonaws.bedrockagentruntime#OptimizePromptRequest": { + "type": "structure", + "members": { + "input": { + "target": "com.amazonaws.bedrockagentruntime#InputPrompt", + "traits": { + "smithy.api#documentation": "Contains the prompt to optimize.
", + "smithy.api#required": {} + } + }, + "targetModelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the model that you want to optimize the prompt for.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#OptimizePromptResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#OptimizePrompt" + } + ] + }, + "com.amazonaws.bedrockagentruntime#OptimizePromptResponse": { + "type": "structure", + "members": { + "optimizedPrompt": { + "target": "com.amazonaws.bedrockagentruntime#OptimizedPromptStream", + "traits": { + "smithy.api#documentation": "The prompt after being optimized for the task.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#OptimizedPrompt": { + "type": "union", + "members": { + "textPrompt": { + "target": "com.amazonaws.bedrockagentruntime#TextPrompt", + "traits": { + "smithy.api#documentation": "Contains information about the text in the prompt that was optimized.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the optimized prompt.
" + } + }, + "com.amazonaws.bedrockagentruntime#OptimizedPromptEvent": { + "type": "structure", + "members": { + "optimizedPrompt": { + "target": "com.amazonaws.bedrockagentruntime#OptimizedPrompt", + "traits": { + "smithy.api#documentation": "Contains information about the optimized prompt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An event in which the prompt was optimized.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#OptimizedPromptStream": { + "type": "union", + "members": { + "optimizedPromptEvent": { + "target": "com.amazonaws.bedrockagentruntime#OptimizedPromptEvent", + "traits": { + "smithy.api#documentation": "An event in which the prompt was optimized.
" + } + }, + "analyzePromptEvent": { + "target": "com.amazonaws.bedrockagentruntime#AnalyzePromptEvent", + "traits": { + "smithy.api#documentation": "An event in which the prompt was analyzed in preparation for optimization.
" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "An internal server error occurred. Retry your request.
" + } + }, + "throttlingException": { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase Provisioned Throughput to increase the rate or number of tokens you can process.
" + } + }, + "validationException": { + "target": "com.amazonaws.bedrockagentruntime#ValidationException", + "traits": { + "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
" + } + }, + "dependencyFailedException": { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", + "traits": { + "smithy.api#documentation": "There was an issue with a dependency. Check the resource configurations and retry the request.
" + } + }, + "accessDeniedException": { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", + "traits": { + "smithy.api#documentation": "The request is denied because of missing access permissions. Check your permissions and retry your request.
" + } + }, + "badGatewayException": { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", + "traits": { + "smithy.api#documentation": "There was an issue with a dependency due to a server issue. Retry your request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The stream containing events in the prompt optimization process.
", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockagentruntime#OrchestrationConfiguration": { + "type": "structure", + "members": { + "promptTemplate": { + "target": "com.amazonaws.bedrockagentruntime#PromptTemplate", + "traits": { + "smithy.api#documentation": "Contains the template for the prompt that's sent to the model. Orchestration prompts must include the $conversation_history$ and $output_format_instructions$ variables. For more information, see Use placeholder variables in the user guide.
Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
" + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
" + } + }, + "queryTransformationConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#QueryTransformationConfiguration", + "traits": { + "smithy.api#documentation": "To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
The latency configuration for the model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for how the model processes the prompt prior to retrieval and generation.
" + } + }, + "com.amazonaws.bedrockagentruntime#OrchestrationExecutor": { + "type": "union", + "members": { + "lambda": { + "target": "com.amazonaws.bedrockagentruntime#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structure of the executor invoking the actions in custom orchestration.
" + } + }, + "com.amazonaws.bedrockagentruntime#OrchestrationModelInvocationOutput": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace.
" + } + }, + "rawResponse": { + "target": "com.amazonaws.bedrockagentruntime#RawResponse", + "traits": { + "smithy.api#documentation": "Contains details of the raw response from the foundation model output.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the foundation model output from the orchestration step.
" + } + }, + "reasoningContent": { + "target": "com.amazonaws.bedrockagentruntime#ReasoningContentBlock", + "traits": { + "smithy.api#documentation": "Contains content about the reasoning that the model made during the orchestration step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The foundation model output from the orchestration step.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#OrchestrationTrace": { + "type": "union", + "members": { + "rationale": { + "target": "com.amazonaws.bedrockagentruntime#Rationale", + "traits": { + "smithy.api#documentation": "Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
" + } + }, + "invocationInput": { + "target": "com.amazonaws.bedrockagentruntime#InvocationInput", + "traits": { + "smithy.api#documentation": "Contains information pertaining to the action group or knowledge base that is being invoked.
" + } + }, + "observation": { + "target": "com.amazonaws.bedrockagentruntime#Observation", + "traits": { + "smithy.api#documentation": "Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.
" + } + }, + "modelInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", + "traits": { + "smithy.api#documentation": "The input for the orchestration step.
The type is ORCHESTRATION.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
Contains information pertaining to the output from the foundation model that is being invoked.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#OrchestrationType": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "CUSTOM_ORCHESTRATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_ORCHESTRATION" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#OutputFile": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the file containing response from code interpreter.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#MimeType", + "traits": { + "smithy.api#documentation": "The type of file that contains response from the code interpreter.
" + } + }, + "bytes": { + "target": "com.amazonaws.bedrockagentruntime#FileBody", + "traits": { + "smithy.api#documentation": "The byte count of files that contains response from code interpreter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of the response from code interpreter.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#OutputFiles": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#OutputFile" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentruntime#OutputString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Parameter": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the parameter.
" + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the parameter.
" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A parameter for the API request or function.
" + } + }, + "com.amazonaws.bedrockagentruntime#ParameterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagentruntime#ParameterDetail": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.bedrockagentruntime#ParameterDescription", + "traits": { + "smithy.api#documentation": "A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#ParameterType", + "traits": { + "smithy.api#documentation": "The data type of the parameter.
", + "smithy.api#required": {} + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the parameter is required for the agent to complete the function for action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a parameter in a function for an action group.
" + } + }, + "com.amazonaws.bedrockagentruntime#ParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Parameter" + } + }, + "com.amazonaws.bedrockagentruntime#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentruntime#ParameterName" + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#ParameterDetail" + } + }, + "com.amazonaws.bedrockagentruntime#ParameterName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagentruntime#ParameterType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "string" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "number" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "integer" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "boolean" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "array" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#Parameters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Parameter" + } + }, + "com.amazonaws.bedrockagentruntime#PartBody": { + "type": "blob", + "traits": { + "smithy.api#length": { + "max": 1000000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Payload": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PayloadPart": { + "type": "structure", + "members": { + "bytes": { + "target": "com.amazonaws.bedrockagentruntime#PartBody", + "traits": { + "smithy.api#documentation": "A part of the agent response in bytes.
" + } + }, + "attribution": { + "target": "com.amazonaws.bedrockagentruntime#Attribution", + "traits": { + "smithy.api#documentation": "Contains citations for a part of an agent response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a part of an agent response and citations for it.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PayloadType": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + }, + "RETURN_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETURN_CONTROL" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#PerformanceConfigLatency": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optimized" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#PerformanceConfiguration": { + "type": "structure", + "members": { + "latency": { + "target": "com.amazonaws.bedrockagentruntime#PerformanceConfigLatency", + "traits": { + "smithy.api#default": "standard", + "smithy.api#documentation": "To use a latency-optimized version of the model, set to optimized.
Performance settings for a model.
" + } + }, + "com.amazonaws.bedrockagentruntime#PostProcessingModelInvocationOutput": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace.
" + } + }, + "parsedResponse": { + "target": "com.amazonaws.bedrockagentruntime#PostProcessingParsedResponse", + "traits": { + "smithy.api#documentation": "Details about the response from the Lambda parsing of the output of the post-processing step.
" + } + }, + "rawResponse": { + "target": "com.amazonaws.bedrockagentruntime#RawResponse", + "traits": { + "smithy.api#documentation": "Details of the raw response from the foundation model output.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the foundation model output from the post-processing step.
" + } + }, + "reasoningContent": { + "target": "com.amazonaws.bedrockagentruntime#ReasoningContentBlock", + "traits": { + "smithy.api#documentation": "Contains content about the reasoning that the model made during the post-processing step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The foundation model output from the post-processing step.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PostProcessingParsedResponse": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentruntime#OutputString", + "traits": { + "smithy.api#documentation": "The text returned by the parser.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the response from the Lambda parsing of the output from the post-processing step.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PostProcessingTrace": { + "type": "union", + "members": { + "modelInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", + "traits": { + "smithy.api#documentation": "The input for the post-processing step.
The type is POST_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The foundation model output from the post-processing step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the post-processing step, in which the agent shapes the response.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PreProcessingModelInvocationOutput": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the trace.
" + } + }, + "parsedResponse": { + "target": "com.amazonaws.bedrockagentruntime#PreProcessingParsedResponse", + "traits": { + "smithy.api#documentation": "Details about the response from the Lambda parsing of the output of the pre-processing step.
" + } + }, + "rawResponse": { + "target": "com.amazonaws.bedrockagentruntime#RawResponse", + "traits": { + "smithy.api#documentation": "Details of the raw response from the foundation model output.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the foundation model output from the pre-processing step.
" + } + }, + "reasoningContent": { + "target": "com.amazonaws.bedrockagentruntime#ReasoningContentBlock", + "traits": { + "smithy.api#documentation": "Contains content about the reasoning that the model made during the pre-processing step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The foundation model output from the pre-processing step.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PreProcessingParsedResponse": { + "type": "structure", + "members": { + "rationale": { + "target": "com.amazonaws.bedrockagentruntime#RationaleString", + "traits": { + "smithy.api#documentation": "The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.
" + } + }, + "isValid": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the user input is valid or not. If false, the agent doesn't proceed to orchestration.
Details about the response from the Lambda parsing of the output from the pre-processing step.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PreProcessingTrace": { + "type": "union", + "members": { + "modelInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", + "traits": { + "smithy.api#documentation": "The input for the pre-processing step.
The type is PRE_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The foundation model output from the pre-processing step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PresignedUrl": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PromptConfiguration": { + "type": "structure", + "members": { + "promptType": { + "target": "com.amazonaws.bedrockagentruntime#PromptType", + "traits": { + "smithy.api#documentation": "The step in the agent sequence that this prompt configuration applies to.
" + } + }, + "promptCreationMode": { + "target": "com.amazonaws.bedrockagentruntime#CreationMode", + "traits": { + "smithy.api#documentation": "Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
PRE_PROCESSING – ENABLED
ORCHESTRATION – ENABLED
KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
POST_PROCESSING – DISABLED
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
" + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#InferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
The foundation model to use.
" + } + }, + "additionalModelRequestFields": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "If the Converse or ConverseStream operations support the model, additionalModelRequestFields contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration field.
For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "com.amazonaws.bedrockagentruntime#PromptConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#PromptConfiguration" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentruntime#PromptCreationConfigurations": { + "type": "structure", + "members": { + "previousConversationTurnsToInclude": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of previous conversations from the ongoing agent session to include in the conversation history of the agent prompt, during the current invocation. This gives you more granular control over the context that the model is made aware of, and helps the model remove older context which is no longer useful during the ongoing agent session.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "excludePreviousThinkingSteps": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "If true, the service removes any content between <thinking> tags from previous conversations in an agent session. The service will only remove content from already processed turns. This helps you remove content which might not be useful for current and subsequent invocations. This can reduce the input token count and potentially save costs. The default value is false.
Specifies parameters that control how the service populates the agent prompt for an InvokeAgent or InvokeInlineAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
", + "smithy.api#required": {} + } + }, + "overrideLambda": { + "target": "com.amazonaws.bedrockagentruntime#LambdaResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#PromptSessionAttributesMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrockagentruntime#PromptState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#PromptTemplate": { + "type": "structure", + "members": { + "textPromptTemplate": { + "target": "com.amazonaws.bedrockagentruntime#TextPromptTemplate", + "traits": { + "smithy.api#documentation": "The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.
For more information, see the following resources:
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the filter field
A list of parameters in the request body.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the parameters in the request body.
" + } + }, + "com.amazonaws.bedrockagentruntime#PutInvocationStep": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#PutInvocationStepRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#PutInvocationStepResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Related APIs:
", + "smithy.api#http": { + "code": 201, + "method": "PUT", + "uri": "/sessions/{sessionIdentifier}/invocationSteps/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentruntime#PutInvocationStepRequest": { + "type": "structure", + "members": { + "sessionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier for the session to add the invocation step to. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The unique identifier (in UUID format) of the invocation to add the invocation step to.
", + "smithy.api#required": {} + } + }, + "invocationStepTime": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the invocation step occurred.
", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.bedrockagentruntime#InvocationStepPayload", + "traits": { + "smithy.api#documentation": "The payload for the invocation step, including text and images for the interaction.
", + "smithy.api#required": {} + } + }, + "invocationStepId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier of the invocation step in UUID format.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#PutInvocationStepResponse": { + "type": "structure", + "members": { + "invocationStepId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier of the invocation step in UUID format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#QueryGenerationInput": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#InputQueryType", + "traits": { + "smithy.api#documentation": "The type of the query.
", + "smithy.api#required": {} + } + }, + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text of the query.
", + "smithy.api#length": { + "min": 1, + "max": 20000 + }, + "smithy.api#pattern": "^(?!\\s*$).+", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a natural language query to transform into SQL.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#QueryTransformationConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#QueryTransformationType", + "traits": { + "smithy.api#documentation": "The type of transformation to apply to the prompt.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
The unique identifier of the trace step.
" + } + }, + "text": { + "target": "com.amazonaws.bedrockagentruntime#RationaleString", + "traits": { + "smithy.api#documentation": "The reasoning or thought process of the agent, based on the input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RationaleString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RawResponse": { + "type": "structure", + "members": { + "content": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The foundation model's raw output content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the raw output from the foundation model.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ReasoningContentBlock": { + "type": "union", + "members": { + "reasoningText": { + "target": "com.amazonaws.bedrockagentruntime#ReasoningTextBlock", + "traits": { + "smithy.api#documentation": "Contains information about the reasoning that the model used to return the content in the content block.
" + } + }, + "redactedContent": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "The content in the reasoning that was encrypted by the model provider for trust and safety reasons.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains content regarding the reasoning that the foundation model made with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ReasoningTextBlock": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Text describing the reasoning that the model used to return the content in the content block.
", + "smithy.api#required": {} + } + }, + "signature": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A hash of all the messages in the conversation to ensure that the content in the reasoning text block isn't tampered with. You must submit the signature in subsequent Converse requests, in addition to the previous messages. If the previous messages are tampered with, the response throws an error.
Contains information about the reasoning that the model used to return the content in the content block.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RelayConversationHistory": { + "type": "enum", + "members": { + "TO_COLLABORATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO_COLLABORATOR" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#RepromptResponse": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text reprompting the input.
" + } + }, + "source": { + "target": "com.amazonaws.bedrockagentruntime#Source", + "traits": { + "smithy.api#documentation": "Specifies what output is prompting the agent to reprompt the input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the agent's response to reprompt the input.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RequestBody": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.bedrockagentruntime#ContentMap", + "traits": { + "smithy.api#documentation": "The content in the request body.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The parameters in the API request body.
" + } + }, + "com.amazonaws.bedrockagentruntime#RequireConfirmation": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#Rerank": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#RerankRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#RerankResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Reranks the relevance of sources based on queries. For more information, see Improve the relevance of query responses with a reranker model.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/rerank" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "results" + } + } + }, + "com.amazonaws.bedrockagentruntime#RerankDocument": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#RerankDocumentType", + "traits": { + "smithy.api#documentation": "The type of document to rerank.
", + "smithy.api#required": {} + } + }, + "textDocument": { + "target": "com.amazonaws.bedrockagentruntime#RerankTextDocument", + "traits": { + "smithy.api#documentation": "Contains information about a text document to rerank.
" + } + }, + "jsonDocument": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Contains a JSON document to rerank.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a document to rerank. Choose the type to define and include the field that corresponds to the type.
The type of the query.
", + "smithy.api#required": {} + } + }, + "textQuery": { + "target": "com.amazonaws.bedrockagentruntime#RerankTextDocument", + "traits": { + "smithy.api#documentation": "Contains information about a text query.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a query to submit to the reranker model.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RerankQueryContentType": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#RerankRequest": { + "type": "structure", + "members": { + "queries": { + "target": "com.amazonaws.bedrockagentruntime#RerankQueriesList", + "traits": { + "smithy.api#documentation": "An array of objects, each of which contains information about a query to submit to the reranker model.
", + "smithy.api#required": {} + } + }, + "sources": { + "target": "com.amazonaws.bedrockagentruntime#RerankSourcesList", + "traits": { + "smithy.api#documentation": "An array of objects, each of which contains information about the sources to rerank.
", + "smithy.api#required": {} + } + }, + "rerankingConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#RerankingConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for reranking.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results was greater than could fit in a response, a token is returned in the nextToken field. You can enter that token in this field to return the next batch of results.
An array of objects, each of which contains information about the results of reranking.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than can fit in the response, use this token in the nextToken field when making another request to return the next batch of results.
The original index of the document from the input sources array.
", + "smithy.api#range": { + "min": 0, + "max": 1000 + }, + "smithy.api#required": {} + } + }, + "relevanceScore": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "The relevance score of the document.
", + "smithy.api#required": {} + } + }, + "document": { + "target": "com.amazonaws.bedrockagentruntime#RerankDocument", + "traits": { + "smithy.api#documentation": "Contains information about the document.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a document that was reranked.
" + } + }, + "com.amazonaws.bedrockagentruntime#RerankResultsList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#RerankResult" + } + }, + "com.amazonaws.bedrockagentruntime#RerankSource": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#RerankSourceType", + "traits": { + "smithy.api#documentation": "The type of the source.
", + "smithy.api#required": {} + } + }, + "inlineDocumentSource": { + "target": "com.amazonaws.bedrockagentruntime#RerankDocument", + "traits": { + "smithy.api#documentation": "Contains an inline definition of a source for reranking.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a source for reranking.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RerankSourceType": { + "type": "enum", + "members": { + "INLINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INLINE" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#RerankSourcesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#RerankSource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RerankTextDocument": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text of the document.
", + "smithy.api#length": { + "min": 1, + "max": 32000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a text document to rerank.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RerankingConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#RerankingConfigurationType", + "traits": { + "smithy.api#documentation": "The type of reranker that the configurations apply to.
", + "smithy.api#required": {} + } + }, + "bedrockRerankingConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#BedrockRerankingConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an Amazon Bedrock reranker.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for reranking.
" + } + }, + "com.amazonaws.bedrockagentruntime#RerankingConfigurationType": { + "type": "enum", + "members": { + "BEDROCK_RERANKING_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_RERANKING_MODEL" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#RerankingMetadataSelectionMode": { + "type": "enum", + "members": { + "SELECTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECTIVE" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#RerankingMetadataSelectiveModeConfiguration": { + "type": "union", + "members": { + "fieldsToInclude": { + "target": "com.amazonaws.bedrockagentruntime#FieldsForReranking", + "traits": { + "smithy.api#documentation": "An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.
" + } + }, + "fieldsToExclude": { + "target": "com.amazonaws.bedrockagentruntime#FieldsForReranking", + "traits": { + "smithy.api#documentation": "An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the fieldsToExclude field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrockagentruntime#ResponseBody": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#ContentBody" + } + }, + "com.amazonaws.bedrockagentruntime#ResponseState": { + "type": "enum", + "members": { + "FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILURE" + } + }, + "REPROMPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPROMPT" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#ResponseStream": { + "type": "union", + "members": { + "chunk": { + "target": "com.amazonaws.bedrockagentruntime#PayloadPart", + "traits": { + "smithy.api#documentation": "Contains a part of an agent response and citations for it.
" + } + }, + "trace": { + "target": "com.amazonaws.bedrockagentruntime#TracePart", + "traits": { + "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" + } + }, + "returnControl": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlPayload", + "traits": { + "smithy.api#documentation": "Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "An internal server error occurred. Retry your request.
" + } + }, + "validationException": { + "target": "com.amazonaws.bedrockagentruntime#ValidationException", + "traits": { + "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
" + } + }, + "resourceNotFoundException": { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", + "traits": { + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" + } + }, + "serviceQuotaExceededException": { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", + "traits": { + "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
" + } + }, + "throttlingException": { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
" + } + }, + "accessDeniedException": { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", + "traits": { + "smithy.api#documentation": "The request is denied because of missing access permissions. Check your permissions and retry your request.
" + } + }, + "conflictException": { + "target": "com.amazonaws.bedrockagentruntime#ConflictException", + "traits": { + "smithy.api#documentation": "There was a conflict performing an operation. Resolve the conflict and retry your request.
" + } + }, + "dependencyFailedException": { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", + "traits": { + "smithy.api#documentation": "There was an issue with a dependency. Check the resource configurations and retry the request.
" + } + }, + "badGatewayException": { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", + "traits": { + "smithy.api#documentation": "There was an issue with a dependency due to a server issue. Retry your request.
" + } + }, + "modelNotReadyException": { + "target": "com.amazonaws.bedrockagentruntime#ModelNotReadyException", + "traits": { + "smithy.api#documentation": "The model specified in the request is not ready to serve Inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.
" + } + }, + "files": { + "target": "com.amazonaws.bedrockagentruntime#FilePart", + "traits": { + "smithy.api#documentation": "Contains intermediate response for code interpreter if any files have been generated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The response from invoking the agent and associated citations and trace information.
", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalContent": { + "type": "structure", + "members": { + "byteContent": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "The binary content of the retrieved item.
" + } + }, + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text content of the retrieved item.
" + } + }, + "mimeType": { + "target": "com.amazonaws.bedrockagentruntime#MimeType", + "traits": { + "smithy.api#documentation": "The MIME type of the retrieved content.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The content retrieved from a knowledge source.
" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalFilter": { + "type": "union", + "members": { + "equals": { + "target": "com.amazonaws.bedrockagentruntime#FilterAttribute", + "traits": { + "smithy.api#documentation": "Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is cat:
\"equals\": { \"key\": \"animal\", \"value\": \"cat\" }
Knowledge base data sources are returned when:
It contains a metadata attribute whose name matches the key and whose value doesn't match the value in this object.
The key is not present in the document.
The following example would return data sources that don't contain an animal attribute whose value is cat.
\"notEquals\": { \"key\": \"animal\", \"value\": \"cat\" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than 1989:
\"greaterThan\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to 1989:
\"greaterThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to 1989.
\"lessThan\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to 1989.
\"lessThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either cat or dog:
\"in\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither cat nor dog.
\"notIn\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).
\"startsWith\": { \"key\": \"animal\", \"value\": \"ca\" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example [\"dog\", \"cat\"]).
\"listContains\": { \"key\": \"animals\", \"value\": \"cat\" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example cat).
\"stringContains\": { \"key\": \"animal\", \"value\": \"at\" }
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example [\"dog\", \"cat\"]).
\"stringContains\": { \"key\": \"animals\", \"value\": \"at\" }
Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
" + } + }, + "orAll": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalFilterList", + "traits": { + "smithy.api#documentation": "Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.
This data type is used in the following API operations:
Retrieve request – in the filter field
RetrieveAndGenerate request – in the filter field
A filter to apply to the retrieval results.
" + } + }, + "maxNumberOfResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to return.
", + "smithy.api#range": { + "min": 1 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Overrides for retrieval behavior.
" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultConfluenceLocation": { + "type": "structure", + "members": { + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Confluence host URL for the data source location.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Confluence data source location.
" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultContent": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContentType", + "traits": { + "smithy.api#documentation": "The type of content in the retrieval result.
" + } + }, + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The cited text from the data source.
" + } + }, + "byteContent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,${base64-encoded string}.
Video segment information when the retrieval result contains video content.
" + } + }, + "audio": { + "target": "com.amazonaws.bedrockagentruntime#AudioSegment", + "traits": { + "smithy.api#documentation": "Audio segment information when the retrieval result contains audio content.
" + } + }, + "row": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContentRow", + "traits": { + "smithy.api#documentation": "Specifies information about the rows with the cells to return in retrieval.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.
This data type is used in the following API operations:
Retrieve response – in the content field
RetrieveAndGenerate response – in the content field
InvokeAgent response – in the content field
The name of the column.
" + } + }, + "columnValue": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value in the column.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContentColumnType", + "traits": { + "smithy.api#documentation": "The data type of the value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a column with a cell to return in retrieval.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultContentColumnType": { + "type": "enum", + "members": { + "BLOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOB" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + }, + "DOUBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE" + } + }, + "NULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULL" + } + }, + "LONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LONG" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultContentRow": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContentColumn" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultContentType": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + }, + "ROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROW" + } + }, + "AUDIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUDIO" + } + }, + "VIDEO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultCustomDocumentLocation": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the document.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the location of a document in a custom data source.
" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultGoogleDriveLocation": { + "type": "structure", + "members": { + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Google Drive URL for the data source location.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Google Drive location of a retrieval result.
" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultKendraDocumentLocation": { + "type": "structure", + "members": { + "uri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The document's uri.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location of a result in Amazon Kendra.
" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultLocation": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocationType", + "traits": { + "smithy.api#documentation": "The type of data source location.
", + "smithy.api#required": {} + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location", + "traits": { + "smithy.api#documentation": "The S3 data source location.
" + } + }, + "webLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultWebLocation", + "traits": { + "smithy.api#documentation": "The web URL/URLs data source location.
" + } + }, + "confluenceLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultConfluenceLocation", + "traits": { + "smithy.api#documentation": "The Confluence data source location.
" + } + }, + "salesforceLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultSalesforceLocation", + "traits": { + "smithy.api#documentation": "The Salesforce data source location.
" + } + }, + "sharePointLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultSharePointLocation", + "traits": { + "smithy.api#documentation": "The SharePoint data source location.
" + } + }, + "customDocumentLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultCustomDocumentLocation", + "traits": { + "smithy.api#documentation": "Specifies the location of a document in a custom data source.
" + } + }, + "kendraDocumentLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultKendraDocumentLocation", + "traits": { + "smithy.api#documentation": "The location of a document in Amazon Kendra.
" + } + }, + "sqlLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultSqlLocation", + "traits": { + "smithy.api#documentation": "Specifies information about the SQL query used to retrieve the result.
" + } + }, + "oneDriveLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultOneDriveLocation", + "traits": { + "smithy.api#documentation": "The Microsoft OneDrive data source location.
" + } + }, + "googleDriveLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultGoogleDriveLocation", + "traits": { + "smithy.api#documentation": "The Google Drive data source location.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the data source location.
This data type is used in the following API operations:
Retrieve response – in the location field
RetrieveAndGenerate response – in the location field
InvokeAgent response – in the location field
The OneDrive URL for the data source location.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Microsoft OneDrive location of a retrieval result.
" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location": { + "type": "structure", + "members": { + "uri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The S3 URI for the data source location.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The S3 data source location.
This data type is used in the following API operations:
Retrieve response – in the s3Location field
RetrieveAndGenerate response – in the s3Location field
InvokeAgent response – in the s3Location field
The Salesforce host URL for the data source location.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Salesforce data source location.
" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultSharePointLocation": { + "type": "structure", + "members": { + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The SharePoint site URL for the data source location.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The SharePoint data source location.
" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultSqlLocation": { + "type": "structure", + "members": { + "query": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The SQL query used to retrieve the result.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the SQL query used to retrieve the result.
" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultWebLocation": { + "type": "structure", + "members": { + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The web URL/URLs for the data source location.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The web URL/URLs data source location.
" + } + }, + "com.amazonaws.bedrockagentruntime#Retrieve": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Queries a knowledge base and retrieves information from it.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/retrieve" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "retrievalResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerate": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile. The response only cites sources that are relevant to the query.
This API cannot be used with managed knowledge bases. Use AgenticRetrieveStream or Retrieve with managed knowledge bases.
The type of resource that contains your data for retrieving information and generating responses.
If you choose to use EXTERNAL_SOURCES, then currently only Anthropic Claude 3 Sonnet models for knowledge bases are supported.
Contains details about the knowledge base for retrieving information and generating responses.
" + } + }, + "externalSourcesConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ExternalSourcesRetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for the external source wrapper object in the retrieveAndGenerate function.
Contains details about the resource being queried.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the retrieveAndGenerateConfiguration field
The query made to the knowledge base, in characters.
", + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the query made to the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the input field
The response generated from querying the knowledge base.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the response generated from querying the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the output field
A text response.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A retrieve and generate output event.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateRequest": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.
Contains the query to be made to the knowledge base.
", + "smithy.api#required": {} + } + }, + "retrieveAndGenerateConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
" + } + }, + "sessionConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateSessionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the session with the knowledge base.
" + } + }, + "userContext": { + "target": "com.amazonaws.bedrockagentruntime#UserContext" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerate" + } + ] + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResponse": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.
Contains the response generated from querying the knowledge base.
", + "smithy.api#required": {} + } + }, + "citations": { + "target": "com.amazonaws.bedrockagentruntime#Citations", + "traits": { + "smithy.api#documentation": "A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
" + } + }, + "guardrailAction": { + "target": "com.amazonaws.bedrockagentruntime#GuadrailAction", + "traits": { + "smithy.api#documentation": "Specifies if there is a guardrail intervention in the response.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateSessionConfiguration": { + "type": "structure", + "members": { + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key encrypting the session.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configuration about the session with the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the sessionConfiguration field
Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.
This API cannot be used with managed knowledge bases. Use AgenticRetrieveStream or Retrieve with managed knowledge bases.
The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream.
This operation requires permission for the bedrock:RetrieveAndGenerate action.
The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.
Contains the query to be made to the knowledge base.
", + "smithy.api#required": {} + } + }, + "retrieveAndGenerateConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
" + } + }, + "sessionConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateSessionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the session with the knowledge base.
" + } + }, + "userContext": { + "target": "com.amazonaws.bedrockagentruntime#UserContext" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateStreamResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateStream" + } + ] + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateStreamResponse": { + "type": "structure", + "members": { + "stream": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateStreamResponseOutput", + "traits": { + "smithy.api#documentation": "A stream of events from the model.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "The session ID.
", + "smithy.api#httpHeader": "x-amzn-bedrock-knowledge-base-session-id", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateStreamResponseOutput": { + "type": "union", + "members": { + "output": { + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateOutputEvent", + "traits": { + "smithy.api#documentation": "An output event.
" + } + }, + "citation": { + "target": "com.amazonaws.bedrockagentruntime#CitationEvent", + "traits": { + "smithy.api#documentation": "A citation event.
" + } + }, + "guardrail": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailEvent", + "traits": { + "smithy.api#documentation": "A guardrail event.
" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "An internal server error occurred. Retry your request.
" + } + }, + "validationException": { + "target": "com.amazonaws.bedrockagentruntime#ValidationException", + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide.
" + } + }, + "resourceNotFoundException": { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", + "traits": { + "smithy.api#documentation": "The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide.
" + } + }, + "serviceQuotaExceededException": { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", + "traits": { + "smithy.api#documentation": "Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.
" + } + }, + "throttlingException": { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide.
" + } + }, + "accessDeniedException": { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", + "traits": { + "smithy.api#documentation": "The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide.
" + } + }, + "conflictException": { + "target": "com.amazonaws.bedrockagentruntime#ConflictException", + "traits": { + "smithy.api#documentation": "Error occurred because of a conflict while performing an operation.
" + } + }, + "dependencyFailedException": { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", + "traits": { + "smithy.api#documentation": "The request failed due to a dependency error.
" + } + }, + "badGatewayException": { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", + "traits": { + "smithy.api#documentation": "The request failed due to a bad gateway error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A retrieve and generate stream response output.
", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateType": { + "type": "enum", + "members": { + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE" + } + }, + "EXTERNAL_SOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL_SOURCES" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#RetrieveRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to query.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "retrievalQuery": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseQuery", + "traits": { + "smithy.api#documentation": "Contains the query to send the knowledge base.
", + "smithy.api#required": {} + } + }, + "retrievalConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Guardrail settings.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
A list of results from querying the knowledge base.
", + "smithy.api#required": {} + } + }, + "guardrailAction": { + "target": "com.amazonaws.bedrockagentruntime#GuadrailAction", + "traits": { + "smithy.api#documentation": "Specifies if there is a guardrail intervention in the response.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
Contains the cited text from the data source.
" + } + }, + "location": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation", + "traits": { + "smithy.api#documentation": "Contains information about the location of the data source.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultMetadata", + "traits": { + "smithy.api#documentation": "Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the retrievedReferences field
InvokeAgent response – in the retrievedReferences field
Configuration for a knowledge base retriever.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a retriever, specified as a union of retriever types.
" + } + }, + "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#InvocationResultMember" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentruntime#ReturnControlPayload": { + "type": "structure", + "members": { + "invocationInputs": { + "target": "com.amazonaws.bedrockagentruntime#InvocationInputs", + "traits": { + "smithy.api#documentation": "A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
" + } + }, + "invocationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the following API operations:
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ReturnControlResults": { + "type": "structure", + "members": { + "invocationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The action's invocation ID.
" + } + }, + "returnControlInvocationResults": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults", + "traits": { + "smithy.api#documentation": "The action invocation result.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An action invocation result.
" + } + }, + "com.amazonaws.bedrockagentruntime#RoutingClassifierModelInvocationOutput": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "The invocation's trace ID.
" + } + }, + "rawResponse": { + "target": "com.amazonaws.bedrockagentruntime#RawResponse", + "traits": { + "smithy.api#documentation": "The invocation's raw response.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "The invocation's metadata.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Invocation output from a routing classifier model.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#RoutingClassifierTrace": { + "type": "union", + "members": { + "invocationInput": { + "target": "com.amazonaws.bedrockagentruntime#InvocationInput", + "traits": { + "smithy.api#documentation": "The classifier's invocation input.
" + } + }, + "observation": { + "target": "com.amazonaws.bedrockagentruntime#Observation", + "traits": { + "smithy.api#documentation": "The classifier's observation.
" + } + }, + "modelInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", + "traits": { + "smithy.api#documentation": "The classifier's model invocation input.
" + } + }, + "modelInvocationOutput": { + "target": "com.amazonaws.bedrockagentruntime#RoutingClassifierModelInvocationOutput", + "traits": { + "smithy.api#documentation": "The classifier's model invocation output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A trace for a routing classifier.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.bedrockagentruntime#S3Identifier": { + "type": "structure", + "members": { + "s3BucketName": { + "target": "com.amazonaws.bedrockagentruntime#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket.
" + } + }, + "s3ObjectKey": { + "target": "com.amazonaws.bedrockagentruntime#S3ObjectKey", + "traits": { + "smithy.api#documentation": "The S3 object key for the S3 resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The identifier information for an Amazon S3 bucket.
" + } + }, + "com.amazonaws.bedrockagentruntime#S3Location": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagentruntime#S3Uri", + "traits": { + "smithy.api#documentation": "The path to the Amazon S3 bucket where the image is stored.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Amazon S3 bucket where the image is stored.
" + } + }, + "com.amazonaws.bedrockagentruntime#S3ObjectDoc": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagentruntime#S3Uri", + "traits": { + "smithy.api#documentation": "The file location of the S3 wrapper object.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The unique wrapper object of the document from the S3 location.
" + } + }, + "com.amazonaws.bedrockagentruntime#S3ObjectFile": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagentruntime#S3Uri", + "traits": { + "smithy.api#documentation": "The uri of the s3 object.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of the s3 object where the source file is located.
" + } + }, + "com.amazonaws.bedrockagentruntime#S3ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" + } + }, + "com.amazonaws.bedrockagentruntime#S3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$" + } + }, + "com.amazonaws.bedrockagentruntime#SatisfiedCondition": { + "type": "structure", + "members": { + "conditionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the condition that was satisfied.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a condition that was satisfied during a condition node evaluation in a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The number of requests exceeds the service quota. Resubmit your request later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagentruntime#SessionArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.bedrockagentruntime#SessionAttributesMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrockagentruntime#SessionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._:-]+$" + } + }, + "com.amazonaws.bedrockagentruntime#SessionIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})$" + } + }, + "com.amazonaws.bedrockagentruntime#SessionMetadataKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentruntime#SessionMetadataMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentruntime#SessionMetadataKey" + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#SessionMetadataValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.bedrockagentruntime#SessionMetadataValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + } + } + }, + "com.amazonaws.bedrockagentruntime#SessionResource": { + "type": "resource", + "identifiers": { + "sessionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentruntime#CreateSession" + }, + "read": { + "target": "com.amazonaws.bedrockagentruntime#GetSession" + }, + "update": { + "target": "com.amazonaws.bedrockagentruntime#UpdateSession" + }, + "delete": { + "target": "com.amazonaws.bedrockagentruntime#DeleteSession" + }, + "list": { + "target": "com.amazonaws.bedrockagentruntime#ListSessions" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#EndSession" + } + ], + "resources": [ + { + "target": "com.amazonaws.bedrockagentruntime#InvocationResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InvocationStepResource" + } + ] + }, + "com.amazonaws.bedrockagentruntime#SessionState": { + "type": "structure", + "members": { + "sessionAttributes": { + "target": "com.amazonaws.bedrockagentruntime#SessionAttributesMap", + "traits": { + "smithy.api#documentation": "Contains attributes that persist across a session and the values of those attributes. If sessionAttributes are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.
Contains attributes that persist across a prompt and the values of those attributes.
In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.
In multi-agent collaboration, the promptSessionAttributes will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.
Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.
If you include this field, the inputText field will be ignored.
The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.
Contains information about the files used by code interpreter.
" + } + }, + "knowledgeBaseConfigurations": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfigurations", + "traits": { + "smithy.api#documentation": "An array of configurations, each of which applies to a knowledge base attached to the agent.
" + } + }, + "conversationHistory": { + "target": "com.amazonaws.bedrockagentruntime#ConversationHistory", + "traits": { + "smithy.api#documentation": "The state's conversation history.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context.
" + } + }, + "com.amazonaws.bedrockagentruntime#SessionStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "ENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDED" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#SessionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#SessionSummary" + } + }, + "com.amazonaws.bedrockagentruntime#SessionSummary": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#Uuid", + "traits": { + "smithy.api#documentation": "The unique identifier for the session.
", + "smithy.api#required": {} + } + }, + "sessionArn": { + "target": "com.amazonaws.bedrockagentruntime#SessionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the session.
", + "smithy.api#required": {} + } + }, + "sessionStatus": { + "target": "com.amazonaws.bedrockagentruntime#SessionStatus", + "traits": { + "smithy.api#documentation": "The current status of the session.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the session was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the session was last modified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" + } + }, + "com.amazonaws.bedrockagentruntime#SessionTTL": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.bedrockagentruntime#Source": { + "type": "enum", + "members": { + "ACTION_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTION_GROUP" + } + }, + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE" + } + }, + "PARSER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARSER" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Span": { + "type": "structure", + "members": { + "start": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Where the text with a citation starts in the generated output.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "end": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Where the text with a citation ends in the generated output.
", + "smithy.api#range": { + "min": 0 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about where the text with a citation begins and ends in the generated output.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the span field
InvokeAgent response – in the span field
Starts an execution of an Amazon Bedrock flow. Unlike flows that run until completion or time out after five minutes, flow executions let you run flows asynchronously for longer durations. Flow executions also yield control so that your application can perform other tasks.
This operation returns an Amazon Resource Name (ARN) that you can use to track and manage your flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The unique identifier of the flow to execute.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow alias to use for the flow execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowExecutionName": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionName", + "traits": { + "smithy.api#documentation": "The unique name for the flow execution. If you don't provide one, a system-generated name is used.
" + } + }, + "inputs": { + "target": "com.amazonaws.bedrockagentruntime#FlowInputs", + "traits": { + "smithy.api#documentation": "The input data required for the flow execution. This must match the input schema defined in the flow.
", + "smithy.api#required": {} + } + }, + "modelPerformanceConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ModelPerformanceConfiguration", + "traits": { + "smithy.api#documentation": "The performance settings for the foundation model used in the flow execution.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#StartFlowExecutionResponse": { + "type": "structure", + "members": { + "executionArn": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#StopFlowExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#StopFlowExecutionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#StopFlowExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to Aborted.
The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow alias used for the execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow execution to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#StopFlowExecutionResponse": { + "type": "structure", + "members": { + "executionArn": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the flow execution that was stopped.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionStatus", + "traits": { + "smithy.api#documentation": "The updated status of the flow execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#StopSequences": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.bedrockagentruntime#StreamingConfigurations": { + "type": "structure", + "members": { + "streamFinalResponse": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": " Specifies whether to enable streaming for the final response. This is set to false by default.
The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer ApplyGuardrail calls. The following examples show the response generated for Hello, I am an agent input string.
Example response in chunks: Interval set to 3 characters
'Hel', 'lo, ','I am', ' an', ' Age', 'nt'
Each chunk has at least 3 characters except for the last chunk
Example response in chunks: Interval set to 20 or more characters
Hello, I am an Agent
Configurations for streaming.
" + } + }, + "com.amazonaws.bedrockagentruntime#SummaryText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25000000 + } + } + }, + "com.amazonaws.bedrockagentruntime#TagKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "Key of a tag", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentruntime#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#TagKey" + }, + "traits": { + "smithy.api#documentation": "List of Tag Keys", + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagentruntime#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.bedrockagentruntime#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagentruntime#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentruntime#TagsMap", + "traits": { + "smithy.api#documentation": "An object containing key-value pairs that define the tags to attach to the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#TagValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "Value of a tag", + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentruntime#TaggableResourcesArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of Taggable resources: [session]", + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "(^arn:aws(-[^:]+)?:bedrock:[a-zA-Z0-9-]+:[0-9]{12}:(session)/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$)" + } + }, + "com.amazonaws.bedrockagentruntime#TaggingResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#ListTagsForResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#TagResource" + }, + { + "target": "com.amazonaws.bedrockagentruntime#UntagResource" + } + ] + }, + "com.amazonaws.bedrockagentruntime#TagsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentruntime#TagKey" + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#TagValue" + }, + "traits": { + "smithy.api#documentation": "A map of tag keys and values", + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagentruntime#Temperature": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentruntime#TextInferenceConfig": { + "type": "structure", + "members": { + "temperature": { + "target": "com.amazonaws.bedrockagentruntime#Temperature", + "traits": { + "smithy.api#documentation": "Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagentruntime#TopP", + "traits": { + "smithy.api#documentation": "A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.
" + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrockagentruntime#MaxTokens", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
" + } + }, + "stopSequences": { + "target": "com.amazonaws.bedrockagentruntime#RAGStopSequences", + "traits": { + "smithy.api#documentation": "A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.
The valid range of maxTokens depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.
The text in the text prompt to optimize.
", + "smithy.api#length": { + "min": 1, + "max": 200000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the text prompt to optimize.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#TextPromptTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#TextResponsePart": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The part of the generated text that contains a citation.
" + } + }, + "span": { + "target": "com.amazonaws.bedrockagentruntime#Span", + "traits": { + "smithy.api#documentation": "Contains information about where the text with a citation begins and ends in the generated output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the part of the generated text that contains a citation, alongside where it begins and ends.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the textResponsePart field
InvokeAgent response – in the textResponsePart field
The type of resource to use in transformation.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#TextToSqlKnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for a knowledge base to use in transformation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for transforming text to SQL.
" + } + }, + "com.amazonaws.bedrockagentruntime#TextToSqlConfigurationType": { + "type": "enum", + "members": { + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#TextToSqlKnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "knowledgeBaseArn": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseArn", + "traits": { + "smithy.api#documentation": "The ARN of the knowledge base
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a knowledge base to use in transformation.
" + } + }, + "com.amazonaws.bedrockagentruntime#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bedrockagentruntime#TopK": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagentruntime#TopP": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentruntime#Trace": { + "type": "union", + "members": { + "guardrailTrace": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailTrace", + "traits": { + "smithy.api#documentation": "The trace details for a trace defined in the Guardrail filter.
" + } + }, + "preProcessingTrace": { + "target": "com.amazonaws.bedrockagentruntime#PreProcessingTrace", + "traits": { + "smithy.api#documentation": "Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
" + } + }, + "orchestrationTrace": { + "target": "com.amazonaws.bedrockagentruntime#OrchestrationTrace", + "traits": { + "smithy.api#documentation": "Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
" + } + }, + "postProcessingTrace": { + "target": "com.amazonaws.bedrockagentruntime#PostProcessingTrace", + "traits": { + "smithy.api#documentation": "Details about the post-processing step, in which the agent shapes the response..
" + } + }, + "routingClassifierTrace": { + "target": "com.amazonaws.bedrockagentruntime#RoutingClassifierTrace", + "traits": { + "smithy.api#documentation": "A routing classifier's trace.
" + } + }, + "failureTrace": { + "target": "com.amazonaws.bedrockagentruntime#FailureTrace", + "traits": { + "smithy.api#documentation": "Contains information about the failure of the interaction.
" + } + }, + "customOrchestrationTrace": { + "target": "com.amazonaws.bedrockagentruntime#CustomOrchestrationTrace", + "traits": { + "smithy.api#documentation": "Details about the custom orchestration step in which the agent determines the order in which actions are executed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#TraceElements": { + "type": "union", + "members": { + "agentTraces": { + "target": "com.amazonaws.bedrockagentruntime#AgentTraces", + "traits": { + "smithy.api#documentation": "Agent trace information for the flow execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains trace elements for flow execution tracking.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#TraceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 16 + } + } + }, + "com.amazonaws.bedrockagentruntime#TraceKnowledgeBaseId": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#TracePart": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the session with the agent.
" + } + }, + "trace": { + "target": "com.amazonaws.bedrockagentruntime#Trace", + "traits": { + "smithy.api#documentation": "Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
" + } + }, + "callerChain": { + "target": "com.amazonaws.bedrockagentruntime#CallerChain", + "traits": { + "smithy.api#documentation": "The part's caller chain.
" + } + }, + "eventTime": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time of the trace.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagentruntime#Name", + "traits": { + "smithy.api#documentation": "The part's collaborator name.
" + } + }, + "agentId": { + "target": "com.amazonaws.bedrockagentruntime#AgentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
" + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias of the agent.
" + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagentruntime#AgentVersion", + "traits": { + "smithy.api#documentation": "The version of the agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#TransformationConfiguration": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.bedrockagentruntime#QueryTransformationMode", + "traits": { + "smithy.api#documentation": "The mode of the transformation.
", + "smithy.api#required": {} + } + }, + "textToSqlConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#TextToSqlConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for transforming text to SQL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for transforming the natural language query into SQL.
" + } + }, + "com.amazonaws.bedrockagentruntime#Type": { + "type": "enum", + "members": { + "ACTION_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTION_GROUP" + } + }, + "AGENT_COLLABORATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_COLLABORATOR" + } + }, + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE" + } + }, + "FINISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINISH" + } + }, + "ASK_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASK_USER" + } + }, + "REPROMPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPROMPT" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Remove tags from a resource.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentruntime#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagentruntime#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to remove tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.bedrockagentruntime#TagKeyList", + "traits": { + "smithy.api#documentation": "A list of keys of the tags to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#UpdateSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#UpdateSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#UpdateSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the metadata or encryption settings of a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/sessions/{sessionIdentifier}/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentruntime#UpdateSessionRequest": { + "type": "structure", + "members": { + "sessionMetadata": { + "target": "com.amazonaws.bedrockagentruntime#SessionMetadataMap", + "traits": { + "smithy.api#documentation": "A map of key-value pairs containing attributes to be persisted across the session. For example the user's ID, their language preference, and the type of device they are using.
" + } + }, + "sessionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the session to modify. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The unique identifier of the session you updated.
", + "smithy.api#required": {} + } + }, + "sessionArn": { + "target": "com.amazonaws.bedrockagentruntime#SessionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the session that was updated.
", + "smithy.api#required": {} + } + }, + "sessionStatus": { + "target": "com.amazonaws.bedrockagentruntime#SessionStatus", + "traits": { + "smithy.api#documentation": "The status of the session you updated.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the session was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the session was last modified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#Usage": { + "type": "structure", + "members": { + "inputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Contains information about the input tokens from the foundation model usage.
" + } + }, + "outputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Contains information about the output tokens from the foundation model usage.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information of the usage of the foundation model.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#UserContext": { + "type": "structure", + "members": { + "userId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the user making the retrieval request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the user making the request. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Uuid": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.bedrockagentruntime#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagentruntime#VectorSearchBedrockRerankingConfiguration": { + "type": "structure", + "members": { + "modelConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#VectorSearchBedrockRerankingModelConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the reranker model.
", + "smithy.api#required": {} + } + }, + "numberOfRerankedResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of results to return after reranking.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#MetadataConfigurationForReranking", + "traits": { + "smithy.api#documentation": "Contains configurations for the metadata to use in reranking.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for reranking with an Amazon Bedrock reranker model.
" + } + }, + "com.amazonaws.bedrockagentruntime#VectorSearchBedrockRerankingModelConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrockagentruntime#BedrockRerankingModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the reranker model to use.
", + "smithy.api#required": {} + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "A JSON object whose keys are request fields for the model and whose values are values for those fields.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for an Amazon Bedrock reranker model.
" + } + }, + "com.amazonaws.bedrockagentruntime#VectorSearchRerankingConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#VectorSearchRerankingConfigurationType", + "traits": { + "smithy.api#documentation": "The type of reranker model.
", + "smithy.api#required": {} + } + }, + "bedrockRerankingConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#VectorSearchBedrockRerankingConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an Amazon Bedrock reranker model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for reranking the retrieved results.
" + } + }, + "com.amazonaws.bedrockagentruntime#VectorSearchRerankingConfigurationType": { + "type": "enum", + "members": { + "BEDROCK_RERANKING_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_RERANKING_MODEL" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#Verb": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Version": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" + } + }, + "com.amazonaws.bedrockagentruntime#VideoSegment": { + "type": "structure", + "members": { + "s3Uri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The S3 URI where this specific video segment is stored in the multimodal storage destination.
", + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "summary": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A text summary describing the content of the video segment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a video segment retrieved from a knowledge base, including its location and summary.
This data type is used in the following API operations:
Retrieve response – in the video field
Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" + } + }, + "payload": { + "target": "com.amazonaws.bedrockagent#Payload", + "traits": { + "smithy.api#documentation": "The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
The access level for an access control entry.
" + } + }, + "com.amazonaws.bedrockagent#AccessControlPrincipalType": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of principal in an access control entry.
" + } + }, + "com.amazonaws.bedrockagent#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The request is denied because of missing access permissions.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bedrockagent#ActionGroupExecutor": { + "type": "union", + "members": { + "lambda": { + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + }, + "customControl": { + "target": "com.amazonaws.bedrockagent#CustomControlMethod", + "traits": { + "smithy.api#documentation": "To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.
Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" + } + }, + "com.amazonaws.bedrockagent#ActionGroupResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateAgentActionGroup" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroup" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroup" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentActionGroups" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroup" + } + ] + }, + "com.amazonaws.bedrockagent#ActionGroupSignature": { + "type": "enum", + "members": { + "AMAZON_USERINPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON.UserInput" + } + }, + "AMAZON_CODEINTERPRETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON.CodeInterpreter" + } + }, + "ANTHROPIC_COMPUTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANTHROPIC.Computer" + } + }, + "ANTHROPIC_BASH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANTHROPIC.Bash" + } + }, + "ANTHROPIC_TEXTEDITOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANTHROPIC.TextEditor" + } + } + } + }, + "com.amazonaws.bedrockagent#ActionGroupSignatureParams": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "max": 100 + } + } + } + }, + "com.amazonaws.bedrockagent#ActionGroupState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagent#ActionGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#ActionGroupSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#ActionGroupSummary": { + "type": "structure", + "members": { + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group.
", + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the action group.
", + "smithy.api#required": {} + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the action group.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the action group was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an action group.
" + } + }, + "com.amazonaws.bedrockagent#AdditionalModelRequestFields": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagent#AdditionalModelRequestFieldsKey" + }, + "value": { + "target": "com.amazonaws.bedrockagent#AdditionalModelRequestFieldsValue" + } + }, + "com.amazonaws.bedrockagent#AdditionalModelRequestFieldsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagent#AdditionalModelRequestFieldsValue": { + "type": "document" + }, + "com.amazonaws.bedrockagent#Agent": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the agent.
", + "smithy.api#required": {} + } + }, + "agentArn": { + "target": "com.amazonaws.bedrockagent#AgentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "Instructions that tell the agent what it should do and how it should interact with users.
" + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent and whether it is ready for use. The following statuses are possible:
CREATING – The agent is being created.
PREPARING – The agent is being prepared.
PREPARED – The agent is prepared and ready to be invoked.
NOT_PREPARED – The agent has been created but not yet prepared.
FAILED – The agent API operation failed.
UPDATING – The agent is being updated.
DELETING – The agent is being deleted.
The foundation model used for orchestration by the agent.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the agent.
" + } + }, + "orchestrationType": { + "target": "com.amazonaws.bedrockagent#OrchestrationType", + "traits": { + "smithy.api#documentation": "Specifies the orchestration strategy for the agent.
" + } + }, + "customOrchestration": { + "target": "com.amazonaws.bedrockagent#CustomOrchestration", + "traits": { + "smithy.api#documentation": "Contains custom orchestration configurations for the agent.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
", + "smithy.api#required": {} + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the agent was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the agent was last updated.
", + "smithy.api#required": {} + } + }, + "preparedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the agent was last prepared.
" + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "Contains reasons that the agent-related API that you invoked failed.
" + } + }, + "recommendedActions": { + "target": "com.amazonaws.bedrockagent#RecommendedActions", + "traits": { + "smithy.api#documentation": "Contains recommended actions to take for the agent-related API that you invoked to succeed.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with the agent.
" + } + }, + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", + "traits": { + "smithy.api#documentation": "Contains memory configuration for the agent.
" + } + }, + "agentCollaboration": { + "target": "com.amazonaws.bedrockagent#AgentCollaboration", + "traits": { + "smithy.api#documentation": "The agent's collaboration settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentActionGroup": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent to which the action group belongs.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent to which the action group belongs.
", + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group.
", + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the action group.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the action group.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the action group was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the action group was last updated.
", + "smithy.api#required": {} + } + }, + "parentActionSignature": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" + } + }, + "parentActionGroupSignatureParams": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignatureParams", + "traits": { + "smithy.api#documentation": "The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" + } + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema", + "traits": { + "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" + } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
" + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an action group.
" + } + }, + "com.amazonaws.bedrockagent#AgentAlias": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias of the agent.
", + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias of the agent.
", + "smithy.api#required": {} + } + }, + "agentAliasArn": { + "target": "com.amazonaws.bedrockagent#AgentAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias of the agent.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the alias of the agent.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the routing configuration of the alias.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias of the agent was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + }, + "agentAliasHistoryEvents": { + "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvents", + "traits": { + "smithy.api#documentation": "Contains details about the history of the alias.
" + } + }, + "agentAliasStatus": { + "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "traits": { + "smithy.api#documentation": "The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
CREATING – The agent alias is being created.
PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
FAILED – The agent alias API operation failed.
UPDATING – The agent alias is being updated.
DELETING – The agent alias is being deleted.
DISSOCIATED - The agent alias has no version associated with it.
Information on the failure of Provisioned Throughput assigned to an agent alias.
" + } + }, + "aliasInvocationState": { + "target": "com.amazonaws.bedrockagent#AliasInvocationState", + "traits": { + "smithy.api#documentation": "The invocation state for the agent alias. If the agent alias is running, the value is ACCEPT_INVOCATIONS. If the agent alias is paused, the value is REJECT_INVOCATIONS. Use the UpdateAgentAlias operation to change the invocation state.
Contains details about an alias of an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentAliasArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#AgentAliasHistoryEvent": { + "type": "structure", + "members": { + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the version of the agent with which the alias is associated.
" + } + }, + "endDate": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date that the alias stopped being associated to the version in the routingConfiguration object
The date that the alias began being associated to the version in the routingConfiguration object.
Contains details about the history of the alias.
" + } + }, + "com.amazonaws.bedrockagent#AgentAliasHistoryEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvent" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" + } + }, + "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem" + }, + "traits": { + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem": { + "type": "structure", + "members": { + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent with which the alias is associated.
" + } + }, + "provisionedThroughput": { + "target": "com.amazonaws.bedrockagent#ProvisionedModelIdentifier", + "traits": { + "smithy.api#documentation": "Information on the Provisioned Throughput assigned to an agent alias.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" + } + }, + "com.amazonaws.bedrockagent#AgentAliasStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DISSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISSOCIATED" + } + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentAliasSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasSummary": { + "type": "structure", + "members": { + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "Contains details about
", + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the version of the agent with which the alias is associated.
" + } + }, + "agentAliasStatus": { + "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "traits": { + "smithy.api#documentation": "The status of the alias.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias of the agent was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + }, + "aliasInvocationState": { + "target": "com.amazonaws.bedrockagent#AliasInvocationState", + "traits": { + "smithy.api#documentation": "The invocation state for the agent alias. If the agent alias is running, the value is ACCEPT_INVOCATIONS. If the agent alias is paused, the value is REJECT_INVOCATIONS. Use the UpdateAgentAlias operation to change the invocation state.
Contains details about an alias of an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#AgentCollaboration": { + "type": "enum", + "members": { + "SUPERVISOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPERVISOR" + } + }, + "SUPERVISOR_ROUTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPERVISOR_ROUTER" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagent#AgentCollaborator": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The collaborator's agent ID.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The collaborator's agent version.
", + "smithy.api#required": {} + } + }, + "agentDescriptor": { + "target": "com.amazonaws.bedrockagent#AgentDescriptor", + "traits": { + "smithy.api#documentation": "The collaborator's agent descriptor.
", + "smithy.api#required": {} + } + }, + "collaboratorId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The collaborator's collaborator ID.
", + "smithy.api#required": {} + } + }, + "collaborationInstruction": { + "target": "com.amazonaws.bedrockagent#CollaborationInstruction", + "traits": { + "smithy.api#documentation": "The collaborator's instructions.
", + "smithy.api#required": {} + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The collaborator's collaborator name.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "When the collaborator was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "When the collaborator was updated.
", + "smithy.api#required": {} + } + }, + "relayConversationHistory": { + "target": "com.amazonaws.bedrockagent#RelayConversationHistory", + "traits": { + "smithy.api#documentation": "The collaborator's relay conversation history.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "The collaborator's client token.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An agent collaborator.
" + } + }, + "com.amazonaws.bedrockagent#AgentCollaboratorResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#AssociateAgentCollaborator" + }, + { + "target": "com.amazonaws.bedrockagent#DisassociateAgentCollaborator" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentCollaborator" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentCollaborators" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentCollaborator" + } + ] + }, + "com.amazonaws.bedrockagent#AgentCollaboratorSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentCollaboratorSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentCollaboratorSummary": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The collaborator's agent ID.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The collaborator's agent version.
", + "smithy.api#required": {} + } + }, + "collaboratorId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The collaborator's ID.
", + "smithy.api#required": {} + } + }, + "agentDescriptor": { + "target": "com.amazonaws.bedrockagent#AgentDescriptor", + "traits": { + "smithy.api#documentation": "The collaborator's agent descriptor.
", + "smithy.api#required": {} + } + }, + "collaborationInstruction": { + "target": "com.amazonaws.bedrockagent#CollaborationInstruction", + "traits": { + "smithy.api#documentation": "The collaborator's collaboration instruction.
", + "smithy.api#required": {} + } + }, + "relayConversationHistory": { + "target": "com.amazonaws.bedrockagent#RelayConversationHistory", + "traits": { + "smithy.api#documentation": "The collaborator's relay conversation history.
", + "smithy.api#required": {} + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The collaborator's name.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "When the collaborator was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "When the collaborator was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An agent collaborator summary.
" + } + }, + "com.amazonaws.bedrockagent#AgentDescriptor": { + "type": "structure", + "members": { + "aliasArn": { + "target": "com.amazonaws.bedrockagent#AgentAliasArn", + "traits": { + "smithy.api#documentation": "The agent's alias ARN.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An agent descriptor.
" + } + }, + "com.amazonaws.bedrockagent#AgentFlowNodeConfiguration": { + "type": "structure", + "members": { + "agentAliasArn": { + "target": "com.amazonaws.bedrockagent#FlowAgentAliasArn", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias of the agent to invoke.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#AgentKnowledgeBase": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent with which the knowledge base is associated.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent with which the knowledge base is associated.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the association between the agent and the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the association between the agent and the knowledge base.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the association between the agent and the knowledge base was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the association between the agent and the knowledge base was last updated.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a knowledge base that is associated with an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base associated with an agent.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the knowledge base associated with an agent.
" + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the knowledge base associated with an agent was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a knowledge base associated with an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateAgent" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteAgent" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgent" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgents" + }, + { + "target": "com.amazonaws.bedrockagent#PrepareAgent" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgent" + } + ] + }, + "com.amazonaws.bedrockagent#AgentRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" + } + }, + "com.amazonaws.bedrockagent#AgentStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "PREPARING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARING" + } + }, + "PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARED" + } + }, + "NOT_PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_PREPARED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "VERSIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSIONING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.bedrockagent#AgentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentSummary": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the agent.
", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the agent.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the agent was last updated.
", + "smithy.api#required": {} + } + }, + "latestAgentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The latest version of the agent.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with the agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentVersion": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "agentArn": { + "target": "com.amazonaws.bedrockagent#AgentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version number.
", + "smithy.api#required": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "The instructions provided to the agent.
" + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The foundation model that the version invokes.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the version.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
", + "smithy.api#required": {} + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the version was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the version was last updated.
", + "smithy.api#required": {} + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "A list of reasons that the API operation on the version failed.
" + } + }, + "recommendedActions": { + "target": "com.amazonaws.bedrockagent#RecommendedActions", + "traits": { + "smithy.api#documentation": "A list of recommended actions to take for the failed API operation on the version to succeed.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with the agent.
" + } + }, + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", + "traits": { + "smithy.api#documentation": "Contains details of the memory configuration on the version of the agent.
" + } + }, + "agentCollaboration": { + "target": "com.amazonaws.bedrockagent#AgentCollaboration", + "traits": { + "smithy.api#documentation": "The agent's collaboration settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a version of an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentVersionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentVersionSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentVersionSummary": { + "type": "structure", + "members": { + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the agent to which the version belongs.
", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent to which the version belongs.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the version was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the version was last updated.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the version of the agent.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with the agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a version of an agent.
" + } + }, + "com.amazonaws.bedrockagent#AliasInvocationState": { + "type": "enum", + "members": { + "ACCEPT_INVOCATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Agent is actively processing requests", + "smithy.api#enumValue": "ACCEPT_INVOCATIONS" + } + }, + "REJECT_INVOCATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Agent is paused and will not accept new requests", + "smithy.api#enumValue": "REJECT_INVOCATIONS" + } + } + }, + "traits": { + "smithy.api#documentation": "Enum representing the invocation state of an agent alias" + } + }, + "com.amazonaws.bedrockagent#AliasResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateAgentAlias" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteAgentAlias" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentAlias" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentAliases" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentAlias" + } + ] + }, + "com.amazonaws.bedrockagent#AmazonBedrockAgentBuildTimeLambda": { + "type": "service", + "version": "2023-06-05", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.bedrockagent#GetResourcePolicy" + }, + { + "target": "com.amazonaws.bedrockagent#PutResourcePolicy" + }, + { + "target": "com.amazonaws.bedrockagent#ValidateFlowDefinition" + } + ], + "resources": [ + { + "target": "com.amazonaws.bedrockagent#ActionGroupResource" + }, + { + "target": "com.amazonaws.bedrockagent#AgentCollaboratorResource" + }, + { + "target": "com.amazonaws.bedrockagent#AgentResource" + }, + { + "target": "com.amazonaws.bedrockagent#AliasResource" + }, + { + "target": "com.amazonaws.bedrockagent#DataSourceResource" + }, + { + "target": "com.amazonaws.bedrockagent#FlowResource" + }, + { + "target": "com.amazonaws.bedrockagent#IngestionJobResource" + }, + { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocumentResource" + }, + { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseResource" + }, + { + "target": "com.amazonaws.bedrockagent#PromptResource" + }, + { + "target": "com.amazonaws.bedrockagent#TaggingResource" + }, + { + "target": "com.amazonaws.bedrockagent#VersionResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Bedrock Agent", + "arnNamespace": "bedrock", + "endpointPrefix": "bedrock-agent", + "cloudTrailEventSource": "bedrock.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "bedrock" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "Describes the API operations for creating and managing Amazon Bedrock agents.
", + "smithy.api#title": "Agents for Amazon Bedrock", + "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 + ] + } + ], + "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://bedrock-agent-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://bedrock-agent-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://bedrock-agent.{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://bedrock-agent.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 13, + "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" + }, + "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": [], + "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" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-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://bedrock-agent-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://bedrock-agent.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-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://bedrock-agent-fips.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://bedrock-agent.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://bedrock-agent.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 enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-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://bedrock-agent.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.bedrockagent#AnyToolChoice": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. For more information, see Use a tool to complete an Amazon Bedrock model response.
" + } + }, + "com.amazonaws.bedrockagent#AssociateAgentCollaborator": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#AssociateAgentCollaboratorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#AssociateAgentCollaboratorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Makes an agent a collaborator for another agent.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/agentcollaborators/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#AssociateAgentCollaboratorRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The agent's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "An agent version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentDescriptor": { + "target": "com.amazonaws.bedrockagent#AgentDescriptor", + "traits": { + "smithy.api#documentation": "The alias of the collaborator agent.
", + "smithy.api#required": {} + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "A name for the collaborator.
", + "smithy.api#required": {} + } + }, + "collaborationInstruction": { + "target": "com.amazonaws.bedrockagent#CollaborationInstruction", + "traits": { + "smithy.api#documentation": "Instruction for the collaborator.
", + "smithy.api#required": {} + } + }, + "relayConversationHistory": { + "target": "com.amazonaws.bedrockagent#RelayConversationHistory", + "traits": { + "smithy.api#documentation": "A relay conversation history for the collaborator.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A client token.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#AssociateAgentCollaboratorResponse": { + "type": "structure", + "members": { + "agentCollaborator": { + "target": "com.amazonaws.bedrockagent#AgentCollaborator", + "traits": { + "smithy.api#documentation": "Details about the collaborator.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.
The unique identifier of the agent with which you want to associate the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent with which you want to associate the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to associate with the agent.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of what the agent should use the knowledge base for.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseResponse": { + "type": "structure", + "members": { + "agentKnowledgeBase": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base that has been associated with the agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#AudioConfiguration": { + "type": "structure", + "members": { + "segmentationConfiguration": { + "target": "com.amazonaws.bedrockagent#AudioSegmentationConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for segmenting audio content during processing.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for processing audio content in multimodal knowledge bases.
" + } + }, + "com.amazonaws.bedrockagent#AudioConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AudioConfiguration", + "traits": { + "smithy.api#documentation": "Audio configuration for multi modal ingestion.
" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#AudioExtractionConfiguration": { + "type": "structure", + "members": { + "audioExtractionStatus": { + "target": "com.amazonaws.bedrockagent#EnabledOrDisabledState", + "traits": { + "smithy.api#documentation": "Whether audio extraction is enabled or disabled.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for audio extraction.
" + } + }, + "com.amazonaws.bedrockagent#AudioSegmentationConfiguration": { + "type": "structure", + "members": { + "fixedLengthDuration": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The duration in seconds for each audio segment. Audio files will be divided into chunks of this length for processing.
", + "smithy.api#range": { + "min": 1, + "max": 30 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for segmenting audio content during multimodal knowledge base ingestion. Determines how audio files are divided into chunks for processing.
" + } + }, + "com.amazonaws.bedrockagent#AutoToolChoice": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Defines tools. The model automatically decides whether to call a tool or to generate text instead. For more information, see Use a tool to complete an Amazon Bedrock model response.
" + } + }, + "com.amazonaws.bedrockagent#AwsDataCatalogTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.*\\.*$" + } + }, + "com.amazonaws.bedrockagent#AwsDataCatalogTableNames": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AwsDataCatalogTableName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagent#BasePromptTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#BedrockDataAutomationConfiguration": { + "type": "structure", + "members": { + "parsingModality": { + "target": "com.amazonaws.bedrockagent#ParsingModality", + "traits": { + "smithy.api#documentation": "Specifies whether to enable parsing of multimodal data, including both text and/or images.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for using Amazon Bedrock Data Automation as the parser for ingesting your data sources.
" + } + }, + "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" + } + }, + "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration": { + "type": "structure", + "members": { + "dimensions": { + "target": "com.amazonaws.bedrockagent#Dimensions", + "traits": { + "smithy.api#documentation": "The dimensions details for the vector configuration used on the Bedrock embeddings model.
" + } + }, + "embeddingDataType": { + "target": "com.amazonaws.bedrockagent#EmbeddingDataType", + "traits": { + "smithy.api#documentation": "The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See Supported embeddings models for information on the available models and their vector data types.
" + } + }, + "audio": { + "target": "com.amazonaws.bedrockagent#AudioConfigurations", + "traits": { + "smithy.api#documentation": "Configuration settings for processing audio content in multimodal knowledge bases.
" + } + }, + "video": { + "target": "com.amazonaws.bedrockagent#VideoConfigurations", + "traits": { + "smithy.api#documentation": "Configuration settings for processing video content in multimodal knowledge bases.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The vector configuration details for the Bedrock embeddings model.
" + } + }, + "com.amazonaws.bedrockagent#BedrockFoundationModelConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrockagent#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the foundation model to use for parsing.
", + "smithy.api#required": {} + } + }, + "parsingPrompt": { + "target": "com.amazonaws.bedrockagent#ParsingPrompt", + "traits": { + "smithy.api#documentation": "Instructions for interpreting the contents of a document.
" + } + }, + "parsingModality": { + "target": "com.amazonaws.bedrockagent#ParsingModality", + "traits": { + "smithy.api#documentation": "Specifies whether to enable parsing of multimodal data, including both text and/or images.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for a foundation model used to parse documents for a data source.
" + } + }, + "com.amazonaws.bedrockagent#BedrockFoundationModelContextEnrichmentConfiguration": { + "type": "structure", + "members": { + "enrichmentStrategyConfiguration": { + "target": "com.amazonaws.bedrockagent#EnrichmentStrategyConfiguration", + "traits": { + "smithy.api#documentation": "The enrichment stategy used to provide additional context. For example, Neptune GraphRAG uses Amazon Bedrock foundation models to perform chunk entity extraction.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrockagent#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Context enrichment configuration is used to provide additional context to the RAG application using Amazon Bedrock foundation models.
" + } + }, + "com.amazonaws.bedrockagent#BedrockModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]{1,12})?:(bedrock):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" + } + }, + "com.amazonaws.bedrockagent#BedrockRerankingModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$" + } + }, + "com.amazonaws.bedrockagent#BucketOwnerAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.bedrockagent#ByteContentBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5242880 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#ByteContentDoc": { + "type": "structure", + "members": { + "mimeType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The MIME type of the content. For a list of MIME types, see Media Types. The following MIME types are supported:
text/plain
text/html
text/csv
text/vtt
message/rfc822
application/xhtml+xml
application/pdf
application/msword
application/vnd.ms-word.document.macroenabled.12
application/vnd.ms-word.template.macroenabled.12
application/vnd.ms-excel
application/vnd.ms-excel.addin.macroenabled.12
application/vnd.ms-excel.sheet.macroenabled.12
application/vnd.ms-excel.template.macroenabled.12
application/vnd.ms-excel.sheet.binary.macroenabled.12
application/vnd.ms-spreadsheetml
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.spreadsheetml.template
application/vnd.openxmlformats-officedocument.wordprocessingml.document
application/vnd.openxmlformats-officedocument.wordprocessingml.template
The base64-encoded string of the content.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about content defined inline in bytes.
" + } + }, + "com.amazonaws.bedrockagent#CachePointBlock": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#CachePointType", + "traits": { + "smithy.api#documentation": "Indicates that the CachePointBlock is of the default type
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates where a cache checkpoint is located. All information before this checkpoint is cached to be accessed on subsequent requests.
" + } + }, + "com.amazonaws.bedrockagent#CachePointType": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, + "com.amazonaws.bedrockagent#ChatPromptTemplateConfiguration": { + "type": "structure", + "members": { + "messages": { + "target": "com.amazonaws.bedrockagent#Messages", + "traits": { + "smithy.api#documentation": "Contains messages in the chat for the prompt.
", + "smithy.api#required": {} + } + }, + "system": { + "target": "com.amazonaws.bedrockagent#SystemContentBlocks", + "traits": { + "smithy.api#documentation": "Contains system prompts to provide context to the model or to describe how it should behave.
" + } + }, + "inputVariables": { + "target": "com.amazonaws.bedrockagent#PromptInputVariablesList", + "traits": { + "smithy.api#documentation": "An array of the variables in the prompt template.
" + } + }, + "toolConfiguration": { + "target": "com.amazonaws.bedrockagent#ToolConfiguration", + "traits": { + "smithy.api#documentation": "Configuration information for the tools that the model can use when generating a response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations to use a prompt in a conversational format. For more information, see Create a prompt using Prompt management.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#ChunkingConfiguration": { + "type": "structure", + "members": { + "chunkingStrategy": { + "target": "com.amazonaws.bedrockagent#ChunkingStrategy", + "traits": { + "smithy.api#documentation": "Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.
HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.
NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
" + } + }, + "semanticChunkingConfiguration": { + "target": "com.amazonaws.bedrockagent#SemanticChunkingConfiguration", + "traits": { + "smithy.api#documentation": "Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" + } + }, + "com.amazonaws.bedrockagent#ChunkingStrategy": { + "type": "enum", + "members": { + "FIXED_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED_SIZE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "HIERARCHICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIERARCHICAL" + } + }, + "SEMANTIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEMANTIC" + } + } + } + }, + "com.amazonaws.bedrockagent#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 33, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}$" + } + }, + "com.amazonaws.bedrockagent#CollaborationInstruction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#CollectorFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#ColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" + } + }, + "com.amazonaws.bedrockagent#ConcurrencyType": { + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Automatic" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Manual" + } + } + } + }, + "com.amazonaws.bedrockagent#ConditionFlowNodeConfiguration": { + "type": "structure", + "members": { + "conditions": { + "target": "com.amazonaws.bedrockagent#FlowConditions", + "traits": { + "smithy.api#documentation": "An array of conditions. Each member contains the name of a condition and an expression that defines the condition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "There was a conflict performing an operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.bedrockagent#ConfluenceAuthType": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "OAUTH2_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" + } + } + } + }, + "com.amazonaws.bedrockagent#ConfluenceCrawlerConfiguration": { + "type": "structure", + "members": { + "filterConfiguration": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of filtering the Confluence content. For example, configuring regular expression patterns to include or exclude certain content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the Confluence content. For example, configuring specific types of Confluence content.
" + } + }, + "com.amazonaws.bedrockagent#ConfluenceDataSourceConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#ConfluenceSourceConfiguration", + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your Confluence data source.
", + "smithy.api#required": {} + } + }, + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#ConfluenceCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the Confluence content. For example, configuring specific types of Confluence content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information to connect to Confluence as your data source for self-managed knowledge bases.
" + } + }, + "com.amazonaws.bedrockagent#ConfluenceHostType": { + "type": "enum", + "members": { + "SAAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAAS" + } + } + } + }, + "com.amazonaws.bedrockagent#ConfluenceSourceConfiguration": { + "type": "structure", + "members": { + "hostUrl": { + "target": "com.amazonaws.bedrockagent#HttpsUrl", + "traits": { + "smithy.api#documentation": "The Confluence host URL or instance URL.
", + "smithy.api#required": {} + } + }, + "hostType": { + "target": "com.amazonaws.bedrockagent#ConfluenceHostType", + "traits": { + "smithy.api#documentation": "The supported host type, whether online/cloud or server/on-premises.
", + "smithy.api#required": {} + } + }, + "authType": { + "target": "com.amazonaws.bedrockagent#ConfluenceAuthType", + "traits": { + "smithy.api#documentation": "The supported authentication type to authenticate and connect to your Confluence instance.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Confluence connection configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your Confluence data source.
" + } + }, + "com.amazonaws.bedrockagent#ContentBlock": { + "type": "union", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text in the message.
" + } + }, + "cachePoint": { + "target": "com.amazonaws.bedrockagent#CachePointBlock", + "traits": { + "smithy.api#documentation": "Creates a cache checkpoint within a message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the content for the message you pass to, or receive from a model. For more information, see Create a prompt using Prompt management.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#ContentBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#ContentBlock" + } + }, + "com.amazonaws.bedrockagent#ContentDataSourceType": { + "type": "enum", + "members": { + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + } + } + }, + "com.amazonaws.bedrockagent#ContextEnrichmentConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#ContextEnrichmentType", + "traits": { + "smithy.api#documentation": "The method used for context enrichment. It must be Amazon Bedrock foundation models.
", + "smithy.api#required": {} + } + }, + "bedrockFoundationModelConfiguration": { + "target": "com.amazonaws.bedrockagent#BedrockFoundationModelContextEnrichmentConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the Amazon Bedrock foundation model used for context enrichment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Context enrichment configuration is used to provide additional context to the RAG application.
" + } + }, + "com.amazonaws.bedrockagent#ContextEnrichmentType": { + "type": "enum", + "members": { + "BEDROCK_FOUNDATION_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_FOUNDATION_MODEL" + } + } + } + }, + "com.amazonaws.bedrockagent#ConversationRole": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user" + } + }, + "ASSISTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "assistant" + } + } + } + }, + "com.amazonaws.bedrockagent#CrawlFilterConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfigurationType", + "traits": { + "smithy.api#documentation": "The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.
The configuration of filtering certain objects or content types of the data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of filtering the data source content. For example, configuring regular expression patterns to include or exclude certain content.
" + } + }, + "com.amazonaws.bedrockagent#CrawlFilterConfigurationType": { + "type": "enum", + "members": { + "PATTERN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PATTERN" + } + } + } + }, + "com.amazonaws.bedrockagent#CreateAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
Specify the following fields for security purposes.
agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
(Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.
To enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration object. For more information, see Configure memory.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
If your agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.
To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter.
You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
The unique identifier of the agent for which to create the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent for which to create the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name to give the action group.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the action group.
" + } + }, + "parentActionGroupSignature": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.
ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" + } + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema", + "traits": { + "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" + } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#documentation": "Contains details about the action group that was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an alias of an agent that can be used to deploy the agent.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/{agentId}/agentaliases/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the alias of the agent.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "Any tags that you want to attach to the alias of the agent.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentAliasResponse": { + "type": "structure", + "members": { + "agentAlias": { + "target": "com.amazonaws.bedrockagent#AgentAlias", + "traits": { + "smithy.api#documentation": "Contains details about the alias that was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentRequest": { + "type": "structure", + "members": { + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "A name for the agent that you create.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "Instructions that tell the agent what it should do and how it should interact with users.
" + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for the model that you want to be used for orchestration by the agent you create.
The modelId to provide depends on the type of model or throughput that you use:
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.
If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.
A description of the agent.
" + } + }, + "orchestrationType": { + "target": "com.amazonaws.bedrockagent#OrchestrationType", + "traits": { + "smithy.api#documentation": " Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
Contains details of the custom orchestration configured for the agent.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "Any tags that you want to attach to the agent.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The unique Guardrail configuration assigned to the agent when it is created.
" + } + }, + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", + "traits": { + "smithy.api#documentation": "Contains the details of the memory configured for the agent.
" + } + }, + "agentCollaboration": { + "target": "com.amazonaws.bedrockagent#AgentCollaboration", + "traits": { + "smithy.api#documentation": "The agent's collaboration role.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentResponse": { + "type": "structure", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", + "traits": { + "smithy.api#documentation": "Contains details about the agent created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the dataSourceConfiguration field.
You can't change the chunkingConfiguration after you create the data source connector.
The unique identifier of the knowledge base to which to add the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the data source.
" + } + }, + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The connection configuration for the data source.
", + "smithy.api#required": {} + } + }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "The data deletion policy for the data source.
You can set the data deletion policy to:
DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted, only the data. This flag is ignored if an Amazon Web Services account is deleted.
RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted if you delete a knowledge base or data source resource.
For managed knowledge bases, the only supported option is DELETE, which is also the default.
Contains details about the server-side encryption for the data source.
" + } + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", + "traits": { + "smithy.api#documentation": "Contains details about the data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/flows/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateFlowAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateFlowAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateFlowAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/flows/{flowIdentifier}/aliases" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateFlowAliasRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "A name for the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description for the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version to which to map the alias.
", + "smithy.api#required": {} + } + }, + "concurrencyConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasConcurrencyConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies how nodes in the flow are executed in parallel.
" + } + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow for which to create an alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowAliasResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", + "smithy.api#required": {} + } + }, + "concurrencyConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasConcurrencyConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies how nodes in the flow are executed in parallel.
" + } + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias of the flow was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "A name for the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "A description for the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "A definition of the nodes and connections between nodes in the flow.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared. If creation fails, the status becomes Failed.
The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was last updated.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the flow. When you create a flow, the version created is the DRAFT version.
A definition of the nodes and connections between nodes in the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateFlowVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateFlowVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/flows/{flowIdentifier}/versions" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateFlowVersionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that you want to create a version of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "A description of the version of the flow.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowVersionResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the version.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the version.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The KMS key that the flow is encrypted with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow that was created. Versions are numbered incrementally, starting from 1.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "A definition of the nodes and connections in the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up a knowledge base.
To create a managed knowledge base, provide a managedKnowledgeBaseConfiguration during creation. For more information, see Build a managed knowledge base.
Provide the name and an optional description.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.
For managed knowledge bases, set embeddingModelType to MANAGED to use the service-managed embedding model, or CUSTOM with an embeddingModelArn to use your own. To use your own KMS key for encryption, provide the ARN in serverSideEncryptionConfiguration. No vector store configuration is required for managed knowledge bases.
For self-managed knowledge bases, provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.
For self-managed knowledge bases, provide the configuration for your vector store in the storageConfiguration object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "A name for the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the knowledge base.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the embeddings model used for the knowledge base.
", + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the configuration of the vector database used for the knowledge base.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreatePrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreatePromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreatePromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/prompts/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreatePromptRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "A name for the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "A description for the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreatePromptResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "The description of the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for your prompt.
" + } + }, + "variants": { + "target": "com.amazonaws.bedrockagent#PromptVariantList", + "traits": { + "smithy.api#documentation": "A list of objects, each containing details about a variant of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt. When you create a prompt, the version created is the DRAFT version.
The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreatePromptVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreatePromptVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreatePromptVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/prompts/{promptIdentifier}/versions" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreatePromptVersionRequest": { + "type": "structure", + "members": { + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt that you want to create a version of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "A description for the version of the prompt.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreatePromptVersionResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "A description for the version.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the version of the prompt.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt that was created. Versions are numbered incrementally, starting from 1.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreationMode": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "OVERRIDDEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDDEN" + } + } + } + }, + "com.amazonaws.bedrockagent#CuratedQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#CuratedQuery" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#CuratedQuery": { + "type": "structure", + "members": { + "naturalLanguage": { + "target": "com.amazonaws.bedrockagent#NaturalLanguageString", + "traits": { + "smithy.api#documentation": "An example natural language query.
", + "smithy.api#required": {} + } + }, + "sql": { + "target": "com.amazonaws.bedrockagent#SqlString", + "traits": { + "smithy.api#documentation": "The SQL equivalent of the natural language query.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a query, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
" + } + }, + "com.amazonaws.bedrockagent#CustomContent": { + "type": "structure", + "members": { + "customDocumentIdentifier": { + "target": "com.amazonaws.bedrockagent#CustomDocumentIdentifier", + "traits": { + "smithy.api#documentation": "A unique identifier for the document.
", + "smithy.api#required": {} + } + }, + "sourceType": { + "target": "com.amazonaws.bedrockagent#CustomSourceType", + "traits": { + "smithy.api#documentation": "The source of the data to ingest.
", + "smithy.api#required": {} + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagent#CustomS3Location", + "traits": { + "smithy.api#documentation": "Contains information about the Amazon S3 location of the file from which to ingest data.
" + } + }, + "inlineContent": { + "target": "com.amazonaws.bedrockagent#InlineContent", + "traits": { + "smithy.api#documentation": "Contains information about content defined inline to ingest into a knowledge base.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the content to ingest into a knowledge base connected to a custom data source. Choose a sourceType and include the field that corresponds to it.
The identifier of the document to ingest into a custom data source.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the identifier of the document to ingest into a custom data source.
" + } + }, + "com.amazonaws.bedrockagent#CustomOrchestration": { + "type": "structure", + "members": { + "executor": { + "target": "com.amazonaws.bedrockagent#OrchestrationExecutor", + "traits": { + "smithy.api#documentation": "The structure of the executor invoking the actions in custom orchestration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of custom orchestration.
" + } + }, + "com.amazonaws.bedrockagent#CustomS3Location": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagent#S3ObjectUri", + "traits": { + "smithy.api#documentation": "The S3 URI of the file containing the content to ingest.
", + "smithy.api#required": {} + } + }, + "bucketOwnerAccountId": { + "target": "com.amazonaws.bedrockagent#BucketOwnerAccountId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services account that owns the S3 bucket containing the content to ingest.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon S3 location of the file containing the content to ingest into a knowledge base connected to a custom data source.
" + } + }, + "com.amazonaws.bedrockagent#CustomSourceType": { + "type": "enum", + "members": { + "IN_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_LINE" + } + }, + "S3_LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_LOCATION" + } + } + } + }, + "com.amazonaws.bedrockagent#CustomTransformationConfiguration": { + "type": "structure", + "members": { + "intermediateStorage": { + "target": "com.amazonaws.bedrockagent#IntermediateStorage", + "traits": { + "smithy.api#documentation": "An S3 bucket path for input and output objects.
", + "smithy.api#required": {} + } + }, + "transformations": { + "target": "com.amazonaws.bedrockagent#Transformations", + "traits": { + "smithy.api#documentation": "A Lambda function that processes documents.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for customizing steps in the data source content ingestion pipeline.
You can configure the data source to process documents with a Lambda function after they are parsed and converted into chunks. When you add a post-chunking transformation, the service stores chunked documents in an S3 bucket and invokes a Lambda function to process them.
To process chunked documents with a Lambda function, define an S3 bucket path for input and output objects, and a transformation that specifies the Lambda function to invoke. You can use the Lambda function to customize how chunks are split, and the metadata for each chunk.
" + } + }, + "com.amazonaws.bedrockagent#CyclicConnectionFlowValidationDetails": { + "type": "structure", + "members": { + "connection": { + "target": "com.amazonaws.bedrockagent#FlowConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection that causes the cycle in the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a cyclic connection detected in the flow.
" + } + }, + "com.amazonaws.bedrockagent#Data": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5242880 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#DataDeletionPolicy": { + "type": "enum", + "members": { + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETAIN" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.bedrockagent#DataSource": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source belongs.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source. The following statuses are possible:
Available – The data source has been created and is ready for ingestion into the knowledge base.
Deleting – The data source is being deleted.
The description of the data source.
" + } + }, + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The connection configuration for the data source.
", + "smithy.api#required": {} + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the configuration of the server-side encryption.
" + } + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" + } + }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "The data deletion policy for the data source.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the data source was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the data source was last updated.
", + "smithy.api#required": {} + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "The detailed reasons on the failure to delete a data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a data source.
" + } + }, + "com.amazonaws.bedrockagent#DataSourceConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of data source.
", + "smithy.api#required": {} + } + }, + "managedKnowledgeBaseConnectorConfiguration": { + "target": "com.amazonaws.bedrockagent#ManagedKnowledgeBaseConnectorConfiguration", + "traits": { + "smithy.api#documentation": "Contains the configuration for a data source that connects a managed knowledge base to a supported data source connector. Specify this object when the data source type is MANAGED_KNOWLEDGE_BASE_CONNECTOR.
The configuration information to connect to Amazon S3 as your data source for self-managed knowledge bases. To configure this data source for managed knowledge bases, use managedKnowledgeBaseConnectorConfiguration.
" + } + }, + "webConfiguration": { + "target": "com.amazonaws.bedrockagent#WebDataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs.
To configure this data source for managed knowledge bases, use managedKnowledgeBaseConnectorConfiguration. Web crawler data source connector for self-managed knowledge bases is in preview release and is subject to change.
The configuration information to connect to Confluence as your data source for self-managed knowledge bases.
To configure this data source for managed knowledge bases, use managedKnowledgeBaseConnectorConfiguration. Confluence data source connector for self-managed knowledge bases is in preview release and is subject to change.
The configuration information to connect to Salesforce as your data source.
Salesforce data source connector for self-managed knowledge bases is in preview release and is subject to change.
The configuration information to connect to SharePoint as your data source for self-managed knowledge bases.
To configure this data source for managed knowledge bases, use managedKnowledgeBaseConnectorConfiguration. SharePoint data source connector for self-managed knowledge bases is in preview release and is subject to change.
The connection configuration for the data source.
" + } + }, + "com.amazonaws.bedrockagent#DataSourceResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateDataSource" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteDataSource" + }, + { + "target": "com.amazonaws.bedrockagent#GetDataSource" + }, + { + "target": "com.amazonaws.bedrockagent#ListDataSources" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateDataSource" + } + ] + }, + "com.amazonaws.bedrockagent#DataSourceStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrockagent#DataSourceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#DataSourceSummary" + } + }, + "com.amazonaws.bedrockagent#DataSourceSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source belongs.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the data source.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the data source was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a data source.
" + } + }, + "com.amazonaws.bedrockagent#DataSourceType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "WEB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEB" + } + }, + "CONFLUENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLUENCE" + } + }, + "SALESFORCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCE" + } + }, + "SHAREPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHAREPOINT" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "REDSHIFT_METADATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDSHIFT_METADATA" + } + }, + "MANAGED_KNOWLEDGE_BASE_CONNECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED_KNOWLEDGE_BASE_CONNECTOR" + } + } + } + }, + "com.amazonaws.bedrockagent#DateTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.bedrockagent#DeleteAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an agent.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an action group in an agent.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the action group belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent that the action group belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
Deletes an alias of an agent.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the alias belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentAliasResponse": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the alias belongs to.
", + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias that was deleted.
", + "smithy.api#required": {} + } + }, + "agentAliasStatus": { + "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "traits": { + "smithy.api#documentation": "The status of the alias.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the agent that was deleted.
", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a version of an agent.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentVersionRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the version belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the agent to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version that was deleted.
", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent version.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a data source from a knowledge base.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteDataSourceRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base from which to delete the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteDataSourceResponse": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source that was deleted belonged.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source that was deleted.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a flow.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/flows/{flowIdentifier}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteFlowAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteFlowAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteFlowAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an alias of a flow.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteFlowAliasRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aliasIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteFlowAliasResponse": { + "type": "structure", + "members": { + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteFlowRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteFlowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteFlowVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteFlowVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a version of a flow.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/flows/{flowIdentifier}/versions/{flowVersion}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteFlowVersionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow whose version that you want to delete
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow being deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/knowledgebases/{knowledgeBaseId}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseDocuments": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseDocumentsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseDocumentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/documents/deleteDocuments" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseDocumentsRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that is connected to the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source that contains the documents.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "documentIdentifiers": { + "target": "com.amazonaws.bedrockagent#DocumentIdentifiers", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information to identify a document to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseDocumentsResponse": { + "type": "structure", + "members": { + "documentDetails": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocumentDetails", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information about the documents that were deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that was deleted.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "The status of the knowledge base and whether it has been successfully deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeletePrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeletePromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeletePromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
The unique identifier of the prompt.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "promptVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the prompt to delete. To delete the prompt, omit this field.
", + "smithy.api#httpQuery": "promptVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeletePromptResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt that was deleted.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the prompt that was deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the resource policy associated with a knowledge base. After deletion, other AWS accounts can no longer access the knowledge base using cross-account permissions.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/resourcepolicy/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagent#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base to remove the resource policy from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "expectedRevisionId": { + "target": "com.amazonaws.bedrockagent#RevisionId", + "traits": { + "smithy.api#documentation": "The expected revision identifier of the resource policy. Use this to prevent conflicts when multiple users update the same policy concurrently.
", + "smithy.api#httpQuery": "expectedRevisionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteResourcePolicyResponse": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#ResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the knowledge base that the resource policy was removed from.
", + "smithy.api#required": {} + } + }, + "revisionId": { + "target": "com.amazonaws.bedrockagent#RevisionId", + "traits": { + "smithy.api#documentation": "The revision identifier after the resource policy was deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeletionProtectionConfiguration": { + "type": "structure", + "members": { + "deletionProtectionStatus": { + "target": "com.amazonaws.bedrockagent#EnabledOrDisabledState", + "traits": { + "smithy.api#documentation": "Enable or disable deletion protection for the connector.
", + "smithy.api#required": {} + } + }, + "deletionProtectionThreshold": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 15, + "smithy.api#documentation": "The threshold is the maximum percentage of documents that a sync job can delete from your index. If a sync would delete more than this percentage, the sync skips its delete phase, leaving your indexed documents in place. Not supported for the Custom connector.
", + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for deletion protection.
" + } + }, + "com.amazonaws.bedrockagent#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#DescriptionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#Dimensions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentCollaborator": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DisassociateAgentCollaboratorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DisassociateAgentCollaboratorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates an agent collaborator.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/agentcollaborators/{collaboratorId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentCollaboratorRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "An agent ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The agent's version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "collaboratorId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The collaborator's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentCollaboratorResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates a knowledge base from an agent.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent from which to disassociate the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent from which to disassociate the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to disassociate.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DocumentAccessControlEntry": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The user identifier.
", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#AccessControlPrincipalType", + "traits": { + "smithy.api#documentation": "The type of principal.
", + "smithy.api#required": {} + } + }, + "access": { + "target": "com.amazonaws.bedrockagent#AccessControlAccess", + "traits": { + "smithy.api#documentation": "Whether to allow or deny access.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An access control entry specifying a principal and their access level.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#DocumentAccessControlList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#DocumentAccessControlEntry" + }, + "traits": { + "smithy.api#documentation": "List of access control entries for a document.
", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagent#DocumentContent": { + "type": "structure", + "members": { + "dataSourceType": { + "target": "com.amazonaws.bedrockagent#ContentDataSourceType", + "traits": { + "smithy.api#documentation": "The type of data source that is connected to the knowledge base to which to ingest this document.
", + "smithy.api#required": {} + } + }, + "custom": { + "target": "com.amazonaws.bedrockagent#CustomContent", + "traits": { + "smithy.api#documentation": "Contains information about the content to ingest into a knowledge base connected to a custom data source.
" + } + }, + "s3": { + "target": "com.amazonaws.bedrockagent#S3Content", + "traits": { + "smithy.api#documentation": "Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the content of a document. Choose a dataSourceType and include the field that corresponds to it.
The type of data source connected to the knowledge base that contains the document.
", + "smithy.api#required": {} + } + }, + "s3": { + "target": "com.amazonaws.bedrockagent#S3Location", + "traits": { + "smithy.api#documentation": "Contains information that identifies the document in an S3 data source.
" + } + }, + "custom": { + "target": "com.amazonaws.bedrockagent#CustomDocumentIdentifier", + "traits": { + "smithy.api#documentation": "Contains information that identifies the document in a custom data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information that identifies the document.
" + } + }, + "com.amazonaws.bedrockagent#DocumentIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#DocumentIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#DocumentMetadata": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#MetadataSourceType", + "traits": { + "smithy.api#documentation": "The type of the source source from which to add metadata.
", + "smithy.api#required": {} + } + }, + "inlineAttributes": { + "target": "com.amazonaws.bedrockagent#MetadataAttributes", + "traits": { + "smithy.api#documentation": "An array of objects, each of which defines a metadata attribute to associate with the content to ingest. You define the attributes inline.
", + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagent#CustomS3Location", + "traits": { + "smithy.api#documentation": "The Amazon S3 location of the file containing metadata to associate with the content to ingest.
" + } + }, + "accessControlList": { + "target": "com.amazonaws.bedrockagent#DocumentAccessControlList", + "traits": { + "smithy.api#documentation": "Access control list for the document. Used when metadata type is IN_LINE_ATTRIBUTE.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the metadata associate with the content to ingest into a knowledge base. Choose a type and include the field that corresponds to it.
The name of the node containing the duplicate condition expressions.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrockagent#FlowConditionExpression", + "traits": { + "smithy.api#documentation": "The duplicated condition expression.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about duplicate condition expressions found in a condition node.
" + } + }, + "com.amazonaws.bedrockagent#DuplicateConnectionsFlowValidationDetails": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the source node where the duplicate connection starts.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the target node where the duplicate connection ends.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about duplicate connections found between two nodes in the flow.
" + } + }, + "com.amazonaws.bedrockagent#EmbeddingDataType": { + "type": "enum", + "members": { + "FLOAT32": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOAT32" + } + }, + "BINARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BINARY" + } + } + }, + "traits": { + "smithy.api#documentation": "Bedrock models embedding data type. Can be either float32 or binary.
" + } + }, + "com.amazonaws.bedrockagent#EmbeddingModelConfiguration": { + "type": "structure", + "members": { + "bedrockEmbeddingModelConfiguration": { + "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration", + "traits": { + "smithy.api#documentation": "The vector configuration details on the Bedrock embeddings model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for the embeddings model.
" + } + }, + "com.amazonaws.bedrockagent#EmbeddingModelType": { + "type": "enum", + "members": { + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED" + } + } + }, + "traits": { + "smithy.api#documentation": "Choose CUSTOM to provide your own Bedrock embedding model ARN. Choose MANAGED to use a service-managed embedding model. For more information, see Embedding model options.
The method used for the context enrichment strategy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The strategy used for performing context enrichment.
" + } + }, + "com.amazonaws.bedrockagent#EnrichmentStrategyMethod": { + "type": "enum", + "members": { + "CHUNK_ENTITY_EXTRACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHUNK_ENTITY_EXTRACTION" + } + } + } + }, + "com.amazonaws.bedrockagent#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#FailureReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#FailureReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FailureReason" + }, + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#FieldForReranking": { + "type": "structure", + "members": { + "fieldName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the metadata field to include or exclude during reranking.
", + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a metadata field to include or exclude during the reranking process.
" + } + }, + "com.amazonaws.bedrockagent#FieldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#FieldsForReranking": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FieldForReranking" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FilterPattern" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FilterPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FilteredObjectType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FixedSizeChunkingConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to include in a chunk.
", + "smithy.api#range": { + "min": 1, + "max": 8192 + }, + "smithy.api#required": {} + } + }, + "overlapPercentage": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The percentage of overlap between adjacent chunks of a data source.
", + "smithy.api#range": { + "min": 1, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
The type of concurrency to use for parallel node execution. Specify one of the following options:
Automatic - Amazon Bedrock determines which nodes can be executed in parallel based on the flow definition and its dependencies.
Manual - You specify which nodes can be executed in parallel.
The maximum number of nodes that can be executed concurrently in the flow.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Determines how multiple nodes in a flow can run in parallel. Running nodes concurrently can improve your flow's performance.
" + } + }, + "com.amazonaws.bedrockagent#FlowAliasId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(TSTALIASID|[0-9a-zA-Z]{10})$" + } + }, + "com.amazonaws.bedrockagent#FlowAliasIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(TSTALIASID|[0-9a-zA-Z]{10})$" + } + }, + "com.amazonaws.bedrockagent#FlowAliasResource": { + "type": "resource", + "identifiers": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier" + }, + "aliasIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrockagent#CreateFlowAlias" + }, + "read": { + "target": "com.amazonaws.bedrockagent#GetFlowAlias" + }, + "update": { + "target": "com.amazonaws.bedrockagent#UpdateFlowAlias" + }, + "delete": { + "target": "com.amazonaws.bedrockagent#DeleteFlowAlias" + }, + "list": { + "target": "com.amazonaws.bedrockagent#ListFlowAliases" + }, + "traits": { + "aws.api#arn": { + "template": "flow/{flowIdentifier}/alias/{aliasIdentifier}" + }, + "aws.cloudformation#cfnResource": { + "name": "FlowAlias" + } + } + }, + "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfigurationListItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#FlowAliasRoutingConfigurationListItem": { + "type": "structure", + "members": { + "flowVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version that the alias maps to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a version that the alias maps to.
" + } + }, + "com.amazonaws.bedrockagent#FlowAliasSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowAliasSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#FlowAliasSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "A list of configurations about the versions that the alias maps to. Currently, you can only specify one.
", + "smithy.api#required": {} + } + }, + "concurrencyConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasConcurrencyConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies how nodes in the flow are executed concurrently.
" + } + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an alias of a flow.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrockagent#FlowArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#FlowCondition": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowConditionName", + "traits": { + "smithy.api#documentation": "A name for the condition that you can reference.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrockagent#FlowConditionExpression", + "traits": { + "smithy.api#documentation": "Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in Node types in prompt flows.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a condition in the condition node.
" + } + }, + "com.amazonaws.bedrockagent#FlowConditionExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowConditionName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagent#FlowConditionalConnectionConfiguration": { + "type": "structure", + "members": { + "condition": { + "target": "com.amazonaws.bedrockagent#FlowConditionName", + "traits": { + "smithy.api#documentation": "The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the Node types topic in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of a connection between a condition node and another node.
" + } + }, + "com.amazonaws.bedrockagent#FlowConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowCondition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagent#FlowConnection": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#FlowConnectionType", + "traits": { + "smithy.api#documentation": "Whether the source node that the connection begins from is a condition node (Conditional) or not (Data).
A name for the connection that you can reference.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The node that the connection starts at.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The node that the connection ends at.
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.bedrockagent#FlowConnectionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the connection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a connection between two nodes in the flow.
" + } + }, + "com.amazonaws.bedrockagent#FlowConnectionConfiguration": { + "type": "union", + "members": { + "data": { + "target": "com.amazonaws.bedrockagent#FlowDataConnectionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of a connection originating from a node that isn't a Condition node.
" + } + }, + "conditional": { + "target": "com.amazonaws.bedrockagent#FlowConditionalConnectionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of a connection originating from a Condition node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the connection.
" + } + }, + "com.amazonaws.bedrockagent#FlowConnectionName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$" + } + }, + "com.amazonaws.bedrockagent#FlowConnectionType": { + "type": "enum", + "members": { + "DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Data" + } + }, + "CONDITIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Conditional" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowConnections": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowConnection" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.bedrockagent#FlowDataConnectionConfiguration": { + "type": "structure", + "members": { + "sourceOutput": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "The name of the output in the source node that the connection begins from.
", + "smithy.api#required": {} + } + }, + "targetInput": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "The name of the input in the target node that the connection ends at.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of a connection originating from a node that isn't a Condition node.
" + } + }, + "com.amazonaws.bedrockagent#FlowDefinition": { + "type": "structure", + "members": { + "nodes": { + "target": "com.amazonaws.bedrockagent#FlowNodes", + "traits": { + "smithy.api#documentation": "An array of node definitions in the flow.
" + } + }, + "connections": { + "target": "com.amazonaws.bedrockagent#FlowConnections", + "traits": { + "smithy.api#documentation": "An array of connection definitions in the flow.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The definition of the nodes and connections between nodes in the flow.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#FlowExecutionRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$" + } + }, + "com.amazonaws.bedrockagent#FlowId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#FlowIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$" + } + }, + "com.amazonaws.bedrockagent#FlowKnowledgeBaseId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^$|^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#FlowLambdaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^$|^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:lambda:([a-z]{2,}-){2,}\\d:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.bedrockagent#FlowLexBotAliasArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 78 + }, + "smithy.api#pattern": "^$|^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:lex:([a-z]{2,}-){2,}\\d:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#FlowLexBotLocaleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#FlowName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#FlowNode": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "A name for the node.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#FlowNodeType", + "traits": { + "smithy.api#documentation": "The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.
Contains configurations for the node.
" + } + }, + "inputs": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputs", + "traits": { + "smithy.api#documentation": "An array of objects, each of which contains information about an input into the node.
" + } + }, + "outputs": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputs", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information about an output from the node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations about a node in the flow.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeConfiguration": { + "type": "union", + "members": { + "input": { + "target": "com.amazonaws.bedrockagent#InputFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.
Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.
Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.
" + } + }, + "condition": { + "target": "com.amazonaws.bedrockagent#ConditionFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.
" + } + }, + "lex": { + "target": "com.amazonaws.bedrockagent#LexFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.
" + } + }, + "prompt": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.
" + } + }, + "lambdaFunction": { + "target": "com.amazonaws.bedrockagent#LambdaFunctionFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.
" + } + }, + "storage": { + "target": "com.amazonaws.bedrockagent#StorageFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.
" + } + }, + "agent": { + "target": "com.amazonaws.bedrockagent#AgentFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.
" + } + }, + "retrieval": { + "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
" + } + }, + "iterator": { + "target": "com.amazonaws.bedrockagent#IteratorFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" + } + }, + "collector": { + "target": "com.amazonaws.bedrockagent#CollectorFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.
" + } + }, + "inlineCode": { + "target": "com.amazonaws.bedrockagent#InlineCodeFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.
" + } + }, + "loop": { + "target": "com.amazonaws.bedrockagent#LoopFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a DoWhile loop in your flow.
" + } + }, + "loopInput": { + "target": "com.amazonaws.bedrockagent#LoopInputFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains input node configurations for a DoWhile loop in your flow.
" + } + }, + "loopController": { + "target": "com.amazonaws.bedrockagent#LoopControllerFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains controller node configurations for a DoWhile loop in your flow.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a node in your flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeIODataType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Number" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Boolean" + } + }, + "OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Object" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Array" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowNodeInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "Specifies a name for the input that you can reference.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputExpression", + "traits": { + "smithy.api#documentation": "An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.
", + "smithy.api#required": {} + } + }, + "category": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputCategory", + "traits": { + "smithy.api#documentation": "Specifies how input data flows between iterations in a DoWhile loop.
LoopCondition - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue.
ReturnValueToLoopStart - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration.
ExitLoop - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop.
Contains configurations for an input in an Amazon Bedrock Flows node.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeInputCategory": { + "type": "enum", + "members": { + "LOOP_CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoopCondition" + } + }, + "RETURN_VALUE_TO_LOOP_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReturnValueToLoopStart" + } + }, + "EXIT_LOOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExitLoop" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowNodeInputExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowNodeInputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagent#FlowNodeInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowNodeInput" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.bedrockagent#FlowNodeName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagent#FlowNodeOutput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "A name for the output that you can reference.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for an output from a node.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeOutputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagent#FlowNodeOutputs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutput" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.bedrockagent#FlowNodeType": { + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Input" + } + }, + "OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Output" + } + }, + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KnowledgeBase" + } + }, + "CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Condition" + } + }, + "LEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lex" + } + }, + "PROMPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Prompt" + } + }, + "LAMBDA_FUNCTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LambdaFunction" + } + }, + "STORAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Storage" + } + }, + "AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Agent" + } + }, + "RETRIEVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Retrieval" + } + }, + "ITERATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Iterator" + } + }, + "COLLECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Collector" + } + }, + "INLINE_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InlineCode" + } + }, + "LOOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Loop" + } + }, + "LOOP_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoopInput" + } + }, + "LOOP_CONTROLLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoopController" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowNodes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowNode" + }, + "traits": { + "smithy.api#length": { + "max": 40 + } + } + }, + "com.amazonaws.bedrockagent#FlowPromptArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^$|^(arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)$" + } + }, + "com.amazonaws.bedrockagent#FlowPromptModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^$|^(arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" + } + }, + "com.amazonaws.bedrockagent#FlowResource": { + "type": "resource", + "identifiers": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrockagent#CreateFlow" + }, + "read": { + "target": "com.amazonaws.bedrockagent#GetFlow" + }, + "update": { + "target": "com.amazonaws.bedrockagent#UpdateFlow" + }, + "delete": { + "target": "com.amazonaws.bedrockagent#DeleteFlow" + }, + "list": { + "target": "com.amazonaws.bedrockagent#ListFlows" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagent#PrepareFlow" + } + ], + "resources": [ + { + "target": "com.amazonaws.bedrockagent#FlowAliasResource" + }, + { + "target": "com.amazonaws.bedrockagent#FlowVersionResource" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Flow" + } + } + }, + "com.amazonaws.bedrockagent#FlowS3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^$|^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.bedrockagent#FlowStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Prepared" + } + }, + "PREPARING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Preparing" + } + }, + "NOT_PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotPrepared" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#FlowSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "A description of the flow.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. The following statuses are possible:
NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.
Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.
Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.
Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.
The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was last updated.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The latest version of the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the definition of a flow.
" + } + }, + "com.amazonaws.bedrockagent#FlowValidation": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString", + "traits": { + "smithy.api#documentation": "A message describing the validation error.
", + "smithy.api#required": {} + } + }, + "severity": { + "target": "com.amazonaws.bedrockagent#FlowValidationSeverity", + "traits": { + "smithy.api#documentation": "The severity of the issue described in the message.
", + "smithy.api#required": {} + } + }, + "details": { + "target": "com.amazonaws.bedrockagent#FlowValidationDetails", + "traits": { + "smithy.api#documentation": "Specific details about the validation issue encountered in the flow.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#FlowValidationType", + "traits": { + "smithy.api#documentation": "The type of validation issue encountered in the flow.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about validation of the flow.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrockagent#FlowValidationDetails": { + "type": "union", + "members": { + "cyclicConnection": { + "target": "com.amazonaws.bedrockagent#CyclicConnectionFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about a cyclic connection in the flow.
" + } + }, + "duplicateConnections": { + "target": "com.amazonaws.bedrockagent#DuplicateConnectionsFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about duplicate connections between nodes.
" + } + }, + "duplicateConditionExpression": { + "target": "com.amazonaws.bedrockagent#DuplicateConditionExpressionFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about duplicate condition expressions in a node.
" + } + }, + "unreachableNode": { + "target": "com.amazonaws.bedrockagent#UnreachableNodeFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about an unreachable node in the flow.
" + } + }, + "unknownConnectionSource": { + "target": "com.amazonaws.bedrockagent#UnknownConnectionSourceFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about an unknown source node for a connection.
" + } + }, + "unknownConnectionSourceOutput": { + "target": "com.amazonaws.bedrockagent#UnknownConnectionSourceOutputFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about an unknown source output for a connection.
" + } + }, + "unknownConnectionTarget": { + "target": "com.amazonaws.bedrockagent#UnknownConnectionTargetFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about an unknown target node for a connection.
" + } + }, + "unknownConnectionTargetInput": { + "target": "com.amazonaws.bedrockagent#UnknownConnectionTargetInputFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about an unknown target input for a connection.
" + } + }, + "unknownConnectionCondition": { + "target": "com.amazonaws.bedrockagent#UnknownConnectionConditionFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about an unknown condition for a connection.
" + } + }, + "malformedConditionExpression": { + "target": "com.amazonaws.bedrockagent#MalformedConditionExpressionFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about a malformed condition expression in a node.
" + } + }, + "malformedNodeInputExpression": { + "target": "com.amazonaws.bedrockagent#MalformedNodeInputExpressionFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about a malformed input expression in a node.
" + } + }, + "mismatchedNodeInputType": { + "target": "com.amazonaws.bedrockagent#MismatchedNodeInputTypeFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about mismatched input data types in a node.
" + } + }, + "mismatchedNodeOutputType": { + "target": "com.amazonaws.bedrockagent#MismatchedNodeOutputTypeFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about mismatched output data types in a node.
" + } + }, + "incompatibleConnectionDataType": { + "target": "com.amazonaws.bedrockagent#IncompatibleConnectionDataTypeFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about incompatible data types in a connection.
" + } + }, + "missingConnectionConfiguration": { + "target": "com.amazonaws.bedrockagent#MissingConnectionConfigurationFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about missing configuration for a connection.
" + } + }, + "missingDefaultCondition": { + "target": "com.amazonaws.bedrockagent#MissingDefaultConditionFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about a missing default condition in a conditional node.
" + } + }, + "missingEndingNodes": { + "target": "com.amazonaws.bedrockagent#MissingEndingNodesFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about missing ending nodes in the flow.
" + } + }, + "missingNodeConfiguration": { + "target": "com.amazonaws.bedrockagent#MissingNodeConfigurationFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about missing configuration for a node.
" + } + }, + "missingNodeInput": { + "target": "com.amazonaws.bedrockagent#MissingNodeInputFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about a missing required input in a node.
" + } + }, + "missingNodeOutput": { + "target": "com.amazonaws.bedrockagent#MissingNodeOutputFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about a missing required output in a node.
" + } + }, + "missingStartingNodes": { + "target": "com.amazonaws.bedrockagent#MissingStartingNodesFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about missing starting nodes in the flow.
" + } + }, + "multipleNodeInputConnections": { + "target": "com.amazonaws.bedrockagent#MultipleNodeInputConnectionsFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about multiple connections to a single node input.
" + } + }, + "unfulfilledNodeInput": { + "target": "com.amazonaws.bedrockagent#UnfulfilledNodeInputFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about an unfulfilled node input with no valid connections.
" + } + }, + "unsatisfiedConnectionConditions": { + "target": "com.amazonaws.bedrockagent#UnsatisfiedConnectionConditionsFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about unsatisfied conditions for a connection.
" + } + }, + "unspecified": { + "target": "com.amazonaws.bedrockagent#UnspecifiedFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about an unspecified validation.
" + } + }, + "unknownNodeInput": { + "target": "com.amazonaws.bedrockagent#UnknownNodeInputFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about an unknown input for a node.
" + } + }, + "unknownNodeOutput": { + "target": "com.amazonaws.bedrockagent#UnknownNodeOutputFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about an unknown output for a node.
" + } + }, + "missingLoopInputNode": { + "target": "com.amazonaws.bedrockagent#MissingLoopInputNodeFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about a flow that's missing a required LoopInput node in a DoWhile loop.
Details about a flow that's missing a required LoopController node in a DoWhile loop.
Details about a flow that contains multiple LoopInput nodes in a DoWhile loop.
Details about a flow that contains multiple LoopController nodes in a DoWhile loop.
Details about a flow that includes incompatible node types in a DoWhile loop.
" + } + }, + "invalidLoopBoundary": { + "target": "com.amazonaws.bedrockagent#InvalidLoopBoundaryFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about a flow that includes connections that violate loop boundary rules.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A union type containing various possible validation issues in the flow.
" + } + }, + "com.amazonaws.bedrockagent#FlowValidationSeverity": { + "type": "enum", + "members": { + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warning" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Error" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowValidationType": { + "type": "enum", + "members": { + "CYCLIC_CONNECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CyclicConnection" + } + }, + "DUPLICATE_CONNECTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DuplicateConnections" + } + }, + "DUPLICATE_CONDITION_EXPRESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DuplicateConditionExpression" + } + }, + "UNREACHABLE_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnreachableNode" + } + }, + "UNKNOWN_CONNECTION_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnknownConnectionSource" + } + }, + "UNKNOWN_CONNECTION_SOURCE_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnknownConnectionSourceOutput" + } + }, + "UNKNOWN_CONNECTION_TARGET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnknownConnectionTarget" + } + }, + "UNKNOWN_CONNECTION_TARGET_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnknownConnectionTargetInput" + } + }, + "UNKNOWN_CONNECTION_CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnknownConnectionCondition" + } + }, + "MALFORMED_CONDITION_EXPRESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MalformedConditionExpression" + } + }, + "MALFORMED_NODE_INPUT_EXPRESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MalformedNodeInputExpression" + } + }, + "MISMATCHED_NODE_INPUT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MismatchedNodeInputType" + } + }, + "MISMATCHED_NODE_OUTPUT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MismatchedNodeOutputType" + } + }, + "INCOMPATIBLE_CONNECTION_DATA_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IncompatibleConnectionDataType" + } + }, + "MISSING_CONNECTION_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingConnectionConfiguration" + } + }, + "MISSING_DEFAULT_CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingDefaultCondition" + } + }, + "MISSING_ENDING_NODES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingEndingNodes" + } + }, + "MISSING_NODE_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingNodeConfiguration" + } + }, + "MISSING_NODE_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingNodeInput" + } + }, + "MISSING_NODE_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingNodeOutput" + } + }, + "MISSING_STARTING_NODES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingStartingNodes" + } + }, + "MULTIPLE_NODE_INPUT_CONNECTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MultipleNodeInputConnections" + } + }, + "UNFULFILLED_NODE_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnfulfilledNodeInput" + } + }, + "UNSATISFIED_CONNECTION_CONDITIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnsatisfiedConnectionConditions" + } + }, + "UNSPECIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unspecified" + } + }, + "UNKNOWN_NODE_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnknownNodeInput" + } + }, + "UNKNOWN_NODE_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnknownNodeOutput" + } + }, + "MISSING_LOOP_INPUT_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingLoopInputNode" + } + }, + "MISSING_LOOP_CONTROLLER_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingLoopControllerNode" + } + }, + "MULTIPLE_LOOP_INPUT_NODES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MultipleLoopInputNodes" + } + }, + "MULTIPLE_LOOP_CONTROLLER_NODES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MultipleLoopControllerNodes" + } + }, + "LOOP_INCOMPATIBLE_NODE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoopIncompatibleNodeType" + } + }, + "INVALID_LOOP_BOUNDARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidLoopBoundary" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowValidations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowValidation" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrockagent#FlowVersionResource": { + "type": "resource", + "identifiers": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier" + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion" + } + }, + "create": { + "target": "com.amazonaws.bedrockagent#CreateFlowVersion" + }, + "read": { + "target": "com.amazonaws.bedrockagent#GetFlowVersion" + }, + "delete": { + "target": "com.amazonaws.bedrockagent#DeleteFlowVersion" + }, + "list": { + "target": "com.amazonaws.bedrockagent#ListFlowVersions" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "FlowVersion" + } + } + }, + "com.amazonaws.bedrockagent#FlowVersionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowVersionSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#FlowVersionSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow that the version belongs to.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at the version was created.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a version of a flow.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrockagent#Function": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "A name for the function.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FunctionDescription", + "traits": { + "smithy.api#documentation": "A description of the function and its purpose.
" + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagent#ParameterMap", + "traits": { + "smithy.api#documentation": "The parameters that the agent elicits from the user to fulfill the function.
" + } + }, + "requireConfirmation": { + "target": "com.amazonaws.bedrockagent#RequireConfirmation", + "traits": { + "smithy.api#documentation": "Contains information if user confirmation is required to invoke the function.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
This data type is used in the following API operations:
A list of functions that each define an action in the action group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
This data type is used in the following API operations:
Gets information about an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an action group for an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the action group belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent that the action group belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#documentation": "Contains details about the action group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an alias of an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent to which the alias to get information belongs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentAliasResponse": { + "type": "structure", + "members": { + "agentAlias": { + "target": "com.amazonaws.bedrockagent#AgentAlias", + "traits": { + "smithy.api#documentation": "Contains information about the alias.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentCollaborator": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentCollaboratorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentCollaboratorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about an agent's collaborator.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/agentcollaborators/{collaboratorId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentCollaboratorRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The agent's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The agent's version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "collaboratorId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The collaborator's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentCollaboratorResponse": { + "type": "structure", + "members": { + "agentCollaborator": { + "target": "com.amazonaws.bedrockagent#AgentCollaborator", + "traits": { + "smithy.api#documentation": "Details about the collaborator.
", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a knowledge base associated with an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent with which the knowledge base is associated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent with which the knowledge base is associated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base associated with the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse": { + "type": "structure", + "members": { + "agentKnowledgeBase": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about a knowledge base attached to an agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentResponse": { + "type": "structure", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", + "traits": { + "smithy.api#documentation": "Contains details about the agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets details about a version of an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentVersionRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentVersionResponse": { + "type": "structure", + "members": { + "agentVersion": { + "target": "com.amazonaws.bedrockagent#AgentVersion", + "traits": { + "smithy.api#documentation": "Contains details about the version of the agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a data source.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetDataSourceRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", + "traits": { + "smithy.api#documentation": "Contains details about the data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetFlowAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetFlowAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetFlowAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetFlowAliasRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aliasIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias for which to retrieve information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowAliasResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", + "smithy.api#required": {} + } + }, + "concurrencyConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasConcurrencyConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies how nodes in the flow are executed in parallel.
" + } + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "includedData": { + "target": "com.amazonaws.bedrockagent#IncludedData", + "traits": { + "smithy.api#documentation": "Controls the scope of data returned. Set to METADATA_ONLY to return only resource metadata. Set to ALL_DATA or omit this field to return the full response.
The name of the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. The following statuses are possible:
NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.
Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.
Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.
Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.
The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was last updated.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the flow for which information was retrieved.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "The definition of the nodes and connections between the nodes in the flow.
" + } + }, + "validations": { + "target": "com.amazonaws.bedrockagent#FlowValidations", + "traits": { + "smithy.api#documentation": "A list of validation error messages related to the last failed operation on the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetFlowVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetFlowVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/versions/{flowVersion}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetFlowVersionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "includedData": { + "target": "com.amazonaws.bedrockagent#IncludedData", + "traits": { + "smithy.api#documentation": "Controls the scope of data returned. Set to METADATA_ONLY to return only resource metadata. Set to ALL_DATA or omit this field to return the full response.
The name of the version.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the version of the flow is encrypted with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow for which information was retrieved.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "The definition of the nodes and connections between nodes in the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetIngestionJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for the data ingestion job you want to get information on.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source for the data ingestion job you want to get information on.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data ingestion job you want to get information on.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetIngestionJobResponse": { + "type": "structure", + "members": { + "ingestionJob": { + "target": "com.amazonaws.bedrockagent#IngestionJob", + "traits": { + "smithy.api#documentation": "Contains details about the data ingestion job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a knowledge base.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/knowledgebases/{knowledgeBaseId}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseDocuments": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseDocumentsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseDocumentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/documents/getDocuments" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseDocumentsRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that is connected to the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source that contains the documents.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documentIdentifiers": { + "target": "com.amazonaws.bedrockagent#DocumentIdentifiers", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information to identify a document for which to retrieve information.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseDocumentsResponse": { + "type": "structure", + "members": { + "documentDetails": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocumentDetails", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information about the documents that were retrieved.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base you want to get information on.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetPrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetPromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetPromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about the working draft (DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
The unique identifier of the prompt.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "promptVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.
", + "smithy.api#httpQuery": "promptVersion" + } + }, + "includedData": { + "target": "com.amazonaws.bedrockagent#IncludedData", + "traits": { + "smithy.api#documentation": "Controls the scope of data returned. Set to METADATA_ONLY to return only resource metadata. Set to ALL_DATA or omit this field to return the full response.
The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "The descriptino of the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the resource policy associated with a knowledge base.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/resourcepolicy/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagent#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base to retrieve the resource policy for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#ResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the knowledge base that the resource policy is associated with.
", + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.bedrockagent#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The JSON-formatted resource policy associated with the knowledge base.
", + "smithy.api#required": {} + } + }, + "revisionId": { + "target": "com.amazonaws.bedrockagent#RevisionId", + "traits": { + "smithy.api#documentation": "The revision identifier of the resource policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GraphArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN for Neptune Analytics graph database", + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):neptune-graph:[a-zA-Z0-9-]*:[0-9]{12}:graph/g-[a-zA-Z0-9]{10}$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#GuardrailConfiguration": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockagent#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail.
" + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrockagent#GuardrailVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a guardrail associated with a resource.
" + } + }, + "com.amazonaws.bedrockagent#GuardrailIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" + } + }, + "com.amazonaws.bedrockagent#GuardrailVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([0-9]{1,8})|(DRAFT))$" + } + }, + "com.amazonaws.bedrockagent#HierarchicalChunkingConfiguration": { + "type": "structure", + "members": { + "levelConfigurations": { + "target": "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfigurations", + "traits": { + "smithy.api#documentation": "Token settings for each layer.
", + "smithy.api#required": {} + } + }, + "overlapTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of tokens to repeat across chunks in the same layer.
", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
You configure the number of tokens to overlap, or repeat across adjacent chunks. For example, if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.
" + } + }, + "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens that a chunk can contain in this layer.
", + "smithy.api#range": { + "min": 1, + "max": 8192 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Token settings for a layer in a hierarchical chunking configuration.
" + } + }, + "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagent#HttpsUrl": { + "type": "string", + "traits": { + "smithy.api#pattern": "^https://[A-Za-z0-9][^\\s]*$" + } + }, + "com.amazonaws.bedrockagent#Id": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#ImageExtractionConfiguration": { + "type": "structure", + "members": { + "imageExtractionStatus": { + "target": "com.amazonaws.bedrockagent#EnabledOrDisabledState", + "traits": { + "smithy.api#documentation": "Whether image extraction is enabled or disabled.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for image extraction.
" + } + }, + "com.amazonaws.bedrockagent#IncludeExclude": { + "type": "enum", + "members": { + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + }, + "EXCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUDE" + } + } + } + }, + "com.amazonaws.bedrockagent#IncludedData": { + "type": "enum", + "members": { + "ALL_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_DATA" + } + }, + "METADATA_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METADATA_ONLY" + } + } + } + }, + "com.amazonaws.bedrockagent#IncompatibleConnectionDataTypeFlowValidationDetails": { + "type": "structure", + "members": { + "connection": { + "target": "com.amazonaws.bedrockagent#FlowConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection with incompatible data types.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about incompatible data types in a connection between nodes.
" + } + }, + "com.amazonaws.bedrockagent#IncompatibleLoopNodeType": { + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Input" + } + }, + "CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Condition" + } + }, + "ITERATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Iterator" + } + }, + "COLLECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Collector" + } + } + } + }, + "com.amazonaws.bedrockagent#IndexArn": { + "type": "string", + "traits": { + "aws.api#arnReference": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#IndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#InferenceConfiguration": { + "type": "structure", + "members": { + "temperature": { + "target": "com.amazonaws.bedrockagent#Temperature", + "traits": { + "smithy.api#documentation": "The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagent#TopP", + "traits": { + "smithy.api#documentation": "While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
The maximum number of tokens to allow in the generated response.
" + } + }, + "stopSequences": { + "target": "com.amazonaws.bedrockagent#StopSequences", + "traits": { + "smithy.api#documentation": "A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Ingests documents directly into the knowledge base that is connected to the data source. The dataSourceType specified in the content for each document must match the type of the data source that you specify in the header. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
The unique identifier of the knowledge base to ingest the documents into.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source connected to the knowledge base that you're adding documents to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "documents": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocuments", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information about the documents to add.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#IngestKnowledgeBaseDocumentsResponse": { + "type": "structure", + "members": { + "documentDetails": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocumentDetails", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information about the documents that were ingested.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#IngestionJob": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge for the data ingestion job.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source for the data ingestion job.
", + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data ingestion job.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the data ingestion job.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatus", + "traits": { + "smithy.api#documentation": "The status of the data ingestion job.
", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", + "traits": { + "smithy.api#documentation": "Contains statistics about the data ingestion job.
" + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "A list of reasons that the data ingestion job failed.
" + } + }, + "startedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time the data ingestion job started.
If you stop a data ingestion job, the startedAt time is the time the job was started before the job was stopped.
The time the data ingestion job was last updated.
If you stop a data ingestion job, the updatedAt time is the time the job was stopped.
Contains details about a data ingestion job. Data sources are ingested into a knowledge base so that Large Language Models (LLMs) can use your data.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilter": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterAttribute", + "traits": { + "smithy.api#documentation": "The name of field or attribute to apply the filter.
", + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterOperator", + "traits": { + "smithy.api#documentation": "The operation to apply to the field or attribute.
", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterValues", + "traits": { + "smithy.api#documentation": "A list of values that belong to the field or attribute.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The definition of a filter to filter the data.
" + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterAttribute": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterOperator": { + "type": "enum", + "members": { + "EQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" + } + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#GetIngestionJob" + }, + { + "target": "com.amazonaws.bedrockagent#ListIngestionJobs" + }, + { + "target": "com.amazonaws.bedrockagent#StartIngestionJob" + }, + { + "target": "com.amazonaws.bedrockagent#StopIngestionJob" + } + ] + }, + "com.amazonaws.bedrockagent#IngestionJobSortBy": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.bedrockagent#IngestionJobSortByAttribute", + "traits": { + "smithy.api#documentation": "The name of field or attribute to apply sorting of data.
", + "smithy.api#required": {} + } + }, + "order": { + "target": "com.amazonaws.bedrockagent#SortOrder", + "traits": { + "smithy.api#documentation": "The order for sorting the data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The parameters of sorting the data.
" + } + }, + "com.amazonaws.bedrockagent#IngestionJobSortByAttribute": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + }, + "STARTED_AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED_AT" + } + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobStatistics": { + "type": "structure", + "members": { + "numberOfDocumentsScanned": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
" + } + }, + "numberOfMetadataDocumentsScanned": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
" + } + }, + "numberOfNewDocumentsIndexed": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of new source documents in the data source that were successfully indexed.
" + } + }, + "numberOfModifiedDocumentsIndexed": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of modified source documents in the data source that were successfully indexed.
" + } + }, + "numberOfMetadataDocumentsModified": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of metadata files that were updated or deleted.
" + } + }, + "numberOfDocumentsDeleted": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of source documents that were deleted.
" + } + }, + "numberOfDocumentsFailed": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of source documents that failed to be ingested.
" + } + }, + "numberOfDocumentsSkipped": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of source documents that were skipped during ingestion.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the statistics for the data ingestion job.
" + } + }, + "com.amazonaws.bedrockagent#IngestionJobStatus": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#IngestionJobSummary" + } + }, + "com.amazonaws.bedrockagent#IngestionJobSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for the data ingestion job.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source for the data ingestion job.
", + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data ingestion job.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the data ingestion job.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatus", + "traits": { + "smithy.api#documentation": "The status of the data ingestion job.
", + "smithy.api#required": {} + } + }, + "startedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time the data ingestion job started.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time the data ingestion job was last updated.
", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", + "traits": { + "smithy.api#documentation": "Contains statistics for the data ingestion job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a data ingestion job.
" + } + }, + "com.amazonaws.bedrockagent#InlineCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#InlineCodeFlowNodeConfiguration": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.bedrockagent#InlineCode", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The code that's executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow.
The code must be valid in the programming language that you specify.
The programming language used by your inline code node.
The code must be valid in the programming language that you specify. Currently, only Python 3 (Python_3) is supported.
Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.
" + } + }, + "com.amazonaws.bedrockagent#InlineContent": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#InlineContentType", + "traits": { + "smithy.api#documentation": "The type of inline content to define.
", + "smithy.api#required": {} + } + }, + "byteContent": { + "target": "com.amazonaws.bedrockagent#ByteContentDoc", + "traits": { + "smithy.api#documentation": "Contains information about content defined inline in bytes.
" + } + }, + "textContent": { + "target": "com.amazonaws.bedrockagent#TextContentDoc", + "traits": { + "smithy.api#documentation": "Contains information about content defined inline in text.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about content defined inline to ingest into a data source. Choose a type and include the field that corresponds to it.
Contains configurations for the input flow node for a flow. This node takes the input from flow invocation and passes it to the next node in the data type that you specify.
" + } + }, + "com.amazonaws.bedrockagent#Instruction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 40, + "max": 4000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#IntermediateStorage": { + "type": "structure", + "members": { + "s3Location": { + "target": "com.amazonaws.bedrockagent#S3Location", + "traits": { + "smithy.api#documentation": "An S3 bucket path.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline.
" + } + }, + "com.amazonaws.bedrockagent#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "An internal server error occurred. Retry your request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockagent#InvalidLoopBoundaryFlowValidationDetails": { + "type": "structure", + "members": { + "connection": { + "target": "com.amazonaws.bedrockagent#FlowConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection that violates loop boundary rules.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The source node of the connection that violates DoWhile loop boundary rules.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The target node of the connection that violates DoWhile loop boundary rules.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a flow that contains connections that violate loop boundary rules.
" + } + }, + "com.amazonaws.bedrockagent#IteratorFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" + } + }, + "com.amazonaws.bedrockagent#KendraIndexArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kendra:[a-z0-9-]{1,20}:([0-9]{12}|):index/([a-zA-Z0-9][a-zA-Z0-9-]{35}|[a-zA-Z0-9][a-zA-Z0-9-]{35}-[a-zA-Z0-9][a-zA-Z0-9-]{35})$" + } + }, + "com.amazonaws.bedrockagent#KendraKnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "kendraIndexArn": { + "target": "com.amazonaws.bedrockagent#KendraIndexArn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Kendra index.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for an Amazon Kendra knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBase": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the knowledge base.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the embeddings configuration of the knowledge base.
", + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "The status of the knowledge base. The following statuses are possible:
CREATING – The knowledge base is being created.
ACTIVE – The knowledge base is ready to be queried.
DELETING – The knowledge base is being deleted.
UPDATING – The knowledge base is being updated.
FAILED – The knowledge base API operation failed.
The time the knowledge base was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time the knowledge base was last updated.
", + "smithy.api#required": {} + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "A list of reasons that the API operation on the knowledge base failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseType", + "traits": { + "smithy.api#documentation": "The type of data that the data source is converted into for the knowledge base. Choose MANAGED to create a managed knowledge base.
Contains details about the model that's used to convert the data source into vector embeddings.
" + } + }, + "managedKnowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#ManagedKnowledgeBaseConfiguration" + }, + "kendraKnowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KendraKnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Settings for an Amazon Kendra knowledge base.
" + } + }, + "sqlKnowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#SqlKnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for a knowledge base connected to an SQL database.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the vector embeddings configuration of the knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseDocument": { + "type": "structure", + "members": { + "metadata": { + "target": "com.amazonaws.bedrockagent#DocumentMetadata", + "traits": { + "smithy.api#documentation": "Contains the metadata to associate with the document.
" + } + }, + "content": { + "target": "com.amazonaws.bedrockagent#DocumentContent", + "traits": { + "smithy.api#documentation": "Contains the content of the document.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a document to ingest into a knowledge base and metadata to associate with it.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseDocumentDetail": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base that the document was ingested into or deleted from.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DocumentStatus", + "traits": { + "smithy.api#documentation": "The ingestion status of the document. The following statuses are possible:
STARTING – You submitted the ingestion job containing the document.
PENDING – The document is waiting to be ingested.
IN_PROGRESS – The document is being ingested.
INDEXED – The document was successfully indexed.
PARTIALLY_INDEXED – The document was partially indexed.
METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.
METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.
FAILED – The document failed to be ingested.
NOT_FOUND – The document wasn't found.
IGNORED – The document was ignored during ingestion.
DELETING – You submitted the delete job containing the document.
DELETE_IN_PROGRESS – The document is being deleted.
Contains information that identifies the document.
", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for the status. Appears alongside the status IGNORED.
The date and time at which the document was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the details for a document that was ingested or deleted.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseDocumentDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocumentDetail" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseDocumentResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseDocuments" + }, + { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseDocuments" + }, + { + "target": "com.amazonaws.bedrockagent#IngestKnowledgeBaseDocuments" + }, + { + "target": "com.amazonaws.bedrockagent#ListKnowledgeBaseDocuments" + } + ] + }, + "com.amazonaws.bedrockagent#KnowledgeBaseDocuments": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocument" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseFlowNodeConfiguration": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#FlowKnowledgeBaseId", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The unique identifier of the knowledge base to query.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseModelIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
" + } + }, + "numberOfResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of results to retrieve from the knowledge base.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "promptTemplate": { + "target": "com.amazonaws.bedrockagent#KnowledgeBasePromptTemplate", + "traits": { + "smithy.api#documentation": "A custom prompt template to use with the knowledge base for generating responses.
" + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt.
" + } + }, + "rerankingConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorSearchRerankingConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for reranking the retrieved results from the knowledge base to improve relevance.
" + } + }, + "orchestrationConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseOrchestrationConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for orchestrating the retrieval and generation process in the knowledge base node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseOrchestrationConfiguration": { + "type": "structure", + "members": { + "promptTemplate": { + "target": "com.amazonaws.bedrockagent#KnowledgeBasePromptTemplate", + "traits": { + "smithy.api#documentation": "A custom prompt template for orchestrating the retrieval and generation process.
" + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt.
" + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagent#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.
" + } + }, + "performanceConfig": { + "target": "com.amazonaws.bedrockagent#PerformanceConfiguration", + "traits": { + "smithy.api#documentation": "The performance configuration options for the knowledge base retrieval and generation process.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBasePromptTemplate": { + "type": "structure", + "members": { + "textPromptTemplate": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseTextPrompt", + "traits": { + "smithy.api#documentation": "The text of the prompt template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a custom prompt template for orchestrating the retrieval and generation process.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBases" + }, + { + "target": "com.amazonaws.bedrockagent#ListKnowledgeBases" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBase" + } + ] + }, + "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" + } + }, + "UPDATE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_UNSUCCESSFUL" + } + } + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseStorageType": { + "type": "enum", + "members": { + "OPENSEARCH_SERVERLESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSEARCH_SERVERLESS" + } + }, + "PINECONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PINECONE" + } + }, + "REDIS_ENTERPRISE_CLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDIS_ENTERPRISE_CLOUD" + } + }, + "RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS" + } + }, + "MONGO_DB_ATLAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONGO_DB_ATLAS" + } + }, + "NEPTUNE_ANALYTICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEPTUNE_ANALYTICS" + } + }, + "OPENSEARCH_MANAGED_CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSEARCH_MANAGED_CLUSTER" + } + }, + "S3_VECTORS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_VECTORS" + } + } + }, + "traits": { + "smithy.api#documentation": "The storage type of a knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummary" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the knowledge base.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "The status of the knowledge base.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time the knowledge base was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseTextPrompt": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseType": { + "type": "enum", + "members": { + "VECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VECTOR" + } + }, + "KENDRA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KENDRA" + } + }, + "SQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL" + } + }, + "MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of a knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.bedrockagent#LambdaFunctionFlowNodeConfiguration": { + "type": "structure", + "members": { + "lambdaArn": { + "target": "com.amazonaws.bedrockagent#FlowLambdaArn", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function to invoke.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#LexFlowNodeConfiguration": { + "type": "structure", + "members": { + "botAliasArn": { + "target": "com.amazonaws.bedrockagent#FlowLexBotAliasArn", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.
", + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.bedrockagent#FlowLexBotLocaleId", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The Region to invoke the Amazon Lex bot in.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#ListAgentActionGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the action groups for an agent and information about each one.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "actionGroupSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about an action group.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the aliases of an agent and information about each one.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentaliases/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentAliasSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentAliasesRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about an alias of the agent.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Retrieve a list of an agent's collaborators.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/agentcollaborators/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentCollaboratorSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentCollaboratorsRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The agent's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The agent's version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of agent collaborators to return in one page of results.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentCollaboratorsResponse": { + "type": "structure", + "members": { + "agentCollaboratorSummaries": { + "target": "com.amazonaws.bedrockagent#AgentCollaboratorSummaries", + "traits": { + "smithy.api#documentation": "A list of collaborator summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentKnowledgeBases": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists knowledge bases associated with an agent and information about each one.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentKnowledgeBaseSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent for which to return information about knowledge bases associated with it.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent for which to return information about knowledge bases associated with it.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a knowledge base associated with the agent.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the versions of an agent and information about each version.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentVersionSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentVersionsRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a version of the agent.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the agents belonging to an account and information about each agent.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about an agent.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the data sources in a knowledge base and information about each one.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "dataSourceSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListDataSourcesRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for which to return a list of information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a data source.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns a list of aliases for a flow.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/aliases" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flowAliasSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListFlowAliasesRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow for which aliases are being returned.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about an alias.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/versions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flowVersionSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListFlowVersionsRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about a flow.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flowSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListFlowsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about a flow.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the data ingestion jobs for a data source. The list also includes information about each job.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "ingestionJobSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListIngestionJobsRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for the list of data ingestion jobs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source for the list of data ingestion jobs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilters", + "traits": { + "smithy.api#documentation": "Contains information about the filters for filtering the data.
" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrockagent#IngestionJobSortBy", + "traits": { + "smithy.api#documentation": "Contains details about how to sort the data.
" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of data ingestion jobs with information about each job.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/documents" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "documentDetails" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListKnowledgeBaseDocumentsRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that is connected to the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source that contains the documents.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about the documents that were retrieved.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "knowledgeBaseSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListKnowledgeBasesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of knowledge bases with information about each knowledge base.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns either information about the working draft (DRAFT version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the promptIdentifier field or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.
", + "smithy.api#httpQuery": "promptIdentifier" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about a prompt using Prompt management.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
List all the tags for the resource you specify.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagent#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which to list tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "The key-value pairs for the tags associated with the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#LoopControllerFlowNodeConfiguration": { + "type": "structure", + "members": { + "continueCondition": { + "target": "com.amazonaws.bedrockagent#FlowCondition", + "traits": { + "smithy.api#documentation": "Specifies the condition that determines when the flow exits the DoWhile loop. The loop executes until this condition evaluates to true.
", + "smithy.api#required": {} + } + }, + "maxIterations": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "Specifies the maximum number of times the DoWhile loop can iterate before the flow exits the loop.
", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the controller node of a DoWhile loop in the flow.
" + } + }, + "com.amazonaws.bedrockagent#LoopFlowNodeConfiguration": { + "type": "structure", + "members": { + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "The definition of the DoWhile loop nodes and connections between nodes in the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the nodes of a DoWhile loop in your flow.
A DoWhile loop is made up of the following nodes:
Loop - The container node that holds the loop's flow definition. This node encompasses the entire loop structure.
LoopInput - The entry point node for the loop. This node receives inputs from nodes outside the loop and from previous loop iterations.
Body nodes - The processing nodes that execute within each loop iteration. These can be nodes for handling data in your flow, such as a prompt or Lambda function nodes. Some node types aren't supported inside a DoWhile loop body. For more information, see LoopIncompatibleNodeTypeFlowValidationDetails.
LoopController - The node that evaluates whether the loop should continue or exit based on a condition.
These nodes work together to create a loop that runs at least once and continues until a specified condition is met or a maximum number of iterations is reached.
" + } + }, + "com.amazonaws.bedrockagent#LoopIncompatibleNodeTypeFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The Loop container node that contains an incompatible node.
The node type of the incompatible node in the DoWhile loop. Some node types, like a condition node, aren't allowed in a DoWhile loop.
", + "smithy.api#required": {} + } + }, + "incompatibleNodeName": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The node that's incompatible in the DoWhile loop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a flow that contains an incompatible node in a DoWhile loop.
" + } + }, + "com.amazonaws.bedrockagent#LoopInputFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Contains configurations for the input node of a DoWhile loop in the flow.
" + } + }, + "com.amazonaws.bedrockagent#MalformedConditionExpressionFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the node containing the malformed condition expression.
", + "smithy.api#required": {} + } + }, + "condition": { + "target": "com.amazonaws.bedrockagent#FlowConditionName", + "traits": { + "smithy.api#documentation": "The name of the malformed condition.
", + "smithy.api#required": {} + } + }, + "cause": { + "target": "com.amazonaws.bedrockagent#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error message describing why the condition expression is malformed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a malformed condition expression in a node.
" + } + }, + "com.amazonaws.bedrockagent#MalformedNodeInputExpressionFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the node containing the malformed input expression.
", + "smithy.api#required": {} + } + }, + "input": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "The name of the input with the malformed expression.
", + "smithy.api#required": {} + } + }, + "cause": { + "target": "com.amazonaws.bedrockagent#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error message describing why the input expression is malformed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a malformed input expression in a node.
" + } + }, + "com.amazonaws.bedrockagent#ManagedKnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "embeddingModelType": { + "target": "com.amazonaws.bedrockagent#EmbeddingModelType" + }, + "embeddingModelArn": { + "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn", + "traits": { + "smithy.api#documentation": "The ARN for the embeddings model.
" + } + }, + "embeddingModelConfiguration": { + "target": "com.amazonaws.bedrockagent#EmbeddingModelConfiguration" + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Configurations for a managed knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#ManagedKnowledgeBaseConnectorConfiguration": { + "type": "structure", + "members": { + "deletionProtectionConfiguration": { + "target": "com.amazonaws.bedrockagent#DeletionProtectionConfiguration", + "traits": { + "smithy.api#documentation": "A safeguard against accidental bulk deletion of indexed content.
" + } + }, + "mediaExtractionConfiguration": { + "target": "com.amazonaws.bedrockagent#MediaExtractionConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for extracting media (images, audio, video) from data source files.
" + } + }, + "connectorParameters": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Connector-specific parameters. For more information, see Connect a data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for managed knowledge base connector data sources.
" + } + }, + "com.amazonaws.bedrockagent#MaxRecentSessions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagent#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagent#MaximumLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.bedrockagent#MediaExtractionConfiguration": { + "type": "structure", + "members": { + "imageExtractionConfiguration": { + "target": "com.amazonaws.bedrockagent#ImageExtractionConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for image extraction.
" + } + }, + "audioExtractionConfiguration": { + "target": "com.amazonaws.bedrockagent#AudioExtractionConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for audio extraction.
" + } + }, + "videoExtractionConfiguration": { + "target": "com.amazonaws.bedrockagent#VideoExtractionConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for video extraction.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for media extraction settings.
" + } + }, + "com.amazonaws.bedrockagent#MemoryConfiguration": { + "type": "structure", + "members": { + "enabledMemoryTypes": { + "target": "com.amazonaws.bedrockagent#EnabledMemoryTypes", + "traits": { + "smithy.api#documentation": "The type of memory that is stored.
", + "smithy.api#required": {} + } + }, + "storageDays": { + "target": "com.amazonaws.bedrockagent#StorageDays", + "traits": { + "smithy.api#default": 30, + "smithy.api#documentation": "The number of days the agent is configured to retain the conversational context.
" + } + }, + "sessionSummaryConfiguration": { + "target": "com.amazonaws.bedrockagent#SessionSummaryConfiguration", + "traits": { + "smithy.api#documentation": "Contains the configuration for SESSION_SUMMARY memory type enabled for the agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the memory configuration.
" + } + }, + "com.amazonaws.bedrockagent#MemoryType": { + "type": "enum", + "members": { + "SESSION_SUMMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SESSION_SUMMARY" + } + } + } + }, + "com.amazonaws.bedrockagent#Message": { + "type": "structure", + "members": { + "role": { + "target": "com.amazonaws.bedrockagent#ConversationRole", + "traits": { + "smithy.api#documentation": "The role that the message belongs to.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagent#ContentBlocks", + "traits": { + "smithy.api#documentation": "The content in the message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A message input or response from a model. For more information, see Create a prompt using Prompt management.
" + } + }, + "com.amazonaws.bedrockagent#Messages": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#Message" + } + }, + "com.amazonaws.bedrockagent#MetadataAttribute": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrockagent#Key", + "traits": { + "smithy.api#documentation": "The key of the metadata attribute.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrockagent#MetadataAttributeValue", + "traits": { + "smithy.api#documentation": "Contains the value of the metadata attribute.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a metadata attribute.
" + } + }, + "com.amazonaws.bedrockagent#MetadataAttributeValue": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#MetadataValueType", + "traits": { + "smithy.api#documentation": "The type of the metadata attribute.
", + "smithy.api#required": {} + } + }, + "numberValue": { + "target": "com.amazonaws.bedrockagent#NumberValue", + "traits": { + "smithy.api#documentation": "The value of the numeric metadata attribute.
" + } + }, + "booleanValue": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "The value of the Boolean metadata attribute.
" + } + }, + "stringValue": { + "target": "com.amazonaws.bedrockagent#StringValue", + "traits": { + "smithy.api#documentation": "The value of the string metadata attribute.
" + } + }, + "stringListValue": { + "target": "com.amazonaws.bedrockagent#StringListValue", + "traits": { + "smithy.api#documentation": "An array of strings that define the value of the metadata attribute.
", + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the value of the metadata attribute. Choose a type and include the field that corresponds to it.
The mode for selecting metadata fields for reranking.
", + "smithy.api#required": {} + } + }, + "selectiveModeConfiguration": { + "target": "com.amazonaws.bedrockagent#RerankingMetadataSelectiveModeConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for selective metadata field inclusion or exclusion during reranking.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies how metadata fields should be handled during the reranking process.
" + } + }, + "com.amazonaws.bedrockagent#MetadataSourceType": { + "type": "enum", + "members": { + "IN_LINE_ATTRIBUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_LINE_ATTRIBUTE" + } + }, + "S3_LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_LOCATION" + } + } + } + }, + "com.amazonaws.bedrockagent#MetadataValueType": { + "type": "enum", + "members": { + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "STRING_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING_LIST" + } + } + } + }, + "com.amazonaws.bedrockagent#Microsoft365TenantId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.bedrockagent#MismatchedNodeInputTypeFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the node containing the input with the mismatched data type.
", + "smithy.api#required": {} + } + }, + "input": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "The name of the input with the mismatched data type.
", + "smithy.api#required": {} + } + }, + "expectedType": { + "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "The expected data type for the node input.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about mismatched input data types in a node.
" + } + }, + "com.amazonaws.bedrockagent#MismatchedNodeOutputTypeFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the node containing the output with the mismatched data type.
", + "smithy.api#required": {} + } + }, + "output": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "The name of the output with the mismatched data type.
", + "smithy.api#required": {} + } + }, + "expectedType": { + "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "The expected data type for the node output.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about mismatched output data types in a node.
" + } + }, + "com.amazonaws.bedrockagent#MissingConnectionConfigurationFlowValidationDetails": { + "type": "structure", + "members": { + "connection": { + "target": "com.amazonaws.bedrockagent#FlowConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection missing configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a connection missing required configuration.
" + } + }, + "com.amazonaws.bedrockagent#MissingDefaultConditionFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the node missing the default condition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a missing default condition in a conditional node.
" + } + }, + "com.amazonaws.bedrockagent#MissingEndingNodesFlowValidationDetails": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Details about missing ending nodes (such as FlowOutputNode) in the flow.
" + } + }, + "com.amazonaws.bedrockagent#MissingLoopControllerNodeFlowValidationDetails": { + "type": "structure", + "members": { + "loopNode": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The DoWhile loop in a flow that's missing a required LoopController node.
Details about a flow that's missing a required LoopController node in a DoWhile loop.
The DoWhile loop in a flow that's missing a required LoopInput node.
Details about a flow that's missing a required LoopInput node in a DoWhile loop.
The name of the node missing a required configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a node missing a required configuration.
" + } + }, + "com.amazonaws.bedrockagent#MissingNodeInputFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the node missing the required input.
", + "smithy.api#required": {} + } + }, + "input": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "The name of the missing input.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a missing required input in a node.
" + } + }, + "com.amazonaws.bedrockagent#MissingNodeOutputFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the node missing the required output.
", + "smithy.api#required": {} + } + }, + "output": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "The name of the missing output.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a missing required output in a node.
" + } + }, + "com.amazonaws.bedrockagent#MissingStartingNodesFlowValidationDetails": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Details about missing starting nodes (such as FlowInputNode) in the flow.
" + } + }, + "com.amazonaws.bedrockagent#ModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasCollectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasDatabaseName", + "traits": { + "smithy.api#documentation": "The database name in your MongoDB Atlas cluster for your knowledge base.
", + "smithy.api#required": {} + } + }, + "collectionName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasCollectionName", + "traits": { + "smithy.api#documentation": "The collection name of the knowledge base in MongoDB Atlas.
", + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasIndexName", + "traits": { + "smithy.api#documentation": "The name of the MongoDB Atlas vector search index.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + }, + "endpointServiceName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasEndpointServiceName", + "traits": { + "smithy.api#documentation": "The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
" + } + }, + "textIndexName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasIndexName", + "traits": { + "smithy.api#documentation": "The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasEndpointServiceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MultipleLoopControllerNodesFlowValidationDetails": { + "type": "structure", + "members": { + "loopNode": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The DoWhile loop in a flow that contains multiple LoopController nodes.
Details about a flow that contains multiple LoopController nodes in a DoWhile loop.
The DoWhile loop in a flow that contains multiple LoopInput nodes.
Details about a flow that contains multiple LoopInput nodes in a DoWhile loop.
The name of the node containing the input with multiple connections.
", + "smithy.api#required": {} + } + }, + "input": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "The name of the input with multiple connections to it.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about multiple connections to a single node input.
" + } + }, + "com.amazonaws.bedrockagent#Name": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#NaturalLanguageString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagent#NeptuneAnalyticsConfiguration": { + "type": "structure", + "members": { + "graphArn": { + "target": "com.amazonaws.bedrockagent#GraphArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Neptune Analytics vector store.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#NeptuneAnalyticsFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon Neptune Analytics. For more information, see Create a vector index in Amazon Neptune Analytics.
" + } + }, + "com.amazonaws.bedrockagent#NeptuneAnalyticsFieldMapping": { + "type": "structure", + "members": { + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockagent#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.bedrockagent#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagent#NumberValue": { + "type": "double", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#NumericalVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{1,5}$" + } + }, + "com.amazonaws.bedrockagent#OpenSearchManagedClusterConfiguration": { + "type": "structure", + "members": { + "domainEndpoint": { + "target": "com.amazonaws.bedrockagent#OpenSearchManagedClusterDomainEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL the OpenSearch domain.
", + "smithy.api#required": {} + } + }, + "domainArn": { + "target": "com.amazonaws.bedrockagent#OpenSearchManagedClusterDomainArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OpenSearch domain.
", + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#OpenSearchManagedClusterIndexName", + "traits": { + "smithy.api#documentation": "The name of the vector store.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#OpenSearchManagedClusterFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the Managed Cluster configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in OpenSearch Managed Cluster.
" + } + }, + "com.amazonaws.bedrockagent#OpenSearchManagedClusterDomainArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov|-iso):es:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:domain/[a-z][a-z0-9-]{3,28}$" + } + }, + "com.amazonaws.bedrockagent#OpenSearchManagedClusterDomainEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^https://.*$" + } + }, + "com.amazonaws.bedrockagent#OpenSearchManagedClusterFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#OpenSearchManagedClusterIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(?![\\-_+.])[a-z0-9][a-z0-9\\-_\\.]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration": { + "type": "structure", + "members": { + "collectionArn": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
", + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName", + "traits": { + "smithy.api#documentation": "The name of the vector store.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.
" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#OrchestrationExecutor": { + "type": "union", + "members": { + "lambda": { + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the Lambda function containing the orchestration logic carried out upon invoking the custom orchestration.
" + } + }, + "com.amazonaws.bedrockagent#OrchestrationType": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "CUSTOM_ORCHESTRATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_ORCHESTRATION" + } + } + } + }, + "com.amazonaws.bedrockagent#OutputFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Contains configurations for an output flow node in the flow. You specify the data type expected for the input into the node in the type field and how to return the final output in the expression field.
A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#Type", + "traits": { + "smithy.api#documentation": "The data type of the parameter.
", + "smithy.api#required": {} + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the parameter is required for the agent to complete the function for action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a parameter in a function for an action group.
This data type is used in the following API operations:
The parsing strategy for the data source. Only SMART_PARSING can be selected for managed knowledge bases. For more information, see Customize ingestion for managed knowledge bases.
If you specify BEDROCK_FOUNDATION_MODEL as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents.
If you specify BEDROCK_DATA_AUTOMATION as the parsing strategy for ingesting your data source, use this object to modify configurations for using the Amazon Bedrock Data Automation parser.
Settings for parsing document contents. If you exclude this field, the default parser converts the contents of each document into text before splitting it into chunks. Specify the parsing strategy to use in the parsingStrategy field and include the relevant configuration, or omit it to use the Amazon Bedrock default parser. For more information, see Parsing options for your data source.
If you specify BEDROCK_DATA_AUTOMATION or BEDROCK_FOUNDATION_MODEL and it fails to parse a file, the Amazon Bedrock default parser will be used instead.
Instructions for interpreting the contents of a document.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Instructions for interpreting the contents of a document.
" + } + }, + "com.amazonaws.bedrockagent#ParsingPromptText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.bedrockagent#ParsingStrategy": { + "type": "enum", + "members": { + "BEDROCK_FOUNDATION_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_FOUNDATION_MODEL" + } + }, + "BEDROCK_DATA_AUTOMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_DATA_AUTOMATION" + } + }, + "SMART_PARSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMART_PARSING" + } + } + } + }, + "com.amazonaws.bedrockagent#PatternObjectFilter": { + "type": "structure", + "members": { + "objectType": { + "target": "com.amazonaws.bedrockagent#FilteredObjectType", + "traits": { + "smithy.api#documentation": "The supported object type or content type of the data source.
", + "smithy.api#required": {} + } + }, + "inclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", + "traits": { + "smithy.api#documentation": "A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.
" + } + }, + "exclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", + "traits": { + "smithy.api#documentation": "A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specific filters applied to your data source content. You can filter out or include certain content.
" + } + }, + "com.amazonaws.bedrockagent#PatternObjectFilterConfiguration": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrockagent#PatternObjectFilterList", + "traits": { + "smithy.api#documentation": "The configuration of specific filters applied to your data source content. You can filter out or include certain content.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of filtering certain objects or content types of the data source.
" + } + }, + "com.amazonaws.bedrockagent#PatternObjectFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PatternObjectFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#Payload": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PerformanceConfigLatency": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optimized" + } + } + } + }, + "com.amazonaws.bedrockagent#PerformanceConfiguration": { + "type": "structure", + "members": { + "latency": { + "target": "com.amazonaws.bedrockagent#PerformanceConfigLatency", + "traits": { + "smithy.api#default": "standard", + "smithy.api#documentation": "The latency optimization setting.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The performance-related configuration options for the knowledge base retrieval and generation process.
" + } + }, + "com.amazonaws.bedrockagent#PineconeConfiguration": { + "type": "structure", + "members": { + "connectionString": { + "target": "com.amazonaws.bedrockagent#PineconeConnectionString", + "traits": { + "smithy.api#documentation": "The endpoint URL for your index management page.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
", + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.bedrockagent#PineconeNamespace", + "traits": { + "smithy.api#documentation": "The namespace to be used to write new data to your database.
" + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#PineconeFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
" + } + }, + "com.amazonaws.bedrockagent#PineconeConnectionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#PineconeFieldMapping": { + "type": "structure", + "members": { + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#PineconeNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#PrepareAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#PrepareAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#PrepareAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a DRAFT version of the agent that can be used for internal testing.
The unique identifier of the agent for which to create a DRAFT version.
The unique identifier of the agent for which the DRAFT version was created.
The status of the DRAFT version and whether it is ready for use.
The version of the agent.
", + "smithy.api#required": {} + } + }, + "preparedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the DRAFT version of the agent was last prepared.
Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#PrepareFlowResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared. If preparation succeeds, the status becomes Prepared. If it fails, the status becomes FAILED.
The ARN of the agent with which to use the prompt.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains specifications for an Amazon Bedrock agent with which to use the prompt. For more information, see Create a prompt using Prompt management and Automate tasks in your application using conversational agents.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)$" + } + }, + "com.amazonaws.bedrockagent#PromptConfiguration": { + "type": "structure", + "members": { + "promptType": { + "target": "com.amazonaws.bedrockagent#PromptType", + "traits": { + "smithy.api#documentation": "The step in the agent sequence that this prompt configuration applies to.
" + } + }, + "promptCreationMode": { + "target": "com.amazonaws.bedrockagent#CreationMode", + "traits": { + "smithy.api#documentation": "Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
PRE_PROCESSING – DISABLED
ORCHESTRATION – ENABLED
KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
POST_PROCESSING – DISABLED
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
" + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#InferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
The agent's foundation model.
" + } + }, + "additionalModelRequestFields": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "If the Converse or ConverseStream operations support the model, additionalModelRequestFields contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration field.
For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "com.amazonaws.bedrockagent#PromptConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptConfiguration" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#PromptDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#PromptFlowNodeConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeSourceConfiguration", + "traits": { + "smithy.api#documentation": "Specifies whether the prompt is from Prompt management or defined inline.
", + "smithy.api#required": {} + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a guardrail to apply to the prompt in this node and the response generated from it.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#PromptFlowNodeInlineConfiguration": { + "type": "structure", + "members": { + "templateType": { + "target": "com.amazonaws.bedrockagent#PromptTemplateType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "TEXT", + "smithy.api#documentation": "The type of prompt template.
", + "smithy.api#required": {} + } + }, + "templateConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "Contains a prompt and variables in the prompt that can be replaced with values at runtime.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrockagent#FlowPromptModelIdentifier", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The unique identifier of the model or inference profile to run inference with.
", + "smithy.api#required": {} + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt.
" + } + }, + "additionalModelRequestFields": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Additional fields to be included in the model request for the Prompt node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt defined inline in the node.
" + } + }, + "com.amazonaws.bedrockagent#PromptFlowNodeResourceConfiguration": { + "type": "structure", + "members": { + "promptArn": { + "target": "com.amazonaws.bedrockagent#FlowPromptArn", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt from Prompt management.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt from Prompt management to use in a node.
" + } + }, + "com.amazonaws.bedrockagent#PromptFlowNodeSourceConfiguration": { + "type": "union", + "members": { + "resource": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeResourceConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt from Prompt management.
" + } + }, + "inline": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeInlineConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt that is defined inline
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt and whether it is from Prompt management or defined inline.
" + } + }, + "com.amazonaws.bedrockagent#PromptGenAiResource": { + "type": "union", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#PromptAgentResource", + "traits": { + "smithy.api#documentation": "Specifies an Amazon Bedrock agent with which to use the prompt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains specifications for a generative AI resource with which to use the prompt. For more information, see Create a prompt using Prompt management.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#PromptIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z]{10})|(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})(?::[0-9]{1,5})?$" + } + }, + "com.amazonaws.bedrockagent#PromptInferenceConfiguration": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagent#PromptModelInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for a text prompt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt.
" + } + }, + "com.amazonaws.bedrockagent#PromptInputVariable": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptInputVariableName", + "traits": { + "smithy.api#documentation": "The name of the variable.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a variable in the prompt.
" + } + }, + "com.amazonaws.bedrockagent#PromptInputVariableName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#PromptInputVariablesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptInputVariable" + }, + "traits": { + "smithy.api#length": { + "max": 20 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptMetadataEntry": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrockagent#PromptMetadataKey", + "traits": { + "smithy.api#documentation": "The key of a metadata tag for a prompt variant.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrockagent#PromptMetadataValue", + "traits": { + "smithy.api#documentation": "The value of a metadata tag for a prompt variant.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptMetadataKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptMetadataEntry" + }, + "traits": { + "smithy.api#length": { + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptMetadataValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" + } + }, + "com.amazonaws.bedrockagent#PromptModelInferenceConfiguration": { + "type": "structure", + "members": { + "temperature": { + "target": "com.amazonaws.bedrockagent#Temperature", + "traits": { + "smithy.api#documentation": "Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagent#TopP", + "traits": { + "smithy.api#documentation": "The percentage of most-likely candidates that the model considers for the next token.
" + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrockagent#MaximumLength", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to return in the response.
" + } + }, + "stopSequences": { + "target": "com.amazonaws.bedrockagent#StopSequences", + "traits": { + "smithy.api#documentation": "A list of strings that define sequences after which the model will stop generating.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters.
" + } + }, + "com.amazonaws.bedrockagent#PromptName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#PromptOverrideConfiguration": { + "type": "structure", + "members": { + "promptConfigurations": { + "target": "com.amazonaws.bedrockagent#PromptConfigurations", + "traits": { + "smithy.api#documentation": "Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
", + "smithy.api#required": {} + } + }, + "overrideLambda": { + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptResource": { + "type": "resource", + "identifiers": { + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrockagent#CreatePrompt" + }, + "read": { + "target": "com.amazonaws.bedrockagent#GetPrompt" + }, + "update": { + "target": "com.amazonaws.bedrockagent#UpdatePrompt" + }, + "delete": { + "target": "com.amazonaws.bedrockagent#DeletePrompt" + }, + "list": { + "target": "com.amazonaws.bedrockagent#ListPrompts" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreatePromptVersion" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Prompt" + } + } + }, + "com.amazonaws.bedrockagent#PromptState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagent#PromptSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#PromptSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "The description of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt that this summary applies to.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a prompt in your Prompt management tool.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrockagent#PromptTemplateConfiguration": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagent#TextPromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the text in a message for a prompt.
" + } + }, + "chat": { + "target": "com.amazonaws.bedrockagent#ChatPromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to use the prompt in a conversational format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the message for a prompt. For more information, see Construct and store reusable prompts with Prompt management in Amazon Bedrock.
" + } + }, + "com.amazonaws.bedrockagent#PromptTemplateType": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + }, + "CHAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHAT" + } + } + } + }, + "com.amazonaws.bedrockagent#PromptType": { + "type": "enum", + "members": { + "PRE_PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRE_PROCESSING" + } + }, + "ORCHESTRATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORCHESTRATION" + } + }, + "POST_PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST_PROCESSING" + } + }, + "KNOWLEDGE_BASE_RESPONSE_GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE_RESPONSE_GENERATION" + } + }, + "MEMORY_SUMMARIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEMORY_SUMMARIZATION" + } + } + } + }, + "com.amazonaws.bedrockagent#PromptVariant": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the prompt variant.
", + "smithy.api#required": {} + } + }, + "templateType": { + "target": "com.amazonaws.bedrockagent#PromptTemplateType", + "traits": { + "smithy.api#documentation": "The type of prompt template to use.
", + "smithy.api#required": {} + } + }, + "templateConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the prompt template.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrockagent#PromptModelIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the model or inference profile with which to run inference on the prompt.
" + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt variant.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagent#PromptMetadataList", + "traits": { + "smithy.api#documentation": "An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
" + } + }, + "additionalModelRequestFields": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Contains model-specific inference configurations that aren't in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models.
Specifies a generative AI resource with which to use the prompt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a variant of the prompt.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptVariantList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptVariant" + }, + "traits": { + "smithy.api#length": { + "max": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptVariantName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#ProvisionedModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?){1,63})|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" + } + }, + "com.amazonaws.bedrockagent#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a resource policy with a knowledge base. A resource policy allows other AWS accounts to access the knowledge base. For more information, see Cross-account access for knowledge bases.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/resourcepolicy/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagent#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base to attach the resource policy to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.bedrockagent#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The JSON-formatted resource policy to associate with the knowledge base.
", + "smithy.api#required": {} + } + }, + "expectedRevisionId": { + "target": "com.amazonaws.bedrockagent#RevisionId", + "traits": { + "smithy.api#documentation": "The expected revision identifier of the resource policy. Use this to prevent conflicts when multiple users update the same policy concurrently. Specify the revisionId from the most recent GetResourcePolicy or PutResourcePolicy response.
The ARN of the knowledge base that the resource policy was attached to.
", + "smithy.api#required": {} + } + }, + "revisionId": { + "target": "com.amazonaws.bedrockagent#RevisionId", + "traits": { + "smithy.api#documentation": "The revision identifier of the resource policy. Use this value in the expectedRevisionId field of a subsequent PutResourcePolicy or DeleteResourcePolicy request.
The name of the column for which the other fields in this object apply.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#DescriptionString", + "traits": { + "smithy.api#documentation": "A description of the column that helps the query engine understand the contents of the column.
" + } + }, + "inclusion": { + "target": "com.amazonaws.bedrockagent#IncludeExclude", + "traits": { + "smithy.api#documentation": "Specifies whether to include or exclude the column during query generation. If you specify EXCLUDE, the column will be ignored. If you specify INCLUDE, all other columns in the table will be ignored.
Contains information about a column in the current table for the query engine to consider.
" + } + }, + "com.amazonaws.bedrockagent#QueryGenerationColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + } + } + }, + "com.amazonaws.bedrockagent#QueryGenerationColumns": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#QueryGenerationColumn" + } + }, + "com.amazonaws.bedrockagent#QueryGenerationConfiguration": { + "type": "structure", + "members": { + "executionTimeoutSeconds": { + "target": "com.amazonaws.bedrockagent#QueryExecutionTimeoutSeconds", + "traits": { + "smithy.api#documentation": "The time after which query generation will time out.
" + } + }, + "generationContext": { + "target": "com.amazonaws.bedrockagent#QueryGenerationContext", + "traits": { + "smithy.api#documentation": "Specifies configurations for context to use during query generation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for query generation. For more information, see Build a knowledge base by connecting to a structured data source in the Amazon Bedrock User Guide..
" + } + }, + "com.amazonaws.bedrockagent#QueryGenerationContext": { + "type": "structure", + "members": { + "tables": { + "target": "com.amazonaws.bedrockagent#QueryGenerationTables", + "traits": { + "smithy.api#documentation": "An array of objects, each of which defines information about a table in the database.
" + } + }, + "curatedQueries": { + "target": "com.amazonaws.bedrockagent#CuratedQueries", + "traits": { + "smithy.api#documentation": "An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
" + } + } + }, + "traits": { + "smithy.api#documentation": ">Contains configurations for context to use during query generation.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#QueryGenerationTable": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#QueryGenerationTableName", + "traits": { + "smithy.api#documentation": "The name of the table for which the other fields in this object apply.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#DescriptionString", + "traits": { + "smithy.api#documentation": "A description of the table that helps the query engine understand the contents of the table.
" + } + }, + "inclusion": { + "target": "com.amazonaws.bedrockagent#IncludeExclude", + "traits": { + "smithy.api#documentation": "Specifies whether to include or exclude the table during query generation. If you specify EXCLUDE, the table will be ignored. If you specify INCLUDE, all other tables will be ignored.
An array of objects, each of which defines information about a column in the table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a table for the query engine to consider.
" + } + }, + "com.amazonaws.bedrockagent#QueryGenerationTableName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^.*\\..*\\..*$" + } + }, + "com.amazonaws.bedrockagent#QueryGenerationTables": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#QueryGenerationTable" + }, + "traits": { + "smithy.api#length": { + "max": 50 + } + } + }, + "com.amazonaws.bedrockagent#RdsArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$" + } + }, + "com.amazonaws.bedrockagent#RdsConfiguration": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#RdsArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vector store.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.bedrockagent#RdsDatabaseName", + "traits": { + "smithy.api#documentation": "The name of your Amazon RDS database.
", + "smithy.api#required": {} + } + }, + "tableName": { + "target": "com.amazonaws.bedrockagent#RdsTableName", + "traits": { + "smithy.api#documentation": "The name of the table in the database.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#RdsFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
" + } + }, + "com.amazonaws.bedrockagent#RdsDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" + } + }, + "com.amazonaws.bedrockagent#RdsFieldMapping": { + "type": "structure", + "members": { + "primaryKeyField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the ID for each entry.
", + "smithy.api#required": {} + } + }, + "vectorField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + }, + "customMetadataField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#RdsTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\.\\-]+$" + } + }, + "com.amazonaws.bedrockagent#RecommendedAction": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#RecommendedActions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#RecommendedAction" + }, + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL of the Redis Enterprise Cloud database.
", + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName", + "traits": { + "smithy.api#documentation": "The name of the vector index.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.
" + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#RedshiftClusterIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.bedrockagent#RedshiftConfiguration": { + "type": "structure", + "members": { + "storageConfigurations": { + "target": "com.amazonaws.bedrockagent#RedshiftQueryEngineStorageConfigurations", + "traits": { + "smithy.api#documentation": "Specifies configurations for Amazon Redshift database storage.
", + "smithy.api#required": {} + } + }, + "queryEngineConfiguration": { + "target": "com.amazonaws.bedrockagent#RedshiftQueryEngineConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for an Amazon Redshift query engine.
", + "smithy.api#required": {} + } + }, + "queryGenerationConfiguration": { + "target": "com.amazonaws.bedrockagent#QueryGenerationConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for generating queries.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for an Amazon Redshift database. For more information, see Build a knowledge base by connecting to a structured data source in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#RedshiftDatabase": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#RedshiftProvisionedAuthConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#RedshiftProvisionedAuthType", + "traits": { + "smithy.api#documentation": "The type of authentication to use.
", + "smithy.api#required": {} + } + }, + "databaseUser": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The database username for authentication to an Amazon Redshift provisioned data warehouse.
" + } + }, + "usernamePasswordSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The ARN of an Secrets Manager secret for authentication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for authentication to an Amazon Redshift provisioned data warehouse. Specify the type of authentication to use in the type field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.
The ID of the Amazon Redshift cluster.
", + "smithy.api#required": {} + } + }, + "authConfiguration": { + "target": "com.amazonaws.bedrockagent#RedshiftProvisionedAuthConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for authentication to Amazon Redshift.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a provisioned Amazon Redshift query engine.
" + } + }, + "com.amazonaws.bedrockagent#RedshiftQueryEngineAwsDataCatalogStorageConfiguration": { + "type": "structure", + "members": { + "tableNames": { + "target": "com.amazonaws.bedrockagent#AwsDataCatalogTableNames", + "traits": { + "smithy.api#documentation": "A list of names of the tables to use.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for storage in Glue Data Catalog.
" + } + }, + "com.amazonaws.bedrockagent#RedshiftQueryEngineConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#RedshiftQueryEngineType", + "traits": { + "smithy.api#documentation": "The type of query engine.
", + "smithy.api#required": {} + } + }, + "serverlessConfiguration": { + "target": "com.amazonaws.bedrockagent#RedshiftServerlessConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for a serverless Amazon Redshift query engine.
" + } + }, + "provisionedConfiguration": { + "target": "com.amazonaws.bedrockagent#RedshiftProvisionedConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for a provisioned Amazon Redshift query engine.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for an Amazon Redshift query engine. Specify the type of query engine in type and include the corresponding field. For more information, see Build a knowledge base by connecting to a structured data source in the Amazon Bedrock User Guide.
The name of the Amazon Redshift database.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for storage in Amazon Redshift.
" + } + }, + "com.amazonaws.bedrockagent#RedshiftQueryEngineStorageConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#RedshiftQueryEngineStorageType", + "traits": { + "smithy.api#documentation": "The data storage service to use.
", + "smithy.api#required": {} + } + }, + "awsDataCatalogConfiguration": { + "target": "com.amazonaws.bedrockagent#RedshiftQueryEngineAwsDataCatalogStorageConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for storage in Glue Data Catalog.
" + } + }, + "redshiftConfiguration": { + "target": "com.amazonaws.bedrockagent#RedshiftQueryEngineRedshiftStorageConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for storage in Amazon Redshift.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for Amazon Redshift data storage. Specify the data storage service to use in the type field and include the corresponding field. For more information, see Build a knowledge base by connecting to a structured data source in the Amazon Bedrock User Guide.
The type of authentication to use.
", + "smithy.api#required": {} + } + }, + "usernamePasswordSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The ARN of an Secrets Manager secret for authentication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies configurations for authentication to a Redshift Serverless. Specify the type of authentication to use in the type field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.
The ARN of the Amazon Redshift workgroup.
", + "smithy.api#required": {} + } + }, + "authConfiguration": { + "target": "com.amazonaws.bedrockagent#RedshiftServerlessAuthConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for authentication to Amazon Redshift Serverless.
" + } + }, + "com.amazonaws.bedrockagent#RelayConversationHistory": { + "type": "enum", + "members": { + "TO_COLLABORATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO_COLLABORATOR" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagent#RequireConfirmation": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "Whether the action requires user confirmation.
" + } + }, + "com.amazonaws.bedrockagent#RerankingMetadataSelectionMode": { + "type": "enum", + "members": { + "SELECTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECTIVE" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.bedrockagent#RerankingMetadataSelectiveModeConfiguration": { + "type": "union", + "members": { + "fieldsToInclude": { + "target": "com.amazonaws.bedrockagent#FieldsForReranking", + "traits": { + "smithy.api#documentation": "Specifies the metadata fields to include in the reranking process.
" + } + }, + "fieldsToExclude": { + "target": "com.amazonaws.bedrockagent#FieldsForReranking", + "traits": { + "smithy.api#documentation": "Specifies the metadata fields to exclude from the reranking process.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures the metadata fields to include or exclude during the reranking process when using selective mode.
" + } + }, + "com.amazonaws.bedrockagent#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrockagent#ResourcePolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20480 + }, + "smithy.api#mediaType": "application/json", + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.bedrockagent#RetrievalFlowNodeConfiguration": { + "type": "structure", + "members": { + "serviceConfiguration": { + "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeServiceConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the service to use for retrieving data to return as the output from the node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.
" + } + }, + "com.amazonaws.bedrockagent#RetrievalFlowNodeS3Configuration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.bedrockagent#FlowS3BucketName", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The name of the Amazon S3 bucket from which to retrieve data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
" + } + }, + "com.amazonaws.bedrockagent#RetrievalFlowNodeServiceConfiguration": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeS3Configuration", + "traits": { + "smithy.api#documentation": "Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the service to use for retrieving data to return as the output from the node.
" + } + }, + "com.amazonaws.bedrockagent#RevisionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.bedrockagent#S3BucketArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.bedrockagent#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.bedrockagent#S3BucketUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^s3://.{1,128}$" + } + }, + "com.amazonaws.bedrockagent#S3Content": { + "type": "structure", + "members": { + "s3Location": { + "target": "com.amazonaws.bedrockagent#S3Location", + "traits": { + "smithy.api#documentation": "The S3 location of the file containing the content to ingest.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source.
" + } + }, + "com.amazonaws.bedrockagent#S3DataSourceConfiguration": { + "type": "structure", + "members": { + "bucketArn": { + "target": "com.amazonaws.bedrockagent#S3BucketArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 bucket that contains your data.
", + "smithy.api#required": {} + } + }, + "inclusionPrefixes": { + "target": "com.amazonaws.bedrockagent#S3Prefixes", + "traits": { + "smithy.api#documentation": "A list of S3 prefixes to include certain files or content. For more information, see Organizing objects using prefixes.
" + } + }, + "bucketOwnerAccountId": { + "target": "com.amazonaws.bedrockagent#BucketOwnerAccountId", + "traits": { + "smithy.api#documentation": "The account ID for the owner of the S3 bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information to connect to Amazon S3 as your data source for self-managed knowledge bases. To configure this data source for managed knowledge bases, use managedKnowledgeBaseConnectorConfiguration.
" + } + }, + "com.amazonaws.bedrockagent#S3Identifier": { + "type": "structure", + "members": { + "s3BucketName": { + "target": "com.amazonaws.bedrockagent#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket.
" + } + }, + "s3ObjectKey": { + "target": "com.amazonaws.bedrockagent#S3ObjectKey", + "traits": { + "smithy.api#documentation": "The S3 object key for the S3 resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The identifier information for an Amazon S3 bucket.
" + } + }, + "com.amazonaws.bedrockagent#S3Location": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagent#S3BucketUri", + "traits": { + "smithy.api#documentation": "The location's URI. For example, s3://my-bucket/chunk-processor/.
An Amazon S3 location.
" + } + }, + "com.amazonaws.bedrockagent#S3ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" + } + }, + "com.amazonaws.bedrockagent#S3ObjectUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$" + } + }, + "com.amazonaws.bedrockagent#S3Prefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#S3Prefixes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#S3Prefix" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#S3VectorsConfiguration": { + "type": "structure", + "members": { + "vectorBucketArn": { + "target": "com.amazonaws.bedrockagent#VectorBucketArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored. This bucket contains the vector data used by the knowledge base.
" + } + }, + "indexArn": { + "target": "com.amazonaws.bedrockagent#IndexArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vector index used for the knowledge base. This ARN identifies the specific vector index resource within Amazon Bedrock.
" + } + }, + "indexName": { + "target": "com.amazonaws.bedrockagent#IndexName", + "traits": { + "smithy.api#documentation": "The name of the vector index used for the knowledge base. This name identifies the vector index within the Amazon Bedrock service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base for S3 vectors.
" + } + }, + "com.amazonaws.bedrockagent#SalesforceAuthType": { + "type": "enum", + "members": { + "OAUTH2_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" + } + } + } + }, + "com.amazonaws.bedrockagent#SalesforceCrawlerConfiguration": { + "type": "structure", + "members": { + "filterConfiguration": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.
" + } + }, + "com.amazonaws.bedrockagent#SalesforceDataSourceConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#SalesforceSourceConfiguration", + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your Salesforce data source.
", + "smithy.api#required": {} + } + }, + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#SalesforceCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information to connect to Salesforce as your data source.
" + } + }, + "com.amazonaws.bedrockagent#SalesforceSourceConfiguration": { + "type": "structure", + "members": { + "hostUrl": { + "target": "com.amazonaws.bedrockagent#HttpsUrl", + "traits": { + "smithy.api#documentation": "The Salesforce host URL or instance URL.
", + "smithy.api#required": {} + } + }, + "authType": { + "target": "com.amazonaws.bedrockagent#SalesforceAuthType", + "traits": { + "smithy.api#documentation": "The supported authentication type to authenticate and connect to your Salesforce instance.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Salesforce connection configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your Salesforce data source.
" + } + }, + "com.amazonaws.bedrockagent#SecretArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$" + } + }, + "com.amazonaws.bedrockagent#SeedUrl": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.bedrockagent#Url", + "traits": { + "smithy.api#documentation": "A seed or starting point URL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The seed or starting point URL. You should be authorized to crawl the URL.
" + } + }, + "com.amazonaws.bedrockagent#SeedUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#SeedUrl" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagent#SemanticChunkingConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens that a chunk can contain.
", + "smithy.api#range": { + "min": 1, + "max": 8192 + }, + "smithy.api#required": {} + } + }, + "bufferSize": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The buffer size.
", + "smithy.api#range": { + "min": 0, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "breakpointPercentileThreshold": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The dissimilarity threshold for splitting chunks.
", + "smithy.api#range": { + "min": 50, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.
With semantic chunking, each sentence is compared to the next to determine how similar they are. You specify a threshold in the form of a percentile, where adjacent sentences that are less similar than that percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to 90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences, 100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These chunks are further split if they exceed the max token size.
You must also specify a buffer size, which determines whether sentences are compared in isolation, or within a moving context window that includes the previous and following sentence. For example, if you set the buffer size to 1, the embedding for sentence 10 is derived from sentences 9, 10, and 11 combined.
The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configuration for server-side encryption for your managed knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.bedrockagent#SessionSummaryConfiguration": { + "type": "structure", + "members": { + "maxRecentSessions": { + "target": "com.amazonaws.bedrockagent#MaxRecentSessions", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Maximum number of recent session summaries to include in the agent's prompt context.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for SESSION_SUMMARY memory type enabled for the agent.
" + } + }, + "com.amazonaws.bedrockagent#SessionTTL": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 5400 + } + } + }, + "com.amazonaws.bedrockagent#SharePointAuthType": { + "type": "enum", + "members": { + "OAUTH2_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" + } + }, + "OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS" + } + } + } + }, + "com.amazonaws.bedrockagent#SharePointCrawlerConfiguration": { + "type": "structure", + "members": { + "filterConfiguration": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of filtering the SharePoint content. For example, configuring regular expression patterns to include or exclude certain content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.
" + } + }, + "com.amazonaws.bedrockagent#SharePointDataSourceConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#SharePointSourceConfiguration", + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your SharePoint data source.
", + "smithy.api#required": {} + } + }, + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#SharePointCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information to connect to SharePoint as your data source for self-managed knowledge bases.
" + } + }, + "com.amazonaws.bedrockagent#SharePointDomain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.bedrockagent#SharePointHostType": { + "type": "enum", + "members": { + "ONLINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONLINE" + } + } + } + }, + "com.amazonaws.bedrockagent#SharePointSiteUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#HttpsUrl" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagent#SharePointSourceConfiguration": { + "type": "structure", + "members": { + "tenantId": { + "target": "com.amazonaws.bedrockagent#Microsoft365TenantId", + "traits": { + "smithy.api#documentation": "The identifier of your Microsoft 365 tenant.
" + } + }, + "domain": { + "target": "com.amazonaws.bedrockagent#SharePointDomain", + "traits": { + "smithy.api#documentation": "The domain of your SharePoint instance or site URL/URLs.
", + "smithy.api#required": {} + } + }, + "siteUrls": { + "target": "com.amazonaws.bedrockagent#SharePointSiteUrls", + "traits": { + "smithy.api#documentation": "A list of one or more SharePoint site URLs.
", + "smithy.api#required": {} + } + }, + "hostType": { + "target": "com.amazonaws.bedrockagent#SharePointHostType", + "traits": { + "smithy.api#documentation": "The supported host type, whether online/cloud or server/on-premises.
", + "smithy.api#required": {} + } + }, + "authType": { + "target": "com.amazonaws.bedrockagent#SharePointAuthType", + "traits": { + "smithy.api#documentation": "The supported authentication type to authenticate and connect to your SharePoint site/sites.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your SharePoint data source.
" + } + }, + "com.amazonaws.bedrockagent#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + } + }, + "com.amazonaws.bedrockagent#SpecificToolChoice": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#ToolName", + "traits": { + "smithy.api#documentation": "The name of the tool.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. For more information, see Use a tool to complete an Amazon Bedrock model response.
" + } + }, + "com.amazonaws.bedrockagent#SqlKnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#QueryEngineType", + "traits": { + "smithy.api#documentation": "The type of SQL database to connect to the knowledge base.
", + "smithy.api#required": {} + } + }, + "redshiftConfiguration": { + "target": "com.amazonaws.bedrockagent#RedshiftConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configurations for a knowledge base connected to an Amazon Redshift database.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a knowledge base connected to an SQL database. Specify the SQL database type in the type field and include the corresponding field. For more information, see Build a knowledge base by connecting to a structured data source in the Amazon Bedrock User Guide.
Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#StartIngestionJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for the data ingestion job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source you want to ingest into your knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the data ingestion job.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#StartIngestionJobResponse": { + "type": "structure", + "members": { + "ingestionJob": { + "target": "com.amazonaws.bedrockagent#IngestionJob", + "traits": { + "smithy.api#documentation": "Contains information about the data ingestion job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#StepType": { + "type": "enum", + "members": { + "POST_CHUNKING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST_CHUNKING" + } + } + } + }, + "com.amazonaws.bedrockagent#StopIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#StopIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#StopIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a currently running data ingestion job. You can send a StartIngestionJob request again to ingest the rest of your data when you are ready.
The unique identifier of the knowledge base for the data ingestion job you want to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source for the data ingestion job you want to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data ingestion job you want to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#StopIngestionJobResponse": { + "type": "structure", + "members": { + "ingestionJob": { + "target": "com.amazonaws.bedrockagent#IngestionJob", + "traits": { + "smithy.api#documentation": "Contains information about the stopped data ingestion job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#StopSequences": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.bedrockagent#StorageConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStorageType", + "traits": { + "smithy.api#documentation": "The vector store service in which the knowledge base is stored.
", + "smithy.api#required": {} + } + }, + "opensearchServerlessConfiguration": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
" + } + }, + "opensearchManagedClusterConfiguration": { + "target": "com.amazonaws.bedrockagent#OpenSearchManagedClusterConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. For more information, see Create a vector index in Amazon OpenSearch Service.
" + } + }, + "pineconeConfiguration": { + "target": "com.amazonaws.bedrockagent#PineconeConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Pinecone.
" + } + }, + "redisEnterpriseCloudConfiguration": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
" + } + }, + "rdsConfiguration": { + "target": "com.amazonaws.bedrockagent#RdsConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
" + } + }, + "mongoDbAtlasConfiguration": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in MongoDB Atlas.
" + } + }, + "neptuneAnalyticsConfiguration": { + "target": "com.amazonaws.bedrockagent#NeptuneAnalyticsConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information, see Create a vector index in Amazon Neptune Analytics..
" + } + }, + "s3VectorsConfiguration": { + "target": "com.amazonaws.bedrockagent#S3VectorsConfiguration", + "traits": { + "smithy.api#documentation": "The configuration settings for storing knowledge base data using S3 vectors. This includes vector index information and S3 bucket details for vector storage.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#StorageDays": { + "type": "integer", + "traits": { + "smithy.api#default": 30, + "smithy.api#range": { + "min": 0, + "max": 365 + } + } + }, + "com.amazonaws.bedrockagent#StorageFlowNodeConfiguration": { + "type": "structure", + "members": { + "serviceConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageFlowNodeServiceConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the service to use for storing the input into the node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.
" + } + }, + "com.amazonaws.bedrockagent#StorageFlowNodeS3Configuration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.bedrockagent#FlowS3BucketName", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The name of the Amazon S3 bucket in which to store the input into the node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the Amazon S3 location in which to store the input into the node.
" + } + }, + "com.amazonaws.bedrockagent#StorageFlowNodeServiceConfiguration": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagent#StorageFlowNodeS3Configuration", + "traits": { + "smithy.api#documentation": "Contains configurations for the Amazon S3 location in which to store the input into the node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the service to use for storing the input into the node.
" + } + }, + "com.amazonaws.bedrockagent#StringListValue": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#StringValue" + } + }, + "com.amazonaws.bedrockagent#StringValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#SupplementalDataStorageConfiguration": { + "type": "structure", + "members": { + "storageLocations": { + "target": "com.amazonaws.bedrockagent#SupplementalDataStorageLocations", + "traits": { + "smithy.api#documentation": "A list of objects specifying storage locations for multimedia content (images, audio, and video) extracted from multimodal documents in your data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies configurations for the storage location of multimedia content (images, audio, and video) extracted from multimodal documents in your data source. This content can be retrieved and returned to the end user with timestamp references for audio and video segments.
" + } + }, + "com.amazonaws.bedrockagent#SupplementalDataStorageLocation": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#SupplementalDataStorageLocationType", + "traits": { + "smithy.api#documentation": "Specifies the storage service used for this location.
", + "smithy.api#required": {} + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagent#S3Location", + "traits": { + "smithy.api#documentation": "Contains information about the Amazon S3 location for the extracted multimedia content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a storage location for multimedia content (images, audio, and video) extracted from multimodal documents in your data source.
" + } + }, + "com.amazonaws.bedrockagent#SupplementalDataStorageLocationType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + } + } + }, + "com.amazonaws.bedrockagent#SupplementalDataStorageLocations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#SupplementalDataStorageLocation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#SupportedLanguages": { + "type": "enum", + "members": { + "PYTHON_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Python_3" + } + } + } + }, + "com.amazonaws.bedrockagent#SystemContentBlock": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagent#NonEmptyString", + "traits": { + "smithy.api#documentation": "The text in the system prompt.
" + } + }, + "cachePoint": { + "target": "com.amazonaws.bedrockagent#CachePointBlock", + "traits": { + "smithy.api#documentation": "Creates a cache checkpoint within a tool designation
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a system prompt to provide context to the model or to describe how it should behave. For more information, see Create a prompt using Prompt management.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#SystemContentBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#SystemContentBlock" + } + }, + "com.amazonaws.bedrockagent#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagent#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.bedrockagent#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "An object containing key-value pairs that define the tags to attach to the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagent#TaggableResourcesArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base|flow|prompt)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:flow/([A-Z0-9]{10})/alias/([A-Z0-9]{10})$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:prompt/([A-Z0-9]{10})?(?::/d+)?$)" + } + }, + "com.amazonaws.bedrockagent#TaggingResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#ListTagsForResource" + }, + { + "target": "com.amazonaws.bedrockagent#TagResource" + }, + { + "target": "com.amazonaws.bedrockagent#UntagResource" + } + ] + }, + "com.amazonaws.bedrockagent#TagsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagent#TagKey" + }, + "value": { + "target": "com.amazonaws.bedrockagent#TagValue" + } + }, + "com.amazonaws.bedrockagent#Temperature": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#TextContentDoc": { + "type": "structure", + "members": { + "data": { + "target": "com.amazonaws.bedrockagent#Data", + "traits": { + "smithy.api#documentation": "The text of the content.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about content defined inline in text.
" + } + }, + "com.amazonaws.bedrockagent#TextPrompt": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#TextPromptTemplateConfiguration": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockagent#TextPrompt", + "traits": { + "smithy.api#documentation": "The message for the prompt.
", + "smithy.api#required": {} + } + }, + "cachePoint": { + "target": "com.amazonaws.bedrockagent#CachePointBlock", + "traits": { + "smithy.api#documentation": "A cache checkpoint within a template configuration.
" + } + }, + "inputVariables": { + "target": "com.amazonaws.bedrockagent#PromptInputVariablesList", + "traits": { + "smithy.api#documentation": "An array of the variables in the prompt template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in {{variable}}.
The number of requests exceeds the limit. Resubmit your request later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bedrockagent#Tool": { + "type": "union", + "members": { + "toolSpec": { + "target": "com.amazonaws.bedrockagent#ToolSpecification", + "traits": { + "smithy.api#documentation": "The specification for the tool.
" + } + }, + "cachePoint": { + "target": "com.amazonaws.bedrockagent#CachePointBlock", + "traits": { + "smithy.api#documentation": "Creates a cache checkpoint within a tool designation
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a tool that a model can use when generating a response. For more information, see Use a tool to complete an Amazon Bedrock model response.
" + } + }, + "com.amazonaws.bedrockagent#ToolChoice": { + "type": "union", + "members": { + "auto": { + "target": "com.amazonaws.bedrockagent#AutoToolChoice", + "traits": { + "smithy.api#documentation": "Defines tools. The model automatically decides whether to call a tool or to generate text instead.
" + } + }, + "any": { + "target": "com.amazonaws.bedrockagent#AnyToolChoice", + "traits": { + "smithy.api#documentation": "Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response.
" + } + }, + "tool": { + "target": "com.amazonaws.bedrockagent#SpecificToolChoice", + "traits": { + "smithy.api#documentation": "Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines which tools the model should request when invoked. For more information, see Use a tool to complete an Amazon Bedrock model response.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#ToolConfiguration": { + "type": "structure", + "members": { + "tools": { + "target": "com.amazonaws.bedrockagent#Tools", + "traits": { + "smithy.api#documentation": "An array of tools to pass to a model.
", + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "toolChoice": { + "target": "com.amazonaws.bedrockagent#ToolChoice", + "traits": { + "smithy.api#documentation": "Defines which tools the model should request when invoked.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information for the tools that the model can use when generating a response. For more information, see Use a tool to complete an Amazon Bedrock model response.
" + } + }, + "com.amazonaws.bedrockagent#ToolInputSchema": { + "type": "union", + "members": { + "json": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "A JSON object defining the input schema for the tool.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input schema for the tool. For more information, see Use a tool to complete an Amazon Bedrock model response.
" + } + }, + "com.amazonaws.bedrockagent#ToolName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]*$" + } + }, + "com.amazonaws.bedrockagent#ToolSpecification": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#ToolName", + "traits": { + "smithy.api#documentation": "The name of the tool.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#NonEmptyString", + "traits": { + "smithy.api#documentation": "The description of the tool.
" + } + }, + "inputSchema": { + "target": "com.amazonaws.bedrockagent#ToolInputSchema", + "traits": { + "smithy.api#documentation": "The input schema for the tool.
", + "smithy.api#required": {} + } + }, + "strict": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to enforce strict JSON schema adherence for the tool input" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a specification for a tool. For more information, see Use a tool to complete an Amazon Bedrock model response.
" + } + }, + "com.amazonaws.bedrockagent#Tools": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#Tool" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#TopK": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagent#TopP": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#Transformation": { + "type": "structure", + "members": { + "transformationFunction": { + "target": "com.amazonaws.bedrockagent#TransformationFunction", + "traits": { + "smithy.api#documentation": "A Lambda function that processes documents.
", + "smithy.api#required": {} + } + }, + "stepToApply": { + "target": "com.amazonaws.bedrockagent#StepType", + "traits": { + "smithy.api#documentation": "When the service applies the transformation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A custom processing step for documents moving through a data source ingestion pipeline. To process documents after they have been converted into chunks, set the step to apply to POST_CHUNKING.
The Lambda function.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A Lambda function that processes documents.
" + } + }, + "com.amazonaws.bedrockagent#TransformationLambdaConfiguration": { + "type": "structure", + "members": { + "lambdaArn": { + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "The function's ARN identifier.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A Lambda function that processes documents.
" + } + }, + "com.amazonaws.bedrockagent#Transformations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#Transformation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#Type": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "string" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "number" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "integer" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "boolean" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "array" + } + } + } + }, + "com.amazonaws.bedrockagent#UnfulfilledNodeInputFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the node containing the unfulfilled input.
", + "smithy.api#required": {} + } + }, + "input": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "The name of the unfulfilled input. An input is unfulfilled if there are no data connections to it.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an unfulfilled node input with no valid connections.
" + } + }, + "com.amazonaws.bedrockagent#UnknownConnectionConditionFlowValidationDetails": { + "type": "structure", + "members": { + "connection": { + "target": "com.amazonaws.bedrockagent#FlowConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection with the unknown condition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an unknown condition for a connection.
" + } + }, + "com.amazonaws.bedrockagent#UnknownConnectionSourceFlowValidationDetails": { + "type": "structure", + "members": { + "connection": { + "target": "com.amazonaws.bedrockagent#FlowConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection with the unknown source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an unknown source node for a connection.
" + } + }, + "com.amazonaws.bedrockagent#UnknownConnectionSourceOutputFlowValidationDetails": { + "type": "structure", + "members": { + "connection": { + "target": "com.amazonaws.bedrockagent#FlowConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection with the unknown source output.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an unknown source output for a connection.
" + } + }, + "com.amazonaws.bedrockagent#UnknownConnectionTargetFlowValidationDetails": { + "type": "structure", + "members": { + "connection": { + "target": "com.amazonaws.bedrockagent#FlowConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection with the unknown target.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an unknown target node for a connection.
" + } + }, + "com.amazonaws.bedrockagent#UnknownConnectionTargetInputFlowValidationDetails": { + "type": "structure", + "members": { + "connection": { + "target": "com.amazonaws.bedrockagent#FlowConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection with the unknown target input.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an unknown target input for a connection.
" + } + }, + "com.amazonaws.bedrockagent#UnknownNodeInputFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the unknown input.
", + "smithy.api#required": {} + } + }, + "input": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "The name of the node with the unknown input.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an unknown input for a node.
" + } + }, + "com.amazonaws.bedrockagent#UnknownNodeOutputFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the node with the unknown output.
", + "smithy.api#required": {} + } + }, + "output": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "The name of the unknown output.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an unknown output for a node.
" + } + }, + "com.amazonaws.bedrockagent#UnreachableNodeFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the unreachable node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an unreachable node in the flow. A node is unreachable when there are no paths to it from any starting node.
" + } + }, + "com.amazonaws.bedrockagent#UnsatisfiedConnectionConditionsFlowValidationDetails": { + "type": "structure", + "members": { + "connection": { + "target": "com.amazonaws.bedrockagent#FlowConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection with unsatisfied conditions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about unsatisfied conditions for a connection. A condition is unsatisfied if it can never be true, for example two branches of condition node cannot be simultaneously true.
" + } + }, + "com.amazonaws.bedrockagent#UnspecifiedFlowValidationDetails": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Details about an unspecified validation that doesn't fit other categories.
" + } + }, + "com.amazonaws.bedrockagent#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Remove tags from a resource.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagent#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to remove tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.bedrockagent#TagKeyList", + "traits": { + "smithy.api#documentation": "A list of keys of the tags to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration of an agent.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/{agentId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration for an action group for an agent.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent for which to update the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent version for which to update the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the action group.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new name for the action group.
" + } + }, + "parentActionGroupSignature": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "Update the built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.
ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" + } + }, + "parentActionGroupSignatureParams": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignatureParams", + "traits": { + "smithy.api#documentation": "The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" + } + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema", + "traits": { + "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" + } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#documentation": "Contains details about the action group that was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates configurations for an alias of an agent.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description for the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" + } + }, + "aliasInvocationState": { + "target": "com.amazonaws.bedrockagent#AliasInvocationState", + "traits": { + "smithy.api#documentation": "The invocation state for the agent alias. To pause the agent alias, set the value to REJECT_INVOCATIONS. To start the agent alias running again, set the value to ACCEPT_INVOCATIONS. Use the GetAgentAlias, or ListAgentAliases, operation to get the invocation state of an agent alias.
Contains details about the alias that was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentCollaborator": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentCollaboratorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentCollaboratorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an agent's collaborator.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/agentcollaborators/{collaboratorId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentCollaboratorRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The agent's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The agent's version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "collaboratorId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The collaborator's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentDescriptor": { + "target": "com.amazonaws.bedrockagent#AgentDescriptor", + "traits": { + "smithy.api#documentation": "An agent descriptor for the agent collaborator.
", + "smithy.api#required": {} + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The collaborator's name.
", + "smithy.api#required": {} + } + }, + "collaborationInstruction": { + "target": "com.amazonaws.bedrockagent#CollaborationInstruction", + "traits": { + "smithy.api#documentation": "Instruction for the collaborator.
", + "smithy.api#required": {} + } + }, + "relayConversationHistory": { + "target": "com.amazonaws.bedrockagent#RelayConversationHistory", + "traits": { + "smithy.api#documentation": "A relay conversation history for the collaborator.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentCollaboratorResponse": { + "type": "structure", + "members": { + "agentCollaborator": { + "target": "com.amazonaws.bedrockagent#AgentCollaborator", + "traits": { + "smithy.api#documentation": "Details about the collaborator.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration for a knowledge base that has been associated with an agent.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent associated with the knowledge base that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent associated with the knowledge base that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that has been associated with an agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description for the knowledge base associated with an agent.
" + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse": { + "type": "structure", + "members": { + "agentKnowledgeBase": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base that has been associated with an agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the agent.
", + "smithy.api#required": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "Specifies new instructions that tell the agent what it should do and how it should interact with users.
" + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The identifier for the model that you want to be used for orchestration by the agent you create.
The modelId to provide depends on the type of model or throughput that you use:
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.
If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.
Specifies a new description of the agent.
" + } + }, + "orchestrationType": { + "target": "com.amazonaws.bedrockagent#OrchestrationType", + "traits": { + "smithy.api#documentation": " Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
Contains details of the custom orchestration configured for the agent.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The unique Guardrail configuration assigned to the agent when it is updated.
" + } + }, + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the new memory configuration for the agent.
" + } + }, + "agentCollaboration": { + "target": "com.amazonaws.bedrockagent#AgentCollaboration", + "traits": { + "smithy.api#documentation": "The agent's collaboration role.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentResponse": { + "type": "structure", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", + "traits": { + "smithy.api#documentation": "Contains details about the agent that was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configurations for a data source connector.
You can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.
The unique identifier of the knowledge base for the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the data source.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description for the data source.
" + } + }, + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The connection configuration for the data source that you want to update.
", + "smithy.api#required": {} + } + }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "The data deletion policy for the data source that you want to update.
" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about server-side encryption of the data source.
" + } + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", + "traits": { + "smithy.api#documentation": "Contains details about the data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/flows/{flowIdentifier}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateFlowAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateFlowAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateFlowAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateFlowAliasRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description for the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version to which to map the alias.
", + "smithy.api#required": {} + } + }, + "concurrencyConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasConcurrencyConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies how nodes in the flow are executed in parallel.
" + } + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aliasIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateFlowAliasResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", + "smithy.api#required": {} + } + }, + "concurrencyConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasConcurrencyConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies how nodes in the flow are executed in parallel.
" + } + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateFlowRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "A name for the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "A description for the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "A definition of the nodes and the connections between the nodes in the flow.
" + } + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateFlowResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared. If updating fails, the status becomes Failed.
The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was last updated.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the flow. When you update a flow, the version updated is the DRAFT version.
A definition of the nodes and the connections between nodes in the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.
You can change the following fields:
name
description
roleArn
You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
The unique identifier of the knowledge base to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description for the knowledge base.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "traits": { + "smithy.api#documentation": "Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
", + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdatePrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdatePromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdatePromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/prompts/{promptIdentifier}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdatePromptRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "A name for the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "A description for the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdatePromptResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "The description of the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt. When you update a prompt, the version updated is the DRAFT version.
The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#Url": { + "type": "string", + "traits": { + "smithy.api#pattern": "^https?://[A-Za-z0-9][^\\s]*$" + } + }, + "com.amazonaws.bedrockagent#UrlConfiguration": { + "type": "structure", + "members": { + "seedUrls": { + "target": "com.amazonaws.bedrockagent#SeedUrls", + "traits": { + "smithy.api#documentation": "One or more seed or starting point URLs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.
" + } + }, + "com.amazonaws.bedrockagent#UserAgent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 40 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#UserAgentHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 61, + "max": 86 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#ValidateFlowDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ValidateFlowDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ValidateFlowDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Validates the definition of a flow.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/flows/validate-definition" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ValidateFlowDefinitionRequest": { + "type": "structure", + "members": { + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "The definition of a flow to validate.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ValidateFlowDefinitionResponse": { + "type": "structure", + "members": { + "validations": { + "target": "com.amazonaws.bedrockagent#FlowValidations", + "traits": { + "smithy.api#documentation": "Contains an array of objects, each of which contains an error identified by validation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + }, + "fieldList": { + "target": "com.amazonaws.bedrockagent#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "A list of objects containing fields that caused validation errors and their corresponding validation error messages.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagent#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#NonBlankString", + "traits": { + "smithy.api#documentation": "The name of the field.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString", + "traits": { + "smithy.api#documentation": "A message describing why this field failed validation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stores information about a field passed inside a request that resulted in an validation error.
" + } + }, + "com.amazonaws.bedrockagent#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#ValidationExceptionField" + } + }, + "com.amazonaws.bedrockagent#VectorBucketArn": { + "type": "string", + "traits": { + "aws.api#arnReference": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#VectorIngestionConfiguration": { + "type": "structure", + "members": { + "chunkingConfiguration": { + "target": "com.amazonaws.bedrockagent#ChunkingConfiguration", + "traits": { + "smithy.api#documentation": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" + } + }, + "customTransformationConfiguration": { + "target": "com.amazonaws.bedrockagent#CustomTransformationConfiguration", + "traits": { + "smithy.api#documentation": "A custom document transformer for parsed data source documents.
" + } + }, + "parsingConfiguration": { + "target": "com.amazonaws.bedrockagent#ParsingConfiguration", + "traits": { + "smithy.api#documentation": "Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used.
" + } + }, + "contextEnrichmentConfiguration": { + "target": "com.amazonaws.bedrockagent#ContextEnrichmentConfiguration", + "traits": { + "smithy.api#documentation": "The context enrichment configuration used for ingestion of the data into the vector store.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in a data source.
" + } + }, + "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "embeddingModelArn": { + "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
", + "smithy.api#required": {} + } + }, + "embeddingModelConfiguration": { + "target": "com.amazonaws.bedrockagent#EmbeddingModelConfiguration", + "traits": { + "smithy.api#documentation": "The embeddings model configuration details for the vector model used in Knowledge Base.
" + } + }, + "supplementalDataStorageConfiguration": { + "target": "com.amazonaws.bedrockagent#SupplementalDataStorageConfiguration", + "traits": { + "smithy.api#documentation": "If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the model used to create vector embeddings for the knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#VectorSearchBedrockRerankingConfiguration": { + "type": "structure", + "members": { + "modelConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorSearchBedrockRerankingModelConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration for the Amazon Bedrock reranker model.
", + "smithy.api#required": {} + } + }, + "numberOfRerankedResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Specifies the number of results to return after reranking.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrockagent#MetadataConfigurationForReranking", + "traits": { + "smithy.api#documentation": "Specifies how metadata fields should be handled during the reranking process.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures the Amazon Bedrock reranker model to improve the relevance of retrieved results.
" + } + }, + "com.amazonaws.bedrockagent#VectorSearchBedrockRerankingModelConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrockagent#BedrockRerankingModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Bedrock reranker model.
", + "smithy.api#required": {} + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagent#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "Specifies additional model-specific request parameters as key-value pairs that are included in the request to the Amazon Bedrock reranker model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures the Amazon Bedrock model used for reranking retrieved results.
" + } + }, + "com.amazonaws.bedrockagent#VectorSearchRerankingConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#VectorSearchRerankingConfigurationType", + "traits": { + "smithy.api#documentation": "Specifies the type of reranking model to use. Currently, the only supported value is BEDROCK_RERANKING_MODEL.
Specifies the configuration for using an Amazon Bedrock reranker model to rerank retrieved results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies how retrieved results from a knowledge base are reranked to improve relevance.
" + } + }, + "com.amazonaws.bedrockagent#VectorSearchRerankingConfigurationType": { + "type": "enum", + "members": { + "BEDROCK_RERANKING_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_RERANKING_MODEL" + } + } + } + }, + "com.amazonaws.bedrockagent#Version": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" + } + }, + "com.amazonaws.bedrockagent#VersionResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#DeleteAgentVersion" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentVersion" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentVersions" + } + ] + }, + "com.amazonaws.bedrockagent#VideoConfiguration": { + "type": "structure", + "members": { + "segmentationConfiguration": { + "target": "com.amazonaws.bedrockagent#VideoSegmentationConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for segmenting video content during processing.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for processing video content in multimodal knowledge bases.
" + } + }, + "com.amazonaws.bedrockagent#VideoConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#VideoConfiguration", + "traits": { + "smithy.api#documentation": "Video configuration for multi modal ingestion.
" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#VideoExtractionConfiguration": { + "type": "structure", + "members": { + "videoExtractionStatus": { + "target": "com.amazonaws.bedrockagent#EnabledOrDisabledState", + "traits": { + "smithy.api#documentation": "Whether video extraction is enabled or disabled.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for video extraction.
" + } + }, + "com.amazonaws.bedrockagent#VideoSegmentationConfiguration": { + "type": "structure", + "members": { + "fixedLengthDuration": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The duration in seconds for each video segment. Video files will be divided into chunks of this length for processing.
", + "smithy.api#range": { + "min": 1, + "max": 30 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for segmenting video content during multimodal knowledge base ingestion. Determines how video files are divided into chunks for processing.
" + } + }, + "com.amazonaws.bedrockagent#WebCrawlerConfiguration": { + "type": "structure", + "members": { + "crawlerLimits": { + "target": "com.amazonaws.bedrockagent#WebCrawlerLimits", + "traits": { + "smithy.api#documentation": "The configuration of crawl limits for the web URLs.
" + } + }, + "inclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", + "traits": { + "smithy.api#documentation": "A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
" + } + }, + "exclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", + "traits": { + "smithy.api#documentation": "A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
" + } + }, + "scope": { + "target": "com.amazonaws.bedrockagent#WebScopeType", + "traits": { + "smithy.api#documentation": "The scope of what is crawled for your URLs.
You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL \"https://docs.aws.amazon.com/bedrock/latest/userguide/\" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain \"aws.amazon.com\" can also include sub domain \"docs.aws.amazon.com\".
" + } + }, + "userAgent": { + "target": "com.amazonaws.bedrockagent#UserAgent", + "traits": { + "smithy.api#documentation": "Returns the user agent suffix for your web crawler.
" + } + }, + "userAgentHeader": { + "target": "com.amazonaws.bedrockagent#UserAgentHeader", + "traits": { + "smithy.api#documentation": "A string used for identifying the crawler or bot when it accesses a web server. The user agent header value consists of the bedrockbot, UUID, and a user agent suffix for your crawler (if one is provided). By default, it is set to bedrockbot_UUID. You can optionally append a custom suffix to bedrockbot_UUID to allowlist a specific user agent permitted to access your source URLs.
The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.
" + } + }, + "com.amazonaws.bedrockagent#WebCrawlerLimits": { + "type": "structure", + "members": { + "rateLimit": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The max rate at which pages are crawled, up to 300 per minute per host.
", + "smithy.api#range": { + "min": 1, + "max": 300 + } + } + }, + "maxPages": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The max number of web pages crawled from your source URLs, up to 25,000 pages. If the web pages exceed this limit, the data source sync will fail and no web pages will be ingested.
", + "smithy.api#range": { + "min": 1 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The rate limits for the URLs that you want to crawl. You should be authorized to crawl the URLs.
" + } + }, + "com.amazonaws.bedrockagent#WebDataSourceConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#WebSourceConfiguration", + "traits": { + "smithy.api#documentation": "The source configuration details for the web data source.
", + "smithy.api#required": {} + } + }, + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#WebCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "The Web Crawler configuration details for the web data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for the web data source.
" + } + }, + "com.amazonaws.bedrockagent#WebScopeType": { + "type": "enum", + "members": { + "HOST_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOST_ONLY" + } + }, + "SUBDOMAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBDOMAINS" + } + } + } + }, + "com.amazonaws.bedrockagent#WebSourceConfiguration": { + "type": "structure", + "members": { + "urlConfiguration": { + "target": "com.amazonaws.bedrockagent#UrlConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the URL/URLs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
" + } + }, + "com.amazonaws.bedrockagent#WorkgroupArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$" + } + } + } +} \ No newline at end of file diff --git a/codegen/aws-models/bedrock-agentcore-control.json b/codegen/aws-models/bedrock-agentcore-control.json new file mode 100644 index 0000000..4172461 --- /dev/null +++ b/codegen/aws-models/bedrock-agentcore-control.json @@ -0,0 +1,36628 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.bedrockagentcorecontrol#A2aDescriptor": { + "type": "structure", + "members": { + "agentCard": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentCardDefinition", + "traits": { + "smithy.api#documentation": "The agent card definition for the A2A agent, as defined by the A2A protocol specification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Agent-to-Agent (A2A) protocol descriptor for a registry record. Contains the agent card definition as defined by the A2A protocol specification.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcorecontrol#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a request is denied per access permissions
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bedrockagentcorecontrol#Action": { + "type": "union", + "members": { + "configurationBundle": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleAction", + "traits": { + "smithy.api#documentation": "An action that applies a configuration bundle override to the request.
" + } + }, + "routeToTarget": { + "target": "com.amazonaws.bedrockagentcorecontrol#RouteToTargetAction", + "traits": { + "smithy.api#documentation": "An action that routes the request to a specific target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An action to take when a gateway rule's conditions are met.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Actions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#Action" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ActorTokenContentType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "M2M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "M2M" + } + }, + "AWS_IAM_ID_TOKEN_JWT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IAM_ID_TOKEN_JWT" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AddDatasetExamples": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#AddDatasetExamplesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#AddDatasetExamplesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds examples to the dataset's DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics).
", + "smithy.api#http": { + "method": "POST", + "uri": "/datasets/{datasetId}/examples/add", + "code": 202 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AddDatasetExamplesRequest": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset to add examples to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagentcorecontrol#DataSourceType", + "traits": { + "smithy.api#documentation": "Source of examples to add. Provide either inline examples or an S3 URI pointing to a JSONL file.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#AddDatasetExamplesResponse": { + "type": "structure", + "members": { + "datasetArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
", + "smithy.api#required": {} + } + }, + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetStatus", + "traits": { + "smithy.api#documentation": "The current status of the dataset.
", + "smithy.api#required": {} + } + }, + "addedCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of examples added.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the examples were added.
", + "smithy.api#required": {} + } + }, + "exampleIds": { + "target": "com.amazonaws.bedrockagentcorecontrol#ExampleIdList", + "traits": { + "smithy.api#documentation": "IDs of all added examples (auto-generated UUIDs).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#AdditionalClaimName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z0-9_.:#-]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AdditionalClaimValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#AdditionalClaims": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcorecontrol#AdditionalClaimName" + }, + "value": { + "target": "com.amazonaws.bedrockagentcorecontrol#AdditionalClaimValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AdditionalModelRequestFields": { + "type": "document" + }, + "com.amazonaws.bedrockagentcorecontrol#AdvertisedScopeMappingType": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedScopeType" + }, + "value": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedScopeType" + }, + "traits": { + "smithy.api#documentation": "Maps an originalScope (from allowedScopes) to an advertisedScope\nexposed in WWW-Authenticate / Protected Resource Metadata.", + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentCardDefinition": { + "type": "structure", + "members": { + "schemaVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#SchemaVersion", + "traits": { + "smithy.api#documentation": "The schema version of the agent card based on the A2A protocol specification.
" + } + }, + "inlineContent": { + "target": "com.amazonaws.bedrockagentcorecontrol#InlineContent", + "traits": { + "smithy.api#documentation": "The JSON content containing the A2A agent card definition, conforming to the A2A protocol specification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The agent card definition for an A2A descriptor. Contains the schema version and inline content for the agent card.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentEndpointDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentEndpointResource": { + "type": "resource", + "identifiers": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId" + }, + "endpointName": { + "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntimeEndpoint" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntimeEndpoint" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntimeEndpoint" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntimeEndpoint" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeEndpoints" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentManagedRuntimeType": { + "type": "enum", + "members": { + "PYTHON_3_10": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PYTHON_3_10" + } + }, + "PYTHON_3_11": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PYTHON_3_11" + } + }, + "PYTHON_3_12": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PYTHON_3_12" + } + }, + "PYTHON_3_13": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PYTHON_3_13" + } + }, + "PYTHON_3_14": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PYTHON_3_14" + } + }, + "NODE_22": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NODE_22" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentResource": { + "type": "resource", + "identifiers": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntime" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntime" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntime" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntime" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimes" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeVersions" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntime": { + "type": "structure", + "members": { + "agentRuntimeArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent runtime.
", + "smithy.api#required": {} + } + }, + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent runtime.
", + "smithy.api#required": {} + } + }, + "agentRuntimeVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The version of the agent runtime.
", + "smithy.api#required": {} + } + }, + "agentRuntimeName": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeName", + "traits": { + "smithy.api#documentation": "The name of the agent runtime.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the agent runtime.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the agent runtime was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeStatus", + "traits": { + "smithy.api#documentation": "The current status of the agent runtime.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an agent runtime. An agent runtime is the execution environment for a Amazon Bedrock AgentCore Agent.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::Runtime" + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArtifact": { + "type": "union", + "members": { + "containerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#ContainerConfiguration", + "traits": { + "smithy.api#documentation": "The container configuration for the agent artifact.
" + } + }, + "codeConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeConfiguration", + "traits": { + "smithy.api#documentation": "The code configuration for the agent runtime artifact, including the source code location and execution settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The artifact of the agent.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpoint": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the agent runtime endpoint.
", + "smithy.api#required": {} + } + }, + "liveVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The live version of the agent runtime endpoint. This is the version that is currently serving requests.
" + } + }, + "targetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The target version of the agent runtime endpoint. This is the version that the endpoint is being updated to.
" + } + }, + "agentRuntimeEndpointArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent runtime endpoint.
", + "smithy.api#required": {} + } + }, + "agentRuntimeArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent runtime associated with the endpoint.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointStatus", + "traits": { + "smithy.api#documentation": "The current status of the agent runtime endpoint.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointId", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent runtime endpoint.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointDescription", + "traits": { + "smithy.api#documentation": "The description of the agent runtime endpoint.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the agent runtime endpoint was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the agent runtime endpoint was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an agent runtime endpoint. An endpoint provides a way to connect to and interact with an agent runtime.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::RuntimeEndpoint" + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}/runtime-endpoint/[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpoint" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^([1-9][0-9]{0,4})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntime" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentSkillsDescriptor": { + "type": "structure", + "members": { + "skillMd": { + "target": "com.amazonaws.bedrockagentcorecontrol#SkillMdDefinition", + "traits": { + "smithy.api#documentation": "The optional skill markdown definition describing the agent's skills in a human-readable format.
" + } + }, + "skillDefinition": { + "target": "com.amazonaws.bedrockagentcorecontrol#SkillDefinition", + "traits": { + "smithy.api#documentation": "The structured skill definition with schema version and content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The agent skills descriptor for a registry record. Contains an optional skill markdown definition in human-readable format and an optional structured skill definition.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedAudience": { + "type": "string" + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedAudienceList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedAudience" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedClient": { + "type": "string" + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedClientsList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedClient" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedQueryParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HttpQueryParameterName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedRequestHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HttpHeaderName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedResponseHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HttpHeaderName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedScopeType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedScopesType": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedScopeType" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedStringListValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedStringListValuesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedStringListValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedStringValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedStringValuesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedStringValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AllowedWorkloadConfiguration": { + "type": "structure", + "members": { + "hostingEnvironments": { + "target": "com.amazonaws.bedrockagentcorecontrol#HostingEnvironmentListType", + "traits": { + "smithy.api#documentation": "The list of hosting environments whose workloads are allowed to invoke the target. At launch, the only supported hosting environment is AgentCore Gateway.
" + } + }, + "workloadIdentities": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameListType", + "traits": { + "smithy.api#documentation": "The list of workload identities that are allowed to invoke the target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that restricts which workloads in the request's identity chain are allowed to invoke the target, identified by their hosting environments and workload identities. At launch, this is supported only for AgentCore Runtime targets, and the allowed workloads are AgentCore Gateways.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AmazonBedrockAgentCoreControl": { + "type": "service", + "version": "2023-06-05", + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#GetResourcePolicy" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#GetTokenVault" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListTagsForResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#PutResourcePolicy" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#SetTokenVaultCMK" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#TagResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProvider" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundle" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#Dataset" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#Evaluator" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayTargetResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2CredentialProvider" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfig" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProvider" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentity" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Bedrock AgentCore Control", + "arnNamespace": "bedrock-agentcore", + "endpointPrefix": "bedrock-agentcore-control", + "cloudTrailEventSource": "bedrock-agentcore.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "bedrock-agentcore" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "Welcome to the Amazon Bedrock AgentCore Control plane API reference. Control plane actions configure, create, modify, and monitor Amazon Web Services resources.
", + "smithy.api#title": "Amazon Bedrock AgentCore Control", + "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 + ] + } + ], + "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://bedrock-agentcore-control-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://bedrock-agentcore-control-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://bedrock-agentcore-control.{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://bedrock-agentcore-control.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 13, + "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" + }, + "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": [], + "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" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agentcore-control-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agentcore-control-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agentcore-control.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agentcore-control.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-control-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-control-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-control.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-control.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-control-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://bedrock-agentcore-control-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://bedrock-agentcore-control.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-control.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-control-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://bedrock-agentcore-control-fips.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://bedrock-agentcore-control.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://bedrock-agentcore-control.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 enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-control-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-control.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-control-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://bedrock-agentcore-control.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.bedrockagentcorecontrol#ApiGatewayTargetConfiguration": { + "type": "structure", + "members": { + "restApiId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the API Gateway REST API.
", + "smithy.api#required": {} + } + }, + "stage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the stage of the REST API to add as a target.
", + "smithy.api#required": {} + } + }, + "apiGatewayToolConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiGatewayToolConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for defining REST API tool filters and overrides for the gateway target.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for an Amazon API Gateway target.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiGatewayToolConfiguration": { + "type": "structure", + "members": { + "toolOverrides": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiGatewayToolOverrides", + "traits": { + "smithy.api#documentation": "A list of explicit tool definitions with optional custom names and descriptions.
" + } + }, + "toolFilters": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiGatewayToolFilters", + "traits": { + "smithy.api#documentation": "A list of path and method patterns to expose as tools using metadata from the REST API's OpenAPI specification.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for defining REST API tool filters and overrides for the gateway target.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiGatewayToolFilter": { + "type": "structure", + "members": { + "filterPath": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Resource path to match in the REST API. Supports exact paths (for example, /pets) or wildcard paths (for example, /pets/* to match all paths under /pets). Must match existing paths in the REST API.
The methods to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies which operations from an API Gateway REST API are exposed as tools. Tool names and descriptions are derived from the operationId and description fields in the API's exported OpenAPI specification.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiGatewayToolFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiGatewayToolFilter" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiGatewayToolOverride": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of tool. Identifies the tool in the Model Context Protocol.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the tool. Provides information about the purpose and usage of the tool. If not provided, uses the description from the API's OpenAPI specification.
" + } + }, + "path": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Resource path in the REST API (e.g., /pets). Must explicitly match an existing path in the REST API.
The HTTP method to expose for the specified path.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings to override configurations for a tool.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiGatewayToolOverrides": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiGatewayToolOverride" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiKeyArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialLocation": { + "type": "enum", + "members": { + "HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEADER" + } + }, + "QUERY_PARAMETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERY_PARAMETER" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProvider": { + "type": "resource", + "identifiers": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName" + } + }, + "properties": { + "apiKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultApiKeyType" + }, + "apiKeySecretArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Secret" + }, + "apiKeySecretJsonKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretJsonKeyType" + }, + "apiKeySecretConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretReference" + }, + "apiKeySecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType" + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProviderArnType" + }, + "createdTime": { + "target": "smithy.api#Timestamp" + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp" + } + }, + "put": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateApiKeyCredentialProvider" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetApiKeyCredentialProvider" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateApiKeyCredentialProvider" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteApiKeyCredentialProvider" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListApiKeyCredentialProviders" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProviderArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProviderArnType": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::APIKeyCredentialProvider" + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProviderItem": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the API key credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProviderArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the API key credential provider.
", + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the API key credential provider was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the API key credential provider was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an API key credential provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProviders": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProviderItem" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApiSchemaConfiguration": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3Configuration" + }, + "inlinePayload": { + "target": "com.amazonaws.bedrockagentcorecontrol#InlinePayload", + "traits": { + "smithy.api#documentation": "The inline payload containing the API schema definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for API schema.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ApprovalConfiguration": { + "type": "structure", + "members": { + "autoApproval": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether registry records are auto-approved. When set to true, records are automatically approved upon creation. When set to false (the default), records require explicit approval for security purposes.
Configuration for the registry record approval workflow. Controls whether records added to the registry require explicit approval before becoming active.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Arn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AtlassianOauth2ProviderConfigInput": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the Atlassian OAuth2 provider. This identifier is assigned by Atlassian when you register your application.
", + "smithy.api#required": {} + } + }, + "clientSecret": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultClientSecretType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The client secret for the Atlassian OAuth2 provider. This secret is assigned by Atlassian and used along with the client ID to authenticate your application.
" + } + }, + "clientSecretConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretReference", + "traits": { + "smithy.api#documentation": "A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.
The source type of the client secret for the Atlassian OAuth2 provider. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
Configuration settings for connecting to Atlassian services using OAuth2 authentication. This includes the client credentials required to authenticate with Atlassian's OAuth2 authorization server.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AtlassianOauth2ProviderConfigOutput": { + "type": "structure", + "members": { + "oauthDiscovery": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2Discovery", + "traits": { + "smithy.api#required": {} + } + }, + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the Atlassian OAuth2 provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details returned for an Atlassian OAuth2 provider, including the client ID and OAuth2 discovery information.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AuthorizationData": { + "type": "union", + "members": { + "oauth2": { + "target": "com.amazonaws.bedrockagentcorecontrol#OAuth2AuthorizationData", + "traits": { + "smithy.api#documentation": "OAuth2 authorization data for the gateway target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the authorization data that is returned when a gateway target is configured with a credential provider with authorization code grant type and requires user federation.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AuthorizationEndpointType": { + "type": "string" + }, + "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration": { + "type": "union", + "members": { + "customJWTAuthorizer": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomJWTAuthorizerConfiguration", + "traits": { + "smithy.api#documentation": "The inbound JWT-based authorization, specifying how incoming requests should be authenticated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents inbound authorization configuration options used to authenticate incoming requests.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AuthorizerType": { + "type": "enum", + "members": { + "CUSTOM_JWT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_JWT" + } + }, + "AWS_IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IAM" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "AUTHENTICATE_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHENTICATE_ONLY" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AuthorizingClaimMatchValueType": { + "type": "structure", + "members": { + "claimMatchValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClaimMatchValueType", + "traits": { + "smithy.api#documentation": "The value or values to match for.
", + "smithy.api#required": {} + } + }, + "claimMatchOperator": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClaimMatchOperatorType", + "traits": { + "smithy.api#documentation": "Defines the relationship between the claim field value and the value or values you're matching for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the value or values to match for and the relationship of the match.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AwsAccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BedrockAgentcoreResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#BedrockEvaluatorModelConfig": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModelId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Bedrock model to use for evaluation. Must be a supported foundation model available in your region.
", + "smithy.api#required": {} + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#InferenceConfiguration", + "traits": { + "smithy.api#documentation": "The inference configuration parameters that control model behavior during evaluation, including temperature, token limits, and sampling settings.
" + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagentcorecontrol#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "Additional model-specific request fields to customize model behavior beyond the standard inference configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for using Amazon Bedrock models in evaluator assessments, including model selection and inference parameters.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BranchName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_/-]{0,127}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::BrowserCustom" + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws\\.browser\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserEnterprisePolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserEnterprisePolicy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserEnterprisePolicy": { + "type": "structure", + "members": { + "location": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceLocation", + "traits": { + "smithy.api#documentation": "The location of the enterprise policy file.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserEnterprisePolicyType", + "traits": { + "smithy.api#documentation": "The type of browser enterprise policy. Available values are MANAGED and RECOMMENDED.
Browser enterprise policy configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserEnterprisePolicyType": { + "type": "enum", + "members": { + "MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED" + } + }, + "RECOMMENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECOMMENDED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(aws\\.browser\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserNetworkConfiguration": { + "type": "structure", + "members": { + "networkMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserNetworkMode", + "traits": { + "smithy.api#default": "PUBLIC", + "smithy.api#documentation": "The network mode for the browser. This field specifies how the browser connects to the network.
", + "smithy.api#required": {} + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC configuration for the browser. This configuration is required when the network mode is set to VPC.
The network configuration for a browser. This structure defines how the browser connects to the network.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserNetworkMode": { + "type": "enum", + "members": { + "PUBLIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLIC" + } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserProfileArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::BrowserProfile" + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:browser-profile/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserProfileId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserProfileName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserProfileResource": { + "type": "resource", + "identifiers": { + "profileId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateBrowserProfile" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetBrowserProfile" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteBrowserProfile" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListBrowserProfiles" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserProfileStatus": { + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "SAVING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVING" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of a browser profile.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserProfileSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserProfileSummary": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser profile.
", + "smithy.api#required": {} + } + }, + "profileArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the browser profile.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileName", + "traits": { + "smithy.api#documentation": "The name of the browser profile.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the browser profile.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileStatus", + "traits": { + "smithy.api#documentation": "The current status of the browser profile. Possible values include READY, SAVING, DELETING, and DELETED.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser profile was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser profile was last updated.
", + "smithy.api#required": {} + } + }, + "lastSavedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when browser session data was last saved to this profile.
" + } + }, + "lastSavedBrowserSessionId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The identifier of the browser session from which data was last saved to this profile.
" + } + }, + "lastSavedBrowserId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserId", + "traits": { + "smithy.api#documentation": "The identifier of the browser from which data was last saved to this profile.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a browser profile. A browser profile stores persistent browser data that can be reused across browser sessions.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserResource": { + "type": "resource", + "identifiers": { + "browserId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateBrowser" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetBrowser" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteBrowser" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListBrowsers" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserSessionId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{1,40}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserSigningConfigInput": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether browser signing is enabled. When enabled, the browser will cryptographically sign HTTP requests to identify itself as an AI agent to bot control vendors.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for enabling browser signing capabilities that allow agents to cryptographically identify themselves to websites using HTTP message signatures.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserSigningConfigOutput": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether browser signing is currently enabled for cryptographic agent identification using HTTP message signatures.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The current browser signing configuration that shows whether cryptographic agent identification is enabled for web bot authentication.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#BrowserSummary": { + "type": "structure", + "members": { + "browserId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser.
", + "smithy.api#required": {} + } + }, + "browserArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the browser.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#SandboxName", + "traits": { + "smithy.api#documentation": "The name of the browser.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the browser.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserStatus", + "traits": { + "smithy.api#documentation": "The current status of the browser.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a browser. A browser enables Amazon Bedrock AgentCore Agent to interact with web content.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CategoricalScaleDefinition": { + "type": "structure", + "members": { + "definition": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description that explains what this categorical rating represents and when it should be used.
", + "smithy.api#required": {} + } + }, + "label": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The label or name of this categorical rating option.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The definition of a categorical rating scale option that provides a named category with its description for evaluation scoring.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CategoricalScaleDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#CategoricalScaleDefinition" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CedarPolicy": { + "type": "structure", + "members": { + "statement": { + "target": "com.amazonaws.bedrockagentcorecontrol#Statement", + "traits": { + "smithy.api#documentation": "The Cedar policy statement that defines the authorization logic. This statement follows Cedar syntax and specifies principals, actions, resources, and conditions that determine when access should be allowed or denied.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a Cedar policy statement within the AgentCore Policy system. Cedar is a policy language designed for authorization that provides human-readable, analyzable, and high-performance policy evaluation for controlling agent behavior and access decisions.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Certificate": { + "type": "structure", + "members": { + "location": { + "target": "com.amazonaws.bedrockagentcorecontrol#CertificateLocation", + "traits": { + "smithy.api#documentation": "The location of the certificate.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A certificate to install in the browser or code interpreter.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CertificateLocation": { + "type": "union", + "members": { + "secretsManager": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretsManagerLocation", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Secrets Manager location of the certificate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location from which to retrieve a certificate.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Certificates": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#Certificate" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ClaimMatchOperatorType": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "CONTAINS_ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS_ANY" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ClaimMatchValueType": { + "type": "union", + "members": { + "matchValueString": { + "target": "com.amazonaws.bedrockagentcorecontrol#MatchValueString", + "traits": { + "smithy.api#documentation": "The string value to match for.
" + } + }, + "matchValueStringList": { + "target": "com.amazonaws.bedrockagentcorecontrol#MatchValueStringList", + "traits": { + "smithy.api#documentation": "An array of strings to check for a match.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The value or values to match for.
Include a matchValueString with the EQUALS operator to specify a string that matches the claim field value.
Include a matchValueArray to specify an array of string values. You can use the following operators:
Use CONTAINS to yield a match if the claim field value is in the array.
Use CONTAINS_ANY to yield a match if the claim field value contains any of the strings in the array.
The list of CloudWatch log group names to monitor for agent traces.
", + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#required": {} + } + }, + "serviceNames": { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceNamesList", + "traits": { + "smithy.api#documentation": "The list of service names to filter traces within the specified log groups. Used to identify relevant agent sessions.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for reading agent traces from CloudWatch logs as input for online evaluation.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CloudWatchOutputConfig": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.bedrockagentcorecontrol#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the CloudWatch log group where evaluation results will be written. The log group will be created if it doesn't exist.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for writing evaluation results to CloudWatch logs with embedded metric format (EMF) for monitoring.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ClusteringConfig": { + "type": "structure", + "members": { + "frequencies": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClusteringFrequencyList", + "traits": { + "smithy.api#documentation": "The list of frequencies at which clustering batch evaluations are triggered.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for periodic batch evaluation clustering, specifying how often clustering jobs run.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ClusteringFrequency": { + "type": "enum", + "members": { + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" + } + }, + "WEEKLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEKLY" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHLY" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ClusteringFrequencyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClusteringFrequency" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#Code": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3Location", + "traits": { + "smithy.api#documentation": "The Amazon Amazon S3 object that contains the source code for the agent runtime.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The source code configuration that specifies the location and details of the code to be executed.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CodeBasedEvaluatorConfig": { + "type": "union", + "members": { + "lambdaConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#LambdaEvaluatorConfig", + "traits": { + "smithy.api#documentation": "The Lambda function configuration for code-based evaluation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a code-based evaluator. Specify the Lambda function to use for evaluation.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CodeConfiguration": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.bedrockagentcorecontrol#Code", + "traits": { + "smithy.api#documentation": "The source code location and configuration details.
", + "smithy.api#required": {} + } + }, + "runtime": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentManagedRuntimeType", + "traits": { + "smithy.api#documentation": "The runtime environment for executing the agent code. Specify the programming language and version to use for the agent runtime. For valid values, see the list of supported runtimes.
", + "smithy.api#required": {} + } + }, + "entryPoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#EntryPoints", + "traits": { + "smithy.api#documentation": "The entry point for the code execution, specifying the function or method that should be invoked when the code runs.
", + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the source code that defines how the agent runtime code should be executed, including the code location, runtime environment, and entry point.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::CodeInterpreterCustom" + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):code-interpreter(-custom)?/(aws\\.codeinterpreter\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(aws\\.codeinterpreter\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterNetworkConfiguration": { + "type": "structure", + "members": { + "networkMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterNetworkMode", + "traits": { + "smithy.api#default": "SANDBOX", + "smithy.api#documentation": "The network mode for the code interpreter. This field specifies how the code interpreter connects to the network.
", + "smithy.api#required": {} + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC configuration for the code interpreter. This configuration is required when the network mode is set to VPC.
The network configuration for a code interpreter. This structure defines how the code interpreter connects to the network.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterNetworkMode": { + "type": "enum", + "members": { + "PUBLIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLIC" + } + }, + "SANDBOX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SANDBOX" + } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterResource": { + "type": "resource", + "identifiers": { + "codeInterpreterId": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateCodeInterpreter" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetCodeInterpreter" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteCodeInterpreter" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListCodeInterpreters" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterSummary": { + "type": "structure", + "members": { + "codeInterpreterId": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterId", + "traits": { + "smithy.api#documentation": "The unique identifier of the code interpreter.
", + "smithy.api#required": {} + } + }, + "codeInterpreterArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the code interpreter.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#SandboxName", + "traits": { + "smithy.api#documentation": "The name of the code interpreter.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the code interpreter.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterStatus", + "traits": { + "smithy.api#documentation": "The current status of the code interpreter.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the code interpreter was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the code interpreter was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a code interpreter. A code interpreter enables Amazon Bedrock AgentCore Agent to execute code.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CoinbaseCdpApiKeyIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-_]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CoinbaseCdpConfigurationInput": { + "type": "structure", + "members": { + "apiKeyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#CoinbaseCdpApiKeyIdType", + "traits": { + "smithy.api#documentation": "The API key identifier provided by Coinbase Developer Platform.
", + "smithy.api#required": {} + } + }, + "apiKeySecret": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultCoinbaseCdpApiKeySecretType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The API key secret provided by Coinbase Developer Platform.
" + } + }, + "apiKeySecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the API key secret for the Coinbase Developer Platform. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
A reference to the Amazon Web Services Secrets Manager secret that stores the API key secret. This includes the secret ID and the JSON key used to extract the API key secret value from the secret. Required when apiKeySecretSource is set to EXTERNAL.
The wallet secret provided by Coinbase Developer Platform.
" + } + }, + "walletSecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the wallet secret for the Coinbase Developer Platform. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
A reference to the Amazon Web Services Secrets Manager secret that stores the wallet secret. This includes the secret ID and the JSON key used to extract the wallet secret value from the secret. Required when walletSecretSource is set to EXTERNAL.
Coinbase CDP configuration — credentials provided by Coinbase Developer Platform.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CoinbaseCdpConfigurationOutput": { + "type": "structure", + "members": { + "apiKeyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#CoinbaseCdpApiKeyIdType", + "traits": { + "smithy.api#documentation": "The API key identifier provided by Coinbase Developer Platform.
", + "smithy.api#required": {} + } + }, + "apiKeySecretArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Secret", + "traits": { + "smithy.api#required": {} + } + }, + "apiKeySecretJsonKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretJsonKeyType", + "traits": { + "smithy.api#documentation": "The JSON key used to extract the API key secret value from the Amazon Web Services Secrets Manager secret.
" + } + }, + "apiKeySecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.
The JSON key used to extract the wallet secret value from the Amazon Web Services Secrets Manager secret.
" + } + }, + "walletSecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the wallet secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.
Coinbase CDP configuration output with secret ARNs.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ComponentConfiguration": { + "type": "structure", + "members": { + "configuration": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The configuration values as a flexible JSON document.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a component within a configuration bundle. The component type is inferred from the component identifier ARN.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ComponentConfigurationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcorecontrol#ComponentIdentifier" + }, + "value": { + "target": "com.amazonaws.bedrockagentcorecontrol#ComponentConfiguration" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ComponentIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_:/.\\-]{0,2047}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConcurrentModificationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Exception thrown when a resource is modified concurrently by multiple requests.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.bedrockagentcorecontrol#Condition": { + "type": "union", + "members": { + "matchPrincipals": { + "target": "com.amazonaws.bedrockagentcorecontrol#MatchPrincipals", + "traits": { + "smithy.api#documentation": "A condition that matches on the identity of the caller making the request.
" + } + }, + "matchPaths": { + "target": "com.amazonaws.bedrockagentcorecontrol#MatchPaths", + "traits": { + "smithy.api#documentation": "A condition that matches on the request path.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A condition that determines when a gateway rule applies. Conditions can match on principals or request paths.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Conditions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#Condition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundle": { + "type": "resource", + "identifiers": { + "bundleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateConfigurationBundle" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetConfigurationBundle" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateConfigurationBundle" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteConfigurationBundle" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListConfigurationBundles" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#GetConfigurationBundleVersion" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListConfigurationBundleVersions" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleAction": { + "type": "union", + "members": { + "staticOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#StaticOverride", + "traits": { + "smithy.api#documentation": "A static configuration bundle override that applies a single bundle version to all matching requests.
" + } + }, + "weightedOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#WeightedOverride", + "traits": { + "smithy.api#documentation": "A weighted configuration bundle override that splits traffic between multiple bundle versions based on configured weights.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An action that applies a configuration bundle override, either as a static override or a weighted split for A/B testing.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:configuration-bundle/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#pattern": "^.+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,99}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleReference": { + "type": "structure", + "members": { + "bundleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayConfigurationBundleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "bundleVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the configuration bundle.
", + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to a specific version of a configuration bundle.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleSummary": { + "type": "structure", + "members": { + "bundleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "bundleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "bundleName": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleName", + "traits": { + "smithy.api#documentation": "The name of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleDescription", + "traits": { + "smithy.api#documentation": "The description of the configuration bundle.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the configuration bundle was created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a configuration bundle.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersion" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersionSummary": { + "type": "structure", + "members": { + "bundleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "bundleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "versionId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersion", + "traits": { + "smithy.api#documentation": "The version identifier of this configuration bundle version.
", + "smithy.api#required": {} + } + }, + "lineageMetadata": { + "target": "com.amazonaws.bedrockagentcorecontrol#VersionLineageMetadata", + "traits": { + "smithy.api#documentation": "The version lineage metadata, including parent versions, branch name, and creation source.
" + } + }, + "versionCreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this version was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a configuration bundle version.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersionSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcorecontrol#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when there is a conflict performing an operation
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConnectorConfiguration": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The tool or operation name (for example, retrieve or webSearch).
An agent-facing description override for this tool.
", + "smithy.api#length": { + "max": 2000 + } + } + }, + "parameterValues": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Parameters to set as fixed or default values when provisioning this tool.
" + } + }, + "parameterOverrides": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConnectorParameterOverrides", + "traits": { + "smithy.api#documentation": "Parameters to expose to the agent at runtime, with optional description overrides.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a single tool within a connector.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConnectorConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConnectorConfiguration" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConnectorId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConnectorParameterOverride": { + "type": "structure", + "members": { + "path": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A JSON Pointer path identifying the parameter (for example, /numberOfResults or /filter).
An agent-facing description override for this parameter.
" + } + }, + "visible": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether this parameter is visible to the agent. If not specified, uses the service default.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a parameter override for a connector tool, allowing you to control parameter visibility and descriptions.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConnectorParameterOverrides": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConnectorParameterOverride" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConnectorSource": { + "type": "structure", + "members": { + "connectorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConnectorId", + "traits": { + "smithy.api#documentation": "The identifier for the connector integration (for example, bedrock-knowledge-bases).
The version of the connector to use (for example, 1.1.0). If you don't specify a version, the service uses the latest available version.
The source identifying the connector integration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConnectorTargetConfiguration": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConnectorSource", + "traits": { + "smithy.api#documentation": "The source configuration identifying which connector to use.
", + "smithy.api#required": {} + } + }, + "enabled": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnabledConnectors", + "traits": { + "smithy.api#documentation": "A list of tool names to enable from this connector. If absent, all tools provided by the connector are enabled.
" + } + }, + "configurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConnectorConfigurations", + "traits": { + "smithy.api#documentation": "A list of per-tool configurations for the connector.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a connector integration target. Connectors provide pre-built integrations with Amazon Web Services services and third-party tools.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConnectorVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 32 + }, + "smithy.api#pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ConsolidationConfiguration": { + "type": "union", + "members": { + "customConsolidationConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomConsolidationConfiguration", + "traits": { + "smithy.api#documentation": "The custom consolidation configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains consolidation configuration information for a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ContainerConfiguration": { + "type": "structure", + "members": { + "containerUri": { + "target": "com.amazonaws.bedrockagentcorecontrol#RuntimeContainerUri", + "traits": { + "smithy.api#documentation": "The ECR URI of the container.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Representation of a container configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Content": { + "type": "union", + "members": { + "rawText": { + "target": "com.amazonaws.bedrockagentcorecontrol#NaturalLanguage", + "traits": { + "smithy.api#documentation": "The raw text content containing natural language descriptions of desired policy behavior. This text is processed by AI to generate corresponding Cedar policy statements that match the described intent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents content input for policy generation operations. This structure encapsulates the natural language descriptions or other content formats that are used as input for AI-powered policy generation.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ContentConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#ContentType", + "traits": { + "smithy.api#documentation": "Type of content to stream.
", + "smithy.api#required": {} + } + }, + "level": { + "target": "com.amazonaws.bedrockagentcorecontrol#ContentLevel", + "traits": { + "smithy.api#default": "METADATA_ONLY", + "smithy.api#documentation": "Level of detail for streamed content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines what content to stream and at what level of detail.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ContentConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ContentConfiguration" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ContentLevel": { + "type": "enum", + "members": { + "METADATA_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METADATA_ONLY" + } + }, + "FULL_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_CONTENT" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ContentType": { + "type": "enum", + "members": { + "MEMORY_RECORDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEMORY_RECORDS" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntime": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntimeRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntimeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Bedrock AgentCore Runtime.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/runtimes/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntimeEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntimeEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntimeEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an AgentCore Runtime endpoint.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/runtimes/{agentRuntimeId}/runtime-endpoints/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntimeEndpointRequest": { + "type": "structure", + "members": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime to create an endpoint for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the AgentCore Runtime endpoint.
", + "smithy.api#required": {} + } + }, + "agentRuntimeVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The version of the AgentCore Runtime to use for the endpoint.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointDescription", + "traits": { + "smithy.api#documentation": "The description of the AgentCore Runtime endpoint.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to the agent runtime endpoint. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntimeEndpointResponse": { + "type": "structure", + "members": { + "targetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The target version of the AgentCore Runtime for the endpoint.
", + "smithy.api#required": {} + } + }, + "agentRuntimeEndpointArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.
", + "smithy.api#required": {} + } + }, + "agentRuntimeArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime.
" + } + }, + "endpointName": { + "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the AgentCore Runtime endpoint.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointStatus", + "traits": { + "smithy.api#documentation": "The current status of the AgentCore Runtime endpoint.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the AgentCore Runtime endpoint was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntimeRequest": { + "type": "structure", + "members": { + "agentRuntimeName": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeName", + "traits": { + "smithy.api#documentation": "The name of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "agentRuntimeArtifact": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArtifact", + "traits": { + "smithy.api#documentation": "The artifact of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN that provides permissions for the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "networkConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "The network configuration for the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the AgentCore Runtime.
" + } + }, + "authorizerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", + "traits": { + "smithy.api#documentation": "The authorizer configuration for the AgentCore Runtime.
" + } + }, + "requestHeaderConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#RequestHeaderConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for HTTP request headers that will be passed through to the runtime.
" + } + }, + "protocolConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#ProtocolConfiguration" + }, + "lifecycleConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#LifecycleConfiguration", + "traits": { + "smithy.api#documentation": "The life cycle configuration for the AgentCore Runtime.
" + } + }, + "environmentVariables": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnvironmentVariablesMap", + "traits": { + "smithy.api#documentation": "Environment variables to set in the AgentCore Runtime environment.
" + } + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#FilesystemConfigurations", + "traits": { + "smithy.api#documentation": "The filesystem configurations to mount into the AgentCore Runtime. Use filesystem configurations to provide persistent storage to your AgentCore Runtime sessions.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to the agent runtime. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntimeResponse": { + "type": "structure", + "members": { + "agentRuntimeArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "workloadIdentityDetails": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails", + "traits": { + "smithy.api#documentation": "The workload identity details for the AgentCore Runtime.
" + } + }, + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "agentRuntimeVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The version of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the AgentCore Runtime was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeStatus", + "traits": { + "smithy.api#documentation": "The current status of the AgentCore Runtime.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateApiKeyCredentialProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateApiKeyCredentialProviderRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateApiKeyCredentialProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#DecryptionFailure" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#EncryptionFailure" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Creates a new API key credential provider.
", + "smithy.api#http": { + "code": 201, + "uri": "/identities/CreateApiKeyCredentialProvider", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateApiKeyCredentialProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the API key credential provider. The name must be unique within your account.
", + "smithy.api#required": {} + } + }, + "apiKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultApiKeyType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The API key to use for authentication. This value is encrypted and stored securely.
" + } + }, + "apiKeySecretConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretReference", + "traits": { + "smithy.api#documentation": "A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.
The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateApiKeyCredentialProviderResponse": { + "type": "structure", + "members": { + "apiKeySecretArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Secret", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret containing the API key.
", + "smithy.api#property": {}, + "smithy.api#required": {} + } + }, + "apiKeySecretJsonKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretJsonKeyType", + "traits": { + "smithy.api#documentation": "The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.
", + "smithy.api#property": {} + } + }, + "apiKeySecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.
The name of the created API key credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProviderArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created API key credential provider.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateBrowser": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateBrowserRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateBrowserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a custom browser.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/browsers" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateBrowserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateBrowserProfileRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateBrowserProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a browser profile in Amazon Bedrock AgentCore. A browser profile stores persistent browser data such as cookies, local storage, session storage, and browsing history that can be saved from browser sessions and reused in subsequent sessions.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/browser-profiles" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateBrowserProfileRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileName", + "traits": { + "smithy.api#documentation": "The name of the browser profile. The name must be unique within your account and can contain alphanumeric characters and underscores.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "A description of the browser profile. Use this field to describe the purpose or contents of the profile.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to the browser profile. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateBrowserProfileResponse": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created browser profile.
", + "smithy.api#required": {} + } + }, + "profileArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created browser profile.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser profile was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileStatus", + "traits": { + "smithy.api#documentation": "The current status of the browser profile.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateBrowserRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#SandboxName", + "traits": { + "smithy.api#documentation": "The name of the browser. The name must be unique within your account.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the browser.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the browser to access Amazon Web Services services.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserNetworkConfiguration", + "traits": { + "smithy.api#documentation": "The network configuration for the browser. This configuration specifies the network mode for the browser.
", + "smithy.api#required": {} + } + }, + "recording": { + "target": "com.amazonaws.bedrockagentcorecontrol#RecordingConfig", + "traits": { + "smithy.api#documentation": "The recording configuration for the browser. When enabled, browser sessions are recorded and stored in the specified Amazon S3 location.
" + } + }, + "browserSigning": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserSigningConfigInput", + "traits": { + "smithy.api#documentation": "The browser signing configuration that enables cryptographic agent identification using HTTP message signatures for web bot authentication.
" + } + }, + "enterprisePolicies": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserEnterprisePolicies", + "traits": { + "smithy.api#documentation": "A list of enterprise policy files for the browser.
" + } + }, + "certificates": { + "target": "com.amazonaws.bedrockagentcorecontrol#Certificates", + "traits": { + "smithy.api#documentation": "A list of certificates to install in the browser.
" + } + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#ToolsFileSystemConfigurations", + "traits": { + "smithy.api#documentation": "The file system configurations to mount into the browser. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your sessions can then access your data. If you don't specify this field, no file systems are mounted.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to the browser. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateBrowserResponse": { + "type": "structure", + "members": { + "browserId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created browser.
", + "smithy.api#required": {} + } + }, + "browserArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created browser.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserStatus", + "traits": { + "smithy.api#documentation": "The current status of the browser.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateCodeInterpreter": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateCodeInterpreterRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateCodeInterpreterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a custom code interpreter.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/code-interpreters" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateCodeInterpreterRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#SandboxName", + "traits": { + "smithy.api#documentation": "The name of the code interpreter. The name must be unique within your account.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the code interpreter.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the code interpreter to access Amazon Web Services services.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterNetworkConfiguration", + "traits": { + "smithy.api#documentation": "The network configuration for the code interpreter. This configuration specifies the network mode for the code interpreter.
", + "smithy.api#required": {} + } + }, + "certificates": { + "target": "com.amazonaws.bedrockagentcorecontrol#Certificates", + "traits": { + "smithy.api#documentation": "A list of certificates to install in the code interpreter.
" + } + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#ToolsFileSystemConfigurations", + "traits": { + "smithy.api#documentation": "The file system configurations to mount into the code interpreter. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your sessions can then access your data. If you don't specify this field, no file systems are mounted.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to the code interpreter. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateCodeInterpreterResponse": { + "type": "structure", + "members": { + "codeInterpreterId": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created code interpreter.
", + "smithy.api#required": {} + } + }, + "codeInterpreterArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created code interpreter.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the code interpreter was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterStatus", + "traits": { + "smithy.api#documentation": "The current status of the code interpreter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateConfigurationBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateConfigurationBundleRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateConfigurationBundleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new configuration bundle resource. A configuration bundle stores versioned component configurations for agent evaluation workflows.
", + "smithy.api#http": { + "method": "POST", + "uri": "/configuration-bundles/create", + "code": 201 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateConfigurationBundleRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "bundleName": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleName", + "traits": { + "smithy.api#documentation": "The name for the configuration bundle. Names must be unique within your account.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleDescription", + "traits": { + "smithy.api#documentation": "The description for the configuration bundle.
" + } + }, + "components": { + "target": "com.amazonaws.bedrockagentcorecontrol#ComponentConfigurationMap", + "traits": { + "smithy.api#documentation": "A map of component identifiers to their configurations. Each component represents a configurable element within the bundle.
", + "smithy.api#required": {} + } + }, + "branchName": { + "target": "com.amazonaws.bedrockagentcorecontrol#BranchName", + "traits": { + "smithy.api#documentation": "The branch name for version tracking. Defaults to mainline if not specified.
A commit message describing the initial version of the configuration bundle.
", + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "createdBy": { + "target": "com.amazonaws.bedrockagentcorecontrol#VersionCreatedBySource", + "traits": { + "smithy.api#documentation": "The source that created this version, including the source name and optional ARN.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "Optional KMS key ARN for encrypting component configurations.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to the configuration bundle. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateConfigurationBundleResponse": { + "type": "structure", + "members": { + "bundleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created configuration bundle.
", + "smithy.api#required": {} + } + }, + "bundleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created configuration bundle.
", + "smithy.api#required": {} + } + }, + "versionId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersion", + "traits": { + "smithy.api#documentation": "The initial version identifier of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the configuration bundle was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateDatasetRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": " Creates a new dataset resource asynchronously. Returns immediately with status CREATING. Poll GetDataset until status transitions to ACTIVE or CREATE_FAILED.
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "datasetName": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetName", + "traits": { + "smithy.api#documentation": "Human-readable name for the dataset. Must be unique within the account. Immutable after creation.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the dataset.
", + "smithy.api#length": { + "max": 200 + } + } + }, + "source": { + "target": "com.amazonaws.bedrockagentcorecontrol#DataSourceType", + "traits": { + "smithy.api#documentation": "Source of initial examples. Provide either inline examples or an S3 URI pointing to a JSONL file.
", + "smithy.api#required": {} + } + }, + "schemaType": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetSchemaType", + "traits": { + "smithy.api#documentation": "Versioned schema type governing the structure of examples. Immutable after creation.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "Optional KMS key ARN for server-side encryption on service Amazon S3 writes.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to the dataset.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateDatasetResponse": { + "type": "structure", + "members": { + "datasetArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created dataset.
", + "smithy.api#required": {} + } + }, + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created dataset.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetStatus", + "traits": { + "smithy.api#documentation": " Always CREATING immediately after this call. Poll GetDataset until status transitions to ACTIVE or CREATE_FAILED.
The timestamp when the dataset was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateDatasetVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateDatasetVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateDatasetVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": " Publishes the current DRAFT as a new numbered version. The DRAFT is preserved and remains editable after publishing. Returns immediately with status UPDATING. Poll GetDataset until status transitions to ACTIVE or UPDATE_FAILED.
The unique identifier of the dataset to publish a version for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateDatasetVersionResponse": { + "type": "structure", + "members": { + "datasetArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
", + "smithy.api#required": {} + } + }, + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetStatus", + "traits": { + "smithy.api#documentation": " Always UPDATING immediately after this call. Poll GetDataset until status transitions to ACTIVE or UPDATE_FAILED.
The version number being created.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the version creation was initiated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateEvaluator": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateEvaluatorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateEvaluatorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a custom evaluator for agent quality assessment. Custom evaluators can use either LLM-as-a-Judge configurations with user-defined prompts, rating scales, and model settings, or code-based configurations with customer-managed Lambda functions to evaluate agent performance at tool call, trace, or session levels.
", + "smithy.api#http": { + "method": "POST", + "uri": "/evaluators/create", + "code": 202 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateEvaluatorRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "evaluatorName": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomEvaluatorName", + "traits": { + "smithy.api#documentation": "The name of the evaluator. Must be unique within your account.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorDescription", + "traits": { + "smithy.api#documentation": "The description of the evaluator that explains its purpose and evaluation criteria.
" + } + }, + "evaluatorConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorConfig", + "traits": { + "smithy.api#documentation": "The configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.
", + "smithy.api#required": {} + } + }, + "level": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorLevel", + "traits": { + "smithy.api#documentation": " The evaluation level that determines the scope of evaluation. Valid values are TOOL_CALL for individual tool invocations, TRACE for single request-response interactions, or SESSION for entire conversation sessions.
The Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data, including instructions and rating scale. If you don't specify a KMS key, the evaluator data is encrypted with an Amazon Web Services owned key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to an AgentCore Evaluator. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateEvaluatorResponse": { + "type": "structure", + "members": { + "evaluatorArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomEvaluatorArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created evaluator.
", + "smithy.api#required": {} + } + }, + "evaluatorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created evaluator.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the evaluator was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorStatus", + "traits": { + "smithy.api#documentation": "The status of the evaluator creation operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateGatewayRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateGatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a gateway for Amazon Bedrock Agent. A gateway serves as an integration point between your agent and external services.
If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.
The name of the gateway. The name must be unique within your account.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayDescription", + "traits": { + "smithy.api#documentation": "The description of the gateway.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.
", + "smithy.api#required": {} + } + }, + "protocolType": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "MCP", + "smithy.api#documentation": "The protocol type for the gateway.
" + } + }, + "protocolConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolConfiguration", + "traits": { + "smithy.api#documentation": "The configuration settings for the protocol specified in the protocolType parameter.
The type of authorizer to use for the gateway.
CUSTOM_JWT - Authorize with a bearer token.
AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
NONE - No authorization
The authorizer configuration for the gateway. Required if authorizerType is CUSTOM_JWT.
The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.
" + } + }, + "interceptorConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayInterceptorConfigurations", + "traits": { + "smithy.api#documentation": "A list of configuration settings for a gateway interceptor. Gateway interceptors allow custom code to be invoked during gateway invocations.
" + } + }, + "policyEngineConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayPolicyEngineConfiguration", + "traits": { + "smithy.api#documentation": "The policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.
" + } + }, + "exceptionLevel": { + "target": "com.amazonaws.bedrockagentcorecontrol#ExceptionLevel", + "traits": { + "smithy.api#documentation": "The level of detail in error messages returned when invoking the gateway.
If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.
If the value is omitted, a generic error message is returned to the end user.
A map of key-value pairs to associate with the gateway as metadata tags.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateGatewayResponse": { + "type": "structure", + "members": { + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created gateway.
", + "smithy.api#required": {} + } + }, + "gatewayId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created gateway.
", + "smithy.api#required": {} + } + }, + "gatewayUrl": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayUrl", + "traits": { + "smithy.api#documentation": "The URL endpoint for the created gateway.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the gateway was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the gateway was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayStatus", + "traits": { + "smithy.api#documentation": "The current status of the gateway.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", + "traits": { + "smithy.api#documentation": "The reasons for the current status of the gateway.
" + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayName", + "traits": { + "smithy.api#documentation": "The name of the gateway.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayDescription", + "traits": { + "smithy.api#documentation": "The description of the gateway.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with the gateway.
" + } + }, + "protocolType": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "MCP", + "smithy.api#documentation": "The protocol type of the gateway.
" + } + }, + "protocolConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolConfiguration", + "traits": { + "smithy.api#documentation": "The configuration settings for the protocol used by the gateway.
" + } + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerType", + "traits": { + "smithy.api#documentation": "The type of authorizer used by the gateway.
", + "smithy.api#required": {} + } + }, + "authorizerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", + "traits": { + "smithy.api#documentation": "The authorizer configuration for the created gateway.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.
" + } + }, + "customTransformConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomTransformConfiguration", + "traits": { + "smithy.api#documentation": "The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.
" + } + }, + "interceptorConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayInterceptorConfigurations", + "traits": { + "smithy.api#documentation": "The list of interceptor configurations for the created gateway.
" + } + }, + "policyEngineConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayPolicyEngineConfiguration", + "traits": { + "smithy.api#documentation": "The policy engine configuration for the created gateway.
" + } + }, + "workloadIdentityDetails": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails", + "traits": { + "smithy.api#documentation": "The workload identity details for the created gateway.
" + } + }, + "exceptionLevel": { + "target": "com.amazonaws.bedrockagentcorecontrol#ExceptionLevel", + "traits": { + "smithy.api#documentation": "The level of detail in error messages returned when invoking the gateway.
If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.
If the value is omitted, a generic error message is returned to the end user.
The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway.
" + } + }, + "wafConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#WafConfiguration", + "traits": { + "smithy.api#documentation": "The Amazon Web Services WAF configuration for the gateway.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateGatewayRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateGatewayRuleRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateGatewayRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a rule for a gateway. Rules define conditions and actions that control how requests are routed and processed through the gateway, including principal-based access control and path-based routing.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/gateways/{gatewayIdentifier}/rules" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateGatewayRuleRequest": { + "type": "structure", + "members": { + "gatewayIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the gateway to create a rule for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "priority": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRulePriority", + "traits": { + "smithy.api#documentation": "The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first. Must be between 1 and 1,000,000.
", + "smithy.api#required": {} + } + }, + "conditions": { + "target": "com.amazonaws.bedrockagentcorecontrol#Conditions", + "traits": { + "smithy.api#documentation": "The conditions that must be met for the rule to apply. Conditions can match on principals (IAM ARNs) or request paths.
" + } + }, + "actions": { + "target": "com.amazonaws.bedrockagentcorecontrol#Actions", + "traits": { + "smithy.api#documentation": "The actions to take when the rule conditions are met. Actions can route to a specific target or apply a configuration bundle override.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleDescription", + "traits": { + "smithy.api#documentation": "The description of the gateway rule.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateGatewayRuleResponse": { + "type": "structure", + "members": { + "ruleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the gateway rule.
", + "smithy.api#required": {} + } + }, + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway that the rule belongs to.
", + "smithy.api#required": {} + } + }, + "priority": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRulePriority", + "traits": { + "smithy.api#documentation": "The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.
", + "smithy.api#required": {} + } + }, + "conditions": { + "target": "com.amazonaws.bedrockagentcorecontrol#Conditions", + "traits": { + "smithy.api#documentation": "The conditions that must be met for the rule to apply.
" + } + }, + "actions": { + "target": "com.amazonaws.bedrockagentcorecontrol#Actions", + "traits": { + "smithy.api#documentation": "The actions to take when the rule conditions are met.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleDescription", + "traits": { + "smithy.api#documentation": "The description of the gateway rule.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the rule was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleStatus", + "traits": { + "smithy.api#documentation": "The current status of the rule.
", + "smithy.api#required": {} + } + }, + "system": { + "target": "com.amazonaws.bedrockagentcorecontrol#SystemManagedBlock", + "traits": { + "smithy.api#documentation": "System-managed metadata for rules created by automated processes.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateGatewayTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateGatewayTargetRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateGatewayTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/gateways/{gatewayIdentifier}/targets/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateGatewayTargetRequest": { + "type": "structure", + "members": { + "gatewayIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the gateway to create a target for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetName", + "traits": { + "smithy.api#documentation": "The name of the gateway target. The name must be unique within the gateway.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetDescription", + "traits": { + "smithy.api#documentation": "The description of the gateway target.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "targetConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetConfiguration", + "traits": { + "smithy.api#documentation": "The configuration settings for the target, including endpoint information and schema definitions.
", + "smithy.api#required": {} + } + }, + "credentialProviderConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderConfigurations", + "traits": { + "smithy.api#documentation": "The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.
" + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#MetadataConfiguration", + "traits": { + "smithy.api#documentation": "Optional configuration for HTTP header and query parameter propagation to and from the gateway target.
" + } + }, + "privateEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpoint", + "traits": { + "smithy.api#documentation": "The private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateGatewayTargetResponse": { + "type": "structure", + "members": { + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway.
", + "smithy.api#required": {} + } + }, + "targetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created target.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the target was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the target was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetStatus", + "traits": { + "smithy.api#documentation": "The current status of the target.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", + "traits": { + "smithy.api#documentation": "The reasons for the current status of the target.
" + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetName", + "traits": { + "smithy.api#documentation": "The name of the target.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetDescription", + "traits": { + "smithy.api#documentation": "The description of the target.
" + } + }, + "targetConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetConfiguration", + "traits": { + "smithy.api#documentation": "The configuration settings for the target.
", + "smithy.api#required": {} + } + }, + "credentialProviderConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderConfigurations", + "traits": { + "smithy.api#documentation": "The credential provider configurations for the target.
", + "smithy.api#required": {} + } + }, + "lastSynchronizedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The last synchronization of the target.
" + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#MetadataConfiguration", + "traits": { + "smithy.api#documentation": "The metadata configuration that was applied to the created gateway target.
" + } + }, + "privateEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpoint", + "traits": { + "smithy.api#documentation": "The private endpoint configuration for the gateway target.
" + } + }, + "privateEndpointManagedResources": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointManagedResources", + "traits": { + "smithy.api#documentation": "The managed resources created by the gateway for private endpoint connectivity.
" + } + }, + "authorizationData": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizationData", + "traits": { + "smithy.api#documentation": "OAuth2 authorization data for the created gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.
" + } + }, + "protocolType": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetProtocolType", + "traits": { + "smithy.api#documentation": "The protocol type of the created gateway target.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateHarness": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateHarnessRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateHarnessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Operation to create a harness.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/harnesses" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateHarnessEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateHarnessEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateHarnessEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Operation to create a harness endpoint.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/harnesses/{harnessId}/endpoints" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateHarnessEndpointRequest": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness to create an endpoint for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "endpointName": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointName", + "traits": { + "smithy.api#documentation": "The name of the endpoint. Must start with a letter and contain only alphanumeric characters and underscores.
", + "smithy.api#required": {} + } + }, + "targetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessVersion", + "traits": { + "smithy.api#documentation": "The harness version that the endpoint points to and serves invocations from.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointDescription", + "traits": { + "smithy.api#documentation": "A description of the endpoint.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "Tags to apply to the endpoint resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateHarnessEndpointResponse": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint that was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateHarnessRequest": { + "type": "structure", + "members": { + "harnessName": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessName", + "traits": { + "smithy.api#documentation": "The name of the harness. Must start with a letter and contain only alphanumeric characters and underscores.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that the harness assumes when running. This role must have permissions for the services the agent needs to access, such as Amazon Bedrock for model invocation.
", + "smithy.api#required": {} + } + }, + "environment": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEnvironmentProviderRequest", + "traits": { + "smithy.api#documentation": "The compute environment configuration for the harness, including network and lifecycle settings.
" + } + }, + "environmentArtifact": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEnvironmentArtifact", + "traits": { + "smithy.api#documentation": "The environment artifact for the harness, such as a custom container image containing additional dependencies.
" + } + }, + "environmentVariables": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnvironmentVariablesMap", + "traits": { + "smithy.api#documentation": "Environment variables to set in the harness runtime environment.
" + } + }, + "authorizerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration" + }, + "model": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessModelConfiguration", + "traits": { + "smithy.api#documentation": "The model configuration for the harness. Supports Amazon Bedrock, OpenAI, and Google Gemini model providers.
" + } + }, + "systemPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSystemPrompt", + "traits": { + "smithy.api#documentation": "The system prompt that defines the agent's behavior and instructions.
" + } + }, + "tools": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessTools", + "traits": { + "smithy.api#documentation": "The tools available to the agent, such as remote MCP servers, AgentCore Gateway, AgentCore Browser, Code Interpreter, or inline functions.
" + } + }, + "skills": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSkills", + "traits": { + "smithy.api#documentation": "The skills available to the agent. Skills are bundles of files that the agent can pull into its context on demand.
" + } + }, + "allowedTools": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAllowedTools", + "traits": { + "smithy.api#documentation": "The tools that the agent is allowed to use. Supports glob patterns such as * for all tools, @builtin for all built-in tools, or @serverName/toolName for specific MCP server tools.
" + } + }, + "memory": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessMemoryConfiguration", + "traits": { + "smithy.api#documentation": "The AgentCore Memory configuration for persisting conversation context across sessions.
" + } + }, + "truncation": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessTruncationConfiguration", + "traits": { + "smithy.api#documentation": "The truncation configuration for managing conversation context when it exceeds model limits.
" + } + }, + "maxIterations": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of iterations the agent loop can execute per invocation.
" + } + }, + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum total number of output tokens the agent can generate across all model calls within a single invocation.
" + } + }, + "timeoutSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum duration in seconds for the agent loop execution per invocation.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "Tags to apply to the harness resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateHarnessResponse": { + "type": "structure", + "members": { + "harness": { + "target": "com.amazonaws.bedrockagentcorecontrol#Harness", + "traits": { + "smithy.api#documentation": "The harness that was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateMemory": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateMemoryInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateMemoryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new Amazon Bedrock AgentCore Memory resource.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/memories/create" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateMemoryInput": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NonEmptyString", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but does not return an error.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#length": { + "max": 500 + } + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#Name", + "traits": { + "smithy.api#documentation": "The name of the memory. The name must be unique within your account.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the memory.
" + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the memory data.
" + } + }, + "memoryExecutionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the memory to access Amazon Web Services services.
" + } + }, + "eventExpiryDuration": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The duration after which memory events expire. Specified as an ISO 8601 duration.
", + "smithy.api#range": { + "min": 3, + "max": 365 + }, + "smithy.api#required": {} + } + }, + "memoryStrategies": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyInputList", + "traits": { + "smithy.api#documentation": "The memory strategies to use for this memory. Strategies define how information is extracted, processed, and consolidated.
" + } + }, + "indexedKeys": { + "target": "com.amazonaws.bedrockagentcorecontrol#IndexedKeysList", + "traits": { + "smithy.api#documentation": "Metadata keys to index for filtering. Once declared, indexed keys cannot be removed.
" + } + }, + "streamDeliveryResources": { + "target": "com.amazonaws.bedrockagentcorecontrol#StreamDeliveryResources", + "traits": { + "smithy.api#documentation": "Configuration for streaming memory record data to external resources.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to an AgentCore Memory. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateMemoryOutput": { + "type": "structure", + "members": { + "memory": { + "target": "com.amazonaws.bedrockagentcorecontrol#Memory", + "traits": { + "smithy.api#documentation": "The details of the created memory, including its ID, ARN, name, description, and configuration settings.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateOauth2CredentialProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateOauth2CredentialProviderRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateOauth2CredentialProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#DecryptionFailure" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#EncryptionFailure" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Creates a new OAuth2 credential provider.
", + "smithy.api#http": { + "code": 201, + "uri": "/identities/CreateOauth2CredentialProvider", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateOauth2CredentialProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the OAuth2 credential provider. The name must be unique within your account.
", + "smithy.api#required": {} + } + }, + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderVendorType", + "traits": { + "smithy.api#documentation": "The vendor of the OAuth2 credential provider. This specifies which OAuth2 implementation to use.
", + "smithy.api#required": {} + } + }, + "oauth2ProviderConfigInput": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2ProviderConfigInput", + "traits": { + "smithy.api#documentation": "The configuration settings for the OAuth2 provider, including client ID, client secret, and other vendor-specific settings.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to the OAuth2 credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateOauth2CredentialProviderResponse": { + "type": "structure", + "members": { + "clientSecretArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Secret", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.
", + "smithy.api#property": {}, + "smithy.api#required": {} + } + }, + "clientSecretJsonKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretJsonKeyType", + "traits": { + "smithy.api#documentation": "The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.
", + "smithy.api#property": {} + } + }, + "clientSecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.
The name of the OAuth2 credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OAuth2 credential provider.
", + "smithy.api#required": {} + } + }, + "callbackUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.
" + } + }, + "oauth2ProviderConfigOutput": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2ProviderConfigOutput", + "traits": { + "smithy.api#notProperty": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#Status", + "traits": { + "smithy.api#documentation": "The current status of the OAuth2 credential provider.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateOnlineEvaluationConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateOnlineEvaluationConfigRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateOnlineEvaluationConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an online evaluation configuration for continuous monitoring of agent performance. Online evaluation automatically samples live traffic from CloudWatch logs at specified rates and applies evaluators to assess agent quality in production.
", + "smithy.api#http": { + "method": "POST", + "uri": "/online-evaluation-configs/create", + "code": 202 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateOnlineEvaluationConfigRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "onlineEvaluationConfigName": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluationConfigName", + "traits": { + "smithy.api#documentation": "The name of the online evaluation configuration. Must be unique within your account.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluationConfigDescription", + "traits": { + "smithy.api#documentation": "The description of the online evaluation configuration that explains its monitoring purpose and scope.
" + } + }, + "rule": { + "target": "com.amazonaws.bedrockagentcorecontrol#Rule", + "traits": { + "smithy.api#documentation": "The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.
", + "smithy.api#required": {} + } + }, + "dataSourceConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#DataSourceConfig", + "traits": { + "smithy.api#documentation": "The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.
", + "smithy.api#required": {} + } + }, + "evaluators": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorList", + "traits": { + "smithy.api#documentation": " The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator.
The list of insight types to run against agent sessions.
" + } + }, + "clusteringConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClusteringConfig", + "traits": { + "smithy.api#documentation": "Configuration for periodic batch evaluation clustering of insight results.
" + } + }, + "evaluationExecutionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": " The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation. If the configuration references evaluators encrypted with a customer managed KMS key, this role must also have kms:Decrypt permission on the KMS key. The service validates this permission at configuration creation time. For more information, see Encryption at rest for AgentCore Evaluations.
Whether to enable the online evaluation configuration immediately upon creation. If true, evaluation begins automatically.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to an AgentCore Online Evaluation Config. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateOnlineEvaluationConfigResponse": { + "type": "structure", + "members": { + "onlineEvaluationConfigArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "onlineEvaluationConfigId": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the online evaluation configuration was created.
", + "smithy.api#required": {} + } + }, + "outputConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#OutputConfig" + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigStatus", + "traits": { + "smithy.api#documentation": "The status of the online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "executionStatus": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationExecutionStatus", + "traits": { + "smithy.api#documentation": "The execution status indicating whether the online evaluation is currently running.
", + "smithy.api#required": {} + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for failure if the online evaluation configuration creation or execution failed.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreatePaymentConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreatePaymentConnectorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreatePaymentConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new payment connector for a payment manager. A payment connector integrates with a supported payment provider to enable payment processing capabilities.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/payments/managers/{paymentManagerId}/connectors" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreatePaymentConnectorRequest": { + "type": "structure", + "members": { + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment manager to create the connector for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorName", + "traits": { + "smithy.api#documentation": "The name of the payment connector.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsDescription", + "traits": { + "smithy.api#documentation": "A description of the payment connector.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorType", + "traits": { + "smithy.api#documentation": "The type of payment connector, which determines the payment provider integration.
", + "smithy.api#required": {} + } + }, + "credentialProviderConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialsProviderConfigurations", + "traits": { + "smithy.api#documentation": "The credential provider configurations for the payment connector. These configurations specify how the connector authenticates with the payment provider.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreatePaymentConnectorResponse": { + "type": "structure", + "members": { + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created payment connector.
", + "smithy.api#required": {} + } + }, + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the parent payment manager.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorName", + "traits": { + "smithy.api#documentation": "The name of the created payment connector.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorType", + "traits": { + "smithy.api#documentation": "The type of the created payment connector.
", + "smithy.api#required": {} + } + }, + "credentialProviderConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialsProviderConfigurations", + "traits": { + "smithy.api#documentation": "The credential provider configurations for the created payment connector.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment connector was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorStatus", + "traits": { + "smithy.api#documentation": "The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
Creates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.
", + "smithy.api#http": { + "code": 201, + "uri": "/identities/CreatePaymentCredentialProvider", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreatePaymentCredentialProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "Unique name for the payment credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderVendorType", + "traits": { + "smithy.api#documentation": "The vendor type for the payment credential provider (e.g., CoinbaseCDP, StripePrivy).
", + "smithy.api#required": {} + } + }, + "providerConfigurationInput": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentProviderConfigurationInput", + "traits": { + "smithy.api#documentation": "Configuration specific to the vendor, including API credentials.
", + "smithy.api#notProperty": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "Optional tags for resource organization.
", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreatePaymentCredentialProviderResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the created payment credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderVendorType", + "traits": { + "smithy.api#documentation": "The vendor type for the created payment credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created payment credential provider.
", + "smithy.api#required": {} + } + }, + "providerConfigurationOutput": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentProviderConfigurationOutput", + "traits": { + "smithy.api#documentation": "Output configuration (contains secret ARNs, excludes actual secret values).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreatePaymentManager": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreatePaymentManagerRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreatePaymentManagerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new payment manager in your Amazon Web Services account. A payment manager serves as the top-level resource for managing payment processing capabilities, including payment connectors that integrate with supported payment providers.
If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.
The name of the payment manager.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsDescription", + "traits": { + "smithy.api#documentation": "A description of the payment manager.
" + } + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsAuthorizerType", + "traits": { + "smithy.api#documentation": "The type of authorizer to use for the payment manager.
CUSTOM_JWT - Authorize with a bearer token.
AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
The authorizer configuration for the payment manager.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that the payment manager assumes to access resources on your behalf.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to the payment manager.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreatePaymentManagerResponse": { + "type": "structure", + "members": { + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created payment manager.
", + "smithy.api#required": {} + } + }, + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created payment manager.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerName", + "traits": { + "smithy.api#documentation": "The name of the created payment manager.
", + "smithy.api#required": {} + } + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsAuthorizerType", + "traits": { + "smithy.api#documentation": "The type of authorizer for the created payment manager.
", + "smithy.api#required": {} + } + }, + "authorizerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration" + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with the created payment manager.
", + "smithy.api#required": {} + } + }, + "workloadIdentityDetails": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails" + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment manager was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerStatus", + "traits": { + "smithy.api#documentation": "The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
The tags associated with the created payment manager.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreatePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreatePolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreatePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a policy within the AgentCore Policy system. Policies provide real-time, deterministic control over agentic interactions with AgentCore Gateway. Using the Cedar policy language, you can define fine-grained policies that specify which interactions with Gateway tools are permitted based on input parameters and OAuth claims, ensuring agents operate within defined boundaries and business rules. The policy is validated during creation against the Cedar schema generated from the Gateway's tools' input schemas, which defines the available tools, their parameters, and expected data types. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.
Creates a new policy engine within the AgentCore Policy system. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with Gateways (each Gateway can be associated with at most one policy engine, but multiple Gateways can be associated with the same engine), the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.
The customer-assigned immutable name for the policy engine. This name identifies the policy engine and cannot be changed after creation.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "A human-readable description of the policy engine's purpose and scope (1-4,096 characters). This helps administrators understand the policy engine's role in the overall governance strategy. Document which Gateway this engine will be associated with, what types of tools or workflows it governs, and the team or service responsible for maintaining it. Clear descriptions are essential when managing multiple policy engines across different services or environments.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy engine.
", + "smithy.api#idempotencyToken": {} + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to an AgentCore Policy. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreatePolicyEngineResponse": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier for the created policy engine. This system-generated identifier consists of the user name plus a 10-character generated suffix and is used for all subsequent policy engine operations.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineName", + "traits": { + "smithy.api#documentation": "The customer-assigned name of the created policy engine. This matches the name provided in the request and serves as the human-readable identifier.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy engine was created. This is automatically set by the service and used for auditing and lifecycle management.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy engine was last updated. For newly created policy engines, this matches the createdAt timestamp.
The Amazon Resource Name (ARN) of the created policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineStatus", + "traits": { + "smithy.api#documentation": "The current status of the policy engine. A status of ACTIVE indicates the policy engine is ready for use.
The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "A human-readable description of the policy engine's purpose.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine creation process.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreatePolicyRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyName", + "traits": { + "smithy.api#documentation": "The customer-assigned immutable name for the policy. Must be unique within the account. This name is used for policy identification and cannot be changed after creation.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyDefinition", + "traits": { + "smithy.api#documentation": "The Cedar policy statement that defines the access control rules. This contains the actual policy logic written in Cedar policy language, specifying effect (permit or forbid), principals, actions, resources, and conditions for agent behavior control.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "A human-readable description of the policy's purpose and functionality (1-4,096 characters). This helps policy administrators understand the policy's intent, business rules, and operational scope. Use this field to document why the policy exists, what business requirement it addresses, and any special considerations for maintenance. Clear descriptions are essential for policy governance, auditing, and troubleshooting.
" + } + }, + "validationMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyValidationMode", + "traits": { + "smithy.api#default": "FAIL_ON_ANY_FINDINGS", + "smithy.api#documentation": "The validation mode for the policy creation. Determines how Cedar analyzer validation results are handled during policy creation. FAIL_ON_ANY_FINDINGS (default) runs the Cedar analyzer to validate the policy against the Cedar schema and tool context, failing creation if the analyzer detects any validation issues to ensure strict conformance. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows policy creation even if validation issues are detected, useful for testing or when the policy schema is evolving. Use FAIL_ON_ANY_FINDINGS for production policies to ensure correctness, and IGNORE_ALL_FINDINGS only when you understand and accept the analyzer findings.
" + } + }, + "enforcementMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnforcementMode", + "traits": { + "smithy.api#default": "ACTIVE", + "smithy.api#documentation": "The enforcement mode for the policy. Run this policy in LOG_ONLY mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to ACTIVE. Defaults to ACTIVE.
The identifier of the policy engine which contains this policy. Policy engines group related policies and provide the execution context for policy evaluation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreatePolicyResponse": { + "type": "structure", + "members": { + "policyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier for the created policy. This is a system-generated identifier consisting of the user name plus a 10-character generated suffix, used for all subsequent policy operations.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyName", + "traits": { + "smithy.api#documentation": "The customer-assigned name of the created policy. This matches the name provided in the request and serves as the human-readable identifier for the policy.
", + "smithy.api#required": {} + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine that manages this policy. This confirms the policy engine assignment and is used for policy evaluation routing.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was created. This is automatically set by the service and used for auditing and lifecycle management.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was last updated. For newly created policies, this matches the createdAt timestamp.
", + "smithy.api#required": {} + } + }, + "policyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created policy. This globally unique identifier can be used for cross-service references and IAM policy statements.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatus", + "traits": { + "smithy.api#documentation": "The current status of the policy. A status of ACTIVE indicates the policy is ready for use.
The enforcement mode of the created policy.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyDefinition", + "traits": { + "smithy.api#documentation": "The Cedar policy statement that was created. This is the validated policy definition that will be used for agent behavior control and access decisions.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the policy status. This provides details about any failures or the current state of the policy creation process.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateRegistry": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateRegistryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateRegistryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new registry in your Amazon Web Services account. A registry serves as a centralized catalog for organizing and managing registry records, including MCP servers, A2A agents, agent skills, and custom resource types.
If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.
Creates a new registry record within the specified registry. A registry record represents an individual AI resource's metadata in the registry. This could be an MCP server (and associated tools), A2A agent, agent skill, or a custom resource with a custom schema.
The record is processed asynchronously and returns HTTP 202 Accepted.
", + "smithy.api#http": { + "method": "POST", + "uri": "/registries/{registryId}/records", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateRegistryRecordRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the registry where the record will be created. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordName", + "traits": { + "smithy.api#documentation": "The name of the registry record.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "A description of the registry record.
" + } + }, + "descriptorType": { + "target": "com.amazonaws.bedrockagentcorecontrol#DescriptorType", + "traits": { + "smithy.api#documentation": "The descriptor type of the registry record.
MCP - Model Context Protocol descriptor for MCP-compatible servers and tools.
A2A - Agent-to-Agent protocol descriptor.
CUSTOM - Custom descriptor type for resources such as APIs, Lambda functions, or servers not conforming to a standard protocol.
AGENT_SKILLS - Agent skills descriptor for defining agent skill definitions.
The descriptor-type-specific configuration containing the resource schema and metadata. The structure of this field depends on the descriptorType you specify.
The version of the registry record. Use this to track different versions of the record's content.
" + } + }, + "synchronizationType": { + "target": "com.amazonaws.bedrockagentcorecontrol#SynchronizationType", + "traits": { + "smithy.api#documentation": "The type of synchronization to use for keeping the record metadata up to date from an external source. Possible values include FROM_URL and NONE.
The configuration for synchronizing registry record metadata from an external source, such as a URL-based MCP server.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateRegistryRecordResponse": { + "type": "structure", + "members": { + "recordArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created registry record.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordStatus", + "traits": { + "smithy.api#documentation": "The status of the registry record. Set to CREATING while the asynchronous workflow is in progress.
The name of the registry. The name must be unique within your account and can contain alphanumeric characters and underscores.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "A description of the registry.
" + } + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryAuthorizerType", + "traits": { + "smithy.api#documentation": "The type of authorizer to use for the registry. This controls the authorization method for the Search and Invoke APIs used by consumers, and does not affect the standard CRUDL APIs for registry and registry record management used by administrators.
CUSTOM_JWT - Authorize with a bearer token.
AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
The authorizer configuration for the registry. Required if authorizerType is CUSTOM_JWT. For details, see the AuthorizerConfiguration data type.
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "approvalConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApprovalConfiguration", + "traits": { + "smithy.api#documentation": "The approval configuration for registry records. Controls whether records require explicit approval before becoming active. See the ApprovalConfiguration data type for supported configuration options.
The Amazon Resource Name (ARN) of the created registry.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateWorkloadIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateWorkloadIdentityRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateWorkloadIdentityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Creates a new workload identity.
", + "smithy.api#http": { + "code": 201, + "uri": "/identities/CreateWorkloadIdentity", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateWorkloadIdentityRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameType", + "traits": { + "smithy.api#documentation": "The name of the workload identity. The name must be unique within your account.
", + "smithy.api#required": {} + } + }, + "allowedResourceOauth2ReturnUrls": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceOauth2ReturnUrlListType", + "traits": { + "smithy.api#documentation": "The list of allowed OAuth2 return URLs for resources associated with this workload identity.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to assign to the workload identity. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CreateWorkloadIdentityResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameType", + "traits": { + "smithy.api#documentation": "The name of the workload identity.
", + "smithy.api#required": {} + } + }, + "workloadIdentityArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the workload identity.
", + "smithy.api#required": {} + } + }, + "allowedResourceOauth2ReturnUrls": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceOauth2ReturnUrlListType", + "traits": { + "smithy.api#documentation": "The list of allowed OAuth2 return URLs for resources associated with this workload identity.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#CredentialProvider": { + "type": "union", + "members": { + "oauthCredentialProvider": { + "target": "com.amazonaws.bedrockagentcorecontrol#OAuthCredentialProvider", + "traits": { + "smithy.api#documentation": "The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.
" + } + }, + "apiKeyCredentialProvider": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayApiKeyCredentialProvider", + "traits": { + "smithy.api#documentation": "The API key credential provider. This provider uses an API key to authenticate with the target endpoint.
" + } + }, + "iamCredentialProvider": { + "target": "com.amazonaws.bedrockagentcorecontrol#IamCredentialProvider", + "traits": { + "smithy.api#documentation": "The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CredentialProviderArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:.*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CredentialProviderArnType": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::OAuth2CredentialProvider" + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/oauth2credentialprovider/[a-zA-Z0-9-.]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CredentialProviderConfiguration": { + "type": "structure", + "members": { + "credentialProviderType": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderType", + "traits": { + "smithy.api#documentation": "The type of credential provider. This field specifies which authentication method the gateway uses.
", + "smithy.api#required": {} + } + }, + "credentialProvider": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProvider", + "traits": { + "smithy.api#documentation": "The credential provider. This field contains the specific configuration for the credential provider type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CredentialProviderConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-_]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CredentialProviderType": { + "type": "enum", + "members": { + "GATEWAY_IAM_ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GATEWAY_IAM_ROLE" + } + }, + "OAUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH" + } + }, + "API_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_KEY" + } + }, + "CALLER_IAM_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALLER_IAM_CREDENTIALS" + } + }, + "JWT_PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JWT_PASSTHROUGH" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#CredentialProviderVendorType": { + "type": "enum", + "members": { + "GoogleOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GoogleOauth2" + } + }, + "GithubOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GithubOauth2" + } + }, + "SlackOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SlackOauth2" + } + }, + "SalesforceOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SalesforceOauth2" + } + }, + "MicrosoftOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MicrosoftOauth2" + } + }, + "CustomOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CustomOauth2" + } + }, + "AtlassianOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AtlassianOauth2" + } + }, + "LinkedinOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LinkedinOauth2" + } + }, + "XOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XOauth2" + } + }, + "OktaOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OktaOauth2" + } + }, + "OneLoginOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OneLoginOauth2" + } + }, + "PingOneOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PingOneOauth2" + } + }, + "FacebookOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FacebookOauth2" + } + }, + "YandexOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YandexOauth2" + } + }, + "RedditOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RedditOauth2" + } + }, + "ZoomOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZoomOauth2" + } + }, + "TwitchOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TwitchOauth2" + } + }, + "SpotifyOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SpotifyOauth2" + } + }, + "DropboxOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DropboxOauth2" + } + }, + "NotionOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotionOauth2" + } + }, + "HubspotOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HubspotOauth2" + } + }, + "CyberArkOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CyberArkOauth2" + } + }, + "FusionAuthOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FusionAuthOauth2" + } + }, + "Auth0Oauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Auth0Oauth2" + } + }, + "CognitoOauth2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CognitoOauth2" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#CredentialsProviderConfiguration": { + "type": "union", + "members": { + "coinbaseCDP": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderConfiguration", + "traits": { + "smithy.api#documentation": "The credential provider configuration for a Coinbase CDP payment connector.
" + } + }, + "stripePrivy": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderConfiguration", + "traits": { + "smithy.api#documentation": "The credential provider configuration for a Stripe Privy payment connector.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The credential provider configuration for a payment connector. Specifies the payment provider type and its associated credential provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CredentialsProviderConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialsProviderConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomClaimValidationType": { + "type": "structure", + "members": { + "inboundTokenClaimName": { + "target": "com.amazonaws.bedrockagentcorecontrol#InboundTokenClaimNameType", + "traits": { + "smithy.api#documentation": "The name of the custom claim field to check.
", + "smithy.api#required": {} + } + }, + "inboundTokenClaimValueType": { + "target": "com.amazonaws.bedrockagentcorecontrol#InboundTokenClaimValueType", + "traits": { + "smithy.api#documentation": "The data type of the claim value to check for.
Use STRING if you want to find an exact match to a string you define.
Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.
Defines the value or values to match for and the relationship of the match.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the name of a custom claim field and rules for finding matches to authenticate its value.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomClaimValidationsType": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomClaimValidationType" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomConfigurationInput": { + "type": "union", + "members": { + "semanticOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#SemanticOverrideConfigurationInput", + "traits": { + "smithy.api#documentation": "The semantic override configuration for a custom memory strategy.
" + } + }, + "summaryOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#SummaryOverrideConfigurationInput", + "traits": { + "smithy.api#documentation": "The summary override configuration for a custom memory strategy.
" + } + }, + "userPreferenceOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#UserPreferenceOverrideConfigurationInput", + "traits": { + "smithy.api#documentation": "The user preference override configuration for a custom memory strategy.
" + } + }, + "episodicOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicOverrideConfigurationInput", + "traits": { + "smithy.api#documentation": "The episodic memory strategy override configuration for a custom memory strategy.
" + } + }, + "selfManagedConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#SelfManagedConfigurationInput", + "traits": { + "smithy.api#documentation": "The self managed configuration for a custom memory strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for custom configuration of a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomConsolidationConfiguration": { + "type": "union", + "members": { + "semanticConsolidationOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#SemanticConsolidationOverride", + "traits": { + "smithy.api#documentation": "The semantic consolidation override configuration.
" + } + }, + "summaryConsolidationOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#SummaryConsolidationOverride", + "traits": { + "smithy.api#documentation": "The summary consolidation override configuration.
" + } + }, + "userPreferenceConsolidationOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#UserPreferenceConsolidationOverride", + "traits": { + "smithy.api#documentation": "The user preference consolidation override configuration.
" + } + }, + "episodicConsolidationOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicConsolidationOverride", + "traits": { + "smithy.api#documentation": "The configurations to override the default consolidation step for the episodic memory strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains custom consolidation configuration information.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomConsolidationConfigurationInput": { + "type": "union", + "members": { + "semanticConsolidationOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#SemanticOverrideConsolidationConfigurationInput", + "traits": { + "smithy.api#documentation": "The semantic consolidation override configuration input.
" + } + }, + "summaryConsolidationOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#SummaryOverrideConsolidationConfigurationInput", + "traits": { + "smithy.api#documentation": "The summary consolidation override configuration input.
" + } + }, + "userPreferenceConsolidationOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#UserPreferenceOverrideConsolidationConfigurationInput", + "traits": { + "smithy.api#documentation": "The user preference consolidation override configuration input.
" + } + }, + "episodicConsolidationOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicOverrideConsolidationConfigurationInput", + "traits": { + "smithy.api#documentation": "Configurations to override the consolidation step of the episodic strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for a custom consolidation configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomDescriptor": { + "type": "structure", + "members": { + "inlineContent": { + "target": "com.amazonaws.bedrockagentcorecontrol#InlineContent", + "traits": { + "smithy.api#documentation": "The custom descriptor content as a valid JSON document. You can define any custom schema that describes your resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A custom descriptor for a registry record. Use this for resources such as APIs, Lambda functions, or servers that do not conform to a standard protocol like MCP or A2A.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomEvaluatorArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::Evaluator" + }, + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomEvaluatorName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomExtractionConfiguration": { + "type": "union", + "members": { + "semanticExtractionOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#SemanticExtractionOverride", + "traits": { + "smithy.api#documentation": "The semantic extraction override configuration.
" + } + }, + "userPreferenceExtractionOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#UserPreferenceExtractionOverride", + "traits": { + "smithy.api#documentation": "The user preference extraction override configuration.
" + } + }, + "episodicExtractionOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicExtractionOverride", + "traits": { + "smithy.api#documentation": "The configurations to override the default extraction step for the episodic memory strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains custom extraction configuration information.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomExtractionConfigurationInput": { + "type": "union", + "members": { + "semanticExtractionOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#SemanticOverrideExtractionConfigurationInput", + "traits": { + "smithy.api#documentation": "The semantic extraction override configuration input.
" + } + }, + "userPreferenceExtractionOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#UserPreferenceOverrideExtractionConfigurationInput", + "traits": { + "smithy.api#documentation": "The user preference extraction override configuration input.
" + } + }, + "episodicExtractionOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicOverrideExtractionConfigurationInput", + "traits": { + "smithy.api#documentation": "Configurations to override the extraction step of the episodic strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for a custom extraction configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomJWTAuthorizerConfiguration": { + "type": "structure", + "members": { + "discoveryUrl": { + "target": "com.amazonaws.bedrockagentcorecontrol#DiscoveryUrl", + "traits": { + "smithy.api#documentation": "This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.
", + "smithy.api#required": {} + } + }, + "allowedAudience": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedAudienceList", + "traits": { + "smithy.api#documentation": "Represents individual audience values that are validated in the incoming JWT token validation process.
" + } + }, + "allowedClients": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedClientsList", + "traits": { + "smithy.api#documentation": "Represents individual client IDs that are validated in the incoming JWT token validation process.
" + } + }, + "allowedScopes": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedScopesType", + "traits": { + "smithy.api#documentation": "An array of scopes that are allowed to access the token.
" + } + }, + "advertisedScopeMapping": { + "target": "com.amazonaws.bedrockagentcorecontrol#AdvertisedScopeMappingType", + "traits": { + "smithy.api#documentation": "A map that associates each scope in allowedScopes with a corresponding advertised scope value. The advertised scope appears in OAuth protected resource metadata and WWW-Authenticate response headers. Use this parameter when the scope that clients request from your identity provider differs from the scope in the validated token. Each key is a scope from allowedScopes that the service uses for token validation. Each value is the corresponding scope that the service advertises to clients. Scopes without a mapping entry appear unchanged to clients.
An array of objects that define a custom claim validation name, value, and operation
" + } + }, + "privateEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpoint" + }, + "privateEndpointOverrides": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointOverrides", + "traits": { + "smithy.api#documentation": "The private endpoint overrides for the custom JWT authorizer configuration.
" + } + }, + "allowedWorkloadConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedWorkloadConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that restricts which workloads in the request's identity chain are allowed to invoke the target, identified by their hosting environments and workload identities. At launch, this is supported only for AgentCore Runtime targets, and the allowed workloads are AgentCore Gateways.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for inbound JWT-based authorization, specifying how incoming requests should be authenticated.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomMemoryStrategyInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#Name", + "traits": { + "smithy.api#documentation": "The name of the custom memory strategy.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the custom memory strategy.
" + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#deprecated": { + "message": "Use namespaceTemplates instead", + "since": "2026-03-02" + }, + "smithy.api#documentation": "This is a legacy parameter, use namespaceTemplates. The namespaces associated with the custom memory strategy.
The namespaceTemplates associated with the custom memory strategy.
" + } + }, + "configuration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomConfigurationInput", + "traits": { + "smithy.api#documentation": "The configuration for the custom memory strategy.
" + } + }, + "memoryRecordSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryRecordSchema", + "traits": { + "smithy.api#documentation": "Schema for metadata fields on records generated by this strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for creating a custom memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomOauth2ProviderConfigInput": { + "type": "structure", + "members": { + "oauthDiscovery": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2Discovery", + "traits": { + "smithy.api#documentation": "The OAuth2 discovery information for the custom provider.
", + "smithy.api#required": {} + } + }, + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultClientIdType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The client ID for the custom OAuth2 provider.
" + } + }, + "clientSecret": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultClientSecretType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The client secret for the custom OAuth2 provider.
" + } + }, + "clientSecretConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretReference", + "traits": { + "smithy.api#documentation": "A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.
The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
The configuration for on-behalf-of token exchange. This enables authentication flows that use RFC 8693 token exchange or RFC 7523 JWT authorization grants.
" + } + }, + "clientAuthenticationMethod": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientAuthenticationMethodType", + "traits": { + "smithy.api#documentation": "The client authentication method to use when authenticating with the token endpoint.
" + } + }, + "privateKeyJwtConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateKeyJwtConfig" + }, + "privateEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpoint", + "traits": { + "smithy.api#documentation": "The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.
" + } + }, + "privateEndpointOverrides": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointOverrides", + "traits": { + "smithy.api#documentation": "The private endpoint overrides for the custom OAuth2 provider configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input configuration for a custom OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomOauth2ProviderConfigOutput": { + "type": "structure", + "members": { + "oauthDiscovery": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2Discovery", + "traits": { + "smithy.api#documentation": "The OAuth2 discovery information for the custom provider.
", + "smithy.api#required": {} + } + }, + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the custom OAuth2 provider.
" + } + }, + "onBehalfOfTokenExchangeConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnBehalfOfTokenExchangeConfigType", + "traits": { + "smithy.api#documentation": "The configuration for on-behalf-of token exchange.
" + } + }, + "clientAuthenticationMethod": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientAuthenticationMethodType", + "traits": { + "smithy.api#documentation": "The client authentication method used when authenticating with the token endpoint.
" + } + }, + "privateEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpoint", + "traits": { + "smithy.api#documentation": "The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.
" + } + }, + "privateEndpointOverrides": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointOverrides", + "traits": { + "smithy.api#documentation": "The private endpoint overrides for the custom OAuth2 provider configuration.
" + } + }, + "privateKeyJwtConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateKeyJwtConfig" + } + }, + "traits": { + "smithy.api#documentation": "Output configuration for a custom OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomParameterMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomReflectionConfiguration": { + "type": "union", + "members": { + "episodicReflectionOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicReflectionOverride", + "traits": { + "smithy.api#documentation": "The configuration for a reflection strategy to override the default one.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a custom reflection strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomReflectionConfigurationInput": { + "type": "union", + "members": { + "episodicReflectionOverride": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicOverrideReflectionConfigurationInput", + "traits": { + "smithy.api#documentation": "The reflection override configuration input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for a custom reflection configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#CustomTransformConfiguration": { + "type": "structure", + "members": { + "lambda": { + "target": "com.amazonaws.bedrockagentcorecontrol#LambdaTransformConfiguration", + "traits": { + "smithy.api#documentation": "The Lambda configuration for custom transformations. This configuration defines how the gateway uses a Lambda function to transform data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for custom transformations applied to requests and responses through the gateway. This structure defines how the gateway transforms data.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DataSourceConfig": { + "type": "union", + "members": { + "cloudWatchLogs": { + "target": "com.amazonaws.bedrockagentcorecontrol#CloudWatchLogsInputConfig", + "traits": { + "smithy.api#documentation": "The CloudWatch logs configuration for reading agent traces from log groups.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that specifies where to read agent traces for online evaluation.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DataSourceType": { + "type": "union", + "members": { + "inlineExamples": { + "target": "com.amazonaws.bedrockagentcorecontrol#InlineExamplesSource", + "traits": { + "smithy.api#documentation": "Inline examples provided directly in the request body.
" + } + }, + "s3Source": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3Source", + "traits": { + "smithy.api#documentation": "Amazon S3 URI pointing to a JSONL file in the customer's bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Source of examples to add to the dataset.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Dataset": { + "type": "resource", + "identifiers": { + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateDataset" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetDataset" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateDataset" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteDataset" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListDatasets" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AddDatasetExamples" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateDatasetVersion" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteDatasetExamples" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListDatasetExamples" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListDatasetVersions" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateDatasetExamples" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#DatasetArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[a-z]+)*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:dataset/[a-zA-Z0-9_-]{1,110}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DatasetExampleList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#SensitiveJson" + }, + "traits": { + "smithy.api#documentation": "A list of dataset examples. Each element is a free-form JSON document whose structure is defined by the dataset's schema type.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DatasetId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,110}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DatasetName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DatasetSchemaType": { + "type": "enum", + "members": { + "AGENTCORE_EVALUATION_PREDEFINED_V1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "AgentCore predefined evaluation schema, version 1. Dataset with pre-written inputs per conversation turn.
", + "smithy.api#enumValue": "AGENTCORE_EVALUATION_PREDEFINED_V1" + } + }, + "AGENTCORE_EVALUATION_SIMULATED_V1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "AgentCore simulated evaluation schema, version 1. Dataset for synthetic data generation where each example is a scenario used to generate full conversations.
", + "smithy.api#enumValue": "AGENTCORE_EVALUATION_SIMULATED_V1" + } + } + }, + "traits": { + "smithy.api#documentation": "Versioned schema type for dataset examples. Each value identifies both the source format and the version of that format's schema.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DatasetStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "CreateDataset async ingestion in progress. All writes are blocked.
", + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "An async example mutation or CreateDatasetVersion is in progress. All writes are blocked.
", + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Full or version-specific delete is in progress. Read operations are still allowed.
", + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Dataset is stable. All operations are allowed per operation-specific guards.
", + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Initial ingestion failed. DRAFT record exists but contains no examples.
", + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Last example mutation or CreateDatasetVersion failed. DRAFT may be partially modified.
", + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Delete failed after retries. Dataset record may be in an inconsistent state.
", + "smithy.api#enumValue": "DELETE_FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "Dataset lifecycle and operation status.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DatasetSummary": { + "type": "structure", + "members": { + "datasetArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
", + "smithy.api#required": {} + } + }, + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset.
", + "smithy.api#required": {} + } + }, + "datasetName": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the dataset.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetStatus", + "traits": { + "smithy.api#documentation": "The current status of the dataset.
", + "smithy.api#required": {} + } + }, + "draftStatus": { + "target": "com.amazonaws.bedrockagentcorecontrol#DraftStatus", + "traits": { + "smithy.api#documentation": "Publish synchronization state. Only authoritative when status is ACTIVE.
" + } + }, + "schemaType": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetSchemaType", + "traits": { + "smithy.api#documentation": "The schema type of the dataset.
", + "smithy.api#required": {} + } + }, + "exampleCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of examples in the dataset.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the dataset was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the dataset was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a dataset.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DatasetSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DatasetVersion": { + "type": "string", + "traits": { + "smithy.api#documentation": "Dataset version identifier. Accepts \"DRAFT\" or a non-negative integer string representing a published version number.
", + "smithy.api#pattern": "^(DRAFT|[0-9]+)$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DatasetVersionSummary": { + "type": "structure", + "members": { + "datasetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetVersion", + "traits": { + "smithy.api#documentation": "The version number of this published snapshot.
", + "smithy.api#required": {} + } + }, + "exampleCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of examples in this version.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this version was published.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a published dataset version.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DatasetVersionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetVersionSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DateTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DecryptionFailure": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Exception thrown when decryption of a secret fails.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagentcorecontrol#DefaultApiKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 65536 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DefaultClientIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#DefaultClientSecretType": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DefaultCoinbaseCdpApiKeySecretType": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9+/=\\-_\\s]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DefaultCoinbaseCdpWalletSecretType": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9+/=\\-_\\s]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DefaultStripePrivyAppSecretType": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9+/=\\-_\\s]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DefaultStripePrivyAuthorizationPrivateKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(wallet-auth:)?[a-zA-Z0-9+/=\\-_\\s]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#Definition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntime": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntimeRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntimeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon Bedrock AgentCore Runtime.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/runtimes/{agentRuntimeId}/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntimeEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntimeEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntimeEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an AAgentCore Runtime endpoint.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/runtimes/{agentRuntimeId}/runtime-endpoints/{endpointName}/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntimeEndpointRequest": { + "type": "structure", + "members": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime associated with the endpoint.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "endpointName": { + "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the AgentCore Runtime endpoint to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntimeEndpointResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointStatus", + "traits": { + "smithy.api#documentation": "The current status of the AgentCore Runtime endpoint deletion.
", + "smithy.api#required": {} + } + }, + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime.
" + } + }, + "endpointName": { + "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the AgentCore Runtime endpoint.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntimeRequest": { + "type": "structure", + "members": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntimeResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeStatus", + "traits": { + "smithy.api#documentation": "The current status of the AgentCore Runtime deletion.
", + "smithy.api#required": {} + } + }, + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteApiKeyCredentialProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteApiKeyCredentialProviderRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteApiKeyCredentialProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Deletes an API key credential provider.
", + "smithy.api#http": { + "code": 204, + "uri": "/identities/DeleteApiKeyCredentialProvider", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteApiKeyCredentialProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the API key credential provider to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteApiKeyCredentialProviderResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteBrowser": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteBrowserRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteBrowserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a custom browser.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/browsers/{browserId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteBrowserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteBrowserProfileRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteBrowserProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a browser profile.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/browser-profiles/{profileId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteBrowserProfileRequest": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser profile to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteBrowserProfileResponse": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted browser profile.
", + "smithy.api#required": {} + } + }, + "profileArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted browser profile.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileStatus", + "traits": { + "smithy.api#documentation": "The current status of the browser profile deletion.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser profile was last updated.
", + "smithy.api#required": {} + } + }, + "lastSavedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when browser session data was last saved to this profile before deletion.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteBrowserRequest": { + "type": "structure", + "members": { + "browserId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteBrowserResponse": { + "type": "structure", + "members": { + "browserId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted browser.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserStatus", + "traits": { + "smithy.api#documentation": "The current status of the browser deletion.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteCodeInterpreter": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteCodeInterpreterRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteCodeInterpreterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a custom code interpreter.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/code-interpreters/{codeInterpreterId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteCodeInterpreterRequest": { + "type": "structure", + "members": { + "codeInterpreterId": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterId", + "traits": { + "smithy.api#documentation": "The unique identifier of the code interpreter to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteCodeInterpreterResponse": { + "type": "structure", + "members": { + "codeInterpreterId": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted code interpreter.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterStatus", + "traits": { + "smithy.api#documentation": "The current status of the code interpreter deletion.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the code interpreter was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteConfigurationBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteConfigurationBundleRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteConfigurationBundleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a configuration bundle and all of its versions.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/configuration-bundles/{bundleId}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteConfigurationBundleRequest": { + "type": "structure", + "members": { + "bundleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the configuration bundle to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteConfigurationBundleResponse": { + "type": "structure", + "members": { + "bundleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted configuration bundle.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleStatus", + "traits": { + "smithy.api#documentation": "The status of the configuration bundle deletion operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteDatasetRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": " Deletes a dataset version or an entire dataset asynchronously. If datasetVersion is absent, deletes all versions and the dataset record itself. If provided, deletes only that specific version.
Deletes specific examples by ID from DRAFT. All example IDs are validated before any deletes occur. If any ID does not exist in DRAFT, the entire batch is rejected (all-or-nothing semantics).
", + "smithy.api#http": { + "method": "POST", + "uri": "/datasets/{datasetId}/examples/delete", + "code": 202 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteDatasetExamplesRequest": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "exampleIds": { + "target": "com.amazonaws.bedrockagentcorecontrol#ExampleIdList", + "traits": { + "smithy.api#documentation": "The IDs of the examples to delete.
", + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteDatasetExamplesResponse": { + "type": "structure", + "members": { + "datasetArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
", + "smithy.api#required": {} + } + }, + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetStatus", + "traits": { + "smithy.api#documentation": "The current status of the dataset.
", + "smithy.api#required": {} + } + }, + "deletedCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of examples deleted.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the examples were deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteDatasetRequest": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "datasetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetVersion", + "traits": { + "smithy.api#documentation": "Optional version to delete. If absent, deletes the entire dataset. If provided, deletes only that specific version.
", + "smithy.api#httpQuery": "datasetVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteDatasetResponse": { + "type": "structure", + "members": { + "datasetArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
", + "smithy.api#required": {} + } + }, + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetStatus", + "traits": { + "smithy.api#documentation": "The current status of the dataset after the delete request.
", + "smithy.api#required": {} + } + }, + "datasetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetVersion", + "traits": { + "smithy.api#documentation": "The version that was deleted.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the delete was initiated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteEvaluator": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteEvaluatorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteEvaluatorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a custom evaluator. Builtin evaluators cannot be deleted. The evaluator must not be referenced by any active online evaluation configurations.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/evaluators/{evaluatorId}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteEvaluatorRequest": { + "type": "structure", + "members": { + "evaluatorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the evaluator to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteEvaluatorResponse": { + "type": "structure", + "members": { + "evaluatorArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted evaluator.
", + "smithy.api#required": {} + } + }, + "evaluatorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted evaluator.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorStatus", + "traits": { + "smithy.api#documentation": "The status of the evaluator deletion operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a gateway.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/gateways/{gatewayIdentifier}/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayRequest": { + "type": "structure", + "members": { + "gatewayIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the gateway to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayResponse": { + "type": "structure", + "members": { + "gatewayId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted gateway.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayStatus", + "traits": { + "smithy.api#documentation": "The current status of the gateway deletion.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", + "traits": { + "smithy.api#documentation": "The reasons for the current status of the gateway deletion.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayRuleRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a gateway rule.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/gateways/{gatewayIdentifier}/rules/{ruleId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayRuleRequest": { + "type": "structure", + "members": { + "gatewayIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the gateway containing the rule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ruleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the rule to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayRuleResponse": { + "type": "structure", + "members": { + "ruleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted rule.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleStatus", + "traits": { + "smithy.api#documentation": "The status of the rule deletion operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayTargetRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a gateway target.
You cannot delete a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before deleting the target.
The unique identifier of the gateway associated with the target.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "targetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the gateway target to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayTargetResponse": { + "type": "structure", + "members": { + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway.
", + "smithy.api#required": {} + } + }, + "targetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted gateway target.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetStatus", + "traits": { + "smithy.api#documentation": "The current status of the gateway target deletion.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", + "traits": { + "smithy.api#documentation": "The reasons for the current status of the gateway target deletion.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteHarness": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteHarnessRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteHarnessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Operation to delete a Harness.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/harnesses/{harnessId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteHarnessEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteHarnessEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteHarnessEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Operation to delete a harness endpoint.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/harnesses/{harnessId}/endpoints/{endpointName}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteHarnessEndpointRequest": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness that the endpoint belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "endpointName": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointName", + "traits": { + "smithy.api#documentation": "The name of the endpoint to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteHarnessEndpointResponse": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint that was deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteHarnessRequest": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + }, + "deleteManagedMemory": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to delete the managed memory on harness deletion. Default: true. If false, the memory is disassociated and becomes a regular customer-owned resource.
", + "smithy.api#httpQuery": "deleteManagedMemory" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteHarnessResponse": { + "type": "structure", + "members": { + "harness": { + "target": "com.amazonaws.bedrockagentcorecontrol#Harness", + "traits": { + "smithy.api#documentation": "The harness that was deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteMemory": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteMemoryInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteMemoryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon Bedrock AgentCore Memory resource.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/memories/{memoryId}/delete" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteMemoryInput": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NonEmptyString", + "traits": { + "smithy.api#documentation": "A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique AWS identifier.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#length": { + "max": 500 + } + } + }, + "memoryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the memory to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteMemoryOutput": { + "type": "structure", + "members": { + "memoryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted AgentCore Memory resource.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryStatus", + "traits": { + "smithy.api#documentation": "The current status of the AgentCore Memory resource deletion.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteMemoryStrategiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteMemoryStrategyInput" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteMemoryStrategyInput": { + "type": "structure", + "members": { + "memoryStrategyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the memory strategy to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for deleting a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteOauth2CredentialProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteOauth2CredentialProviderRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteOauth2CredentialProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Deletes an OAuth2 credential provider.
", + "smithy.api#http": { + "code": 204, + "uri": "/identities/DeleteOauth2CredentialProvider", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteOauth2CredentialProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the OAuth2 credential provider to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteOauth2CredentialProviderResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteOnlineEvaluationConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteOnlineEvaluationConfigRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteOnlineEvaluationConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an online evaluation configuration and stops any ongoing evaluation processes associated with it.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/online-evaluation-configs/{onlineEvaluationConfigId}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteOnlineEvaluationConfigRequest": { + "type": "structure", + "members": { + "onlineEvaluationConfigId": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigId", + "traits": { + "smithy.api#documentation": "The unique identifier of the online evaluation configuration to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteOnlineEvaluationConfigResponse": { + "type": "structure", + "members": { + "onlineEvaluationConfigArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "onlineEvaluationConfigId": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigStatus", + "traits": { + "smithy.api#documentation": "The status of the online evaluation configuration deletion operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePaymentConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePaymentConnectorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePaymentConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a payment connector.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/payments/managers/{paymentManagerId}/connectors/{paymentConnectorId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePaymentConnectorRequest": { + "type": "structure", + "members": { + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the parent payment manager.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment connector to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePaymentConnectorResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorStatus", + "traits": { + "smithy.api#documentation": "The current status of the payment connector, set to DELETING when deletion is initiated. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
The unique identifier of the deleted payment connector.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePaymentCredentialProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePaymentCredentialProviderRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePaymentCredentialProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Deletes a payment credential provider and its associated stored credentials.
", + "smithy.api#http": { + "code": 204, + "uri": "/identities/DeletePaymentCredentialProvider", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePaymentCredentialProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the payment credential provider to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePaymentCredentialProviderResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePaymentManager": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePaymentManagerRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePaymentManagerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a payment manager. All payment connectors associated with the payment manager must be deleted before the payment manager can be deleted. This operation initiates the deletion process asynchronously.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/payments/managers/{paymentManagerId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePaymentManagerRequest": { + "type": "structure", + "members": { + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment manager to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePaymentManagerResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerStatus", + "traits": { + "smithy.api#documentation": "The current status of the payment manager, set to DELETING when deletion is initiated. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
The unique identifier of the deleted payment manager.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing policy from the AgentCore Policy system. Once deleted, the policy can no longer be used for agent behavior control and all references to it become invalid. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.
Deletes an existing policy engine from the AgentCore Policy system. The policy engine must not have any associated policies before deletion. Once deleted, the policy engine and all its configurations become unavailable for policy management and evaluation. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.
The unique identifier of the policy engine to be deleted. This must be a valid policy engine ID that exists within the account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePolicyEngineResponse": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy engine being deleted. This confirms which policy engine the deletion operation targets.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineName", + "traits": { + "smithy.api#documentation": "The customer-assigned name of the deleted policy engine.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the deleted policy engine was originally created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the deleted policy engine was last modified before deletion. This tracks the final state of the policy engine before it was removed from the system.
", + "smithy.api#required": {} + } + }, + "policyEngineArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted policy engine. This globally unique identifier confirms which policy engine resource was successfully removed.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineStatus", + "traits": { + "smithy.api#documentation": "The status of the policy engine deletion operation. This provides status about any issues that occurred during the deletion process.
", + "smithy.api#required": {} + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The human-readable description of the deleted policy engine.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePolicyRequest": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine that manages the policy to be deleted. This ensures the policy is deleted from the correct policy engine context.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy to be deleted. This must be a valid policy ID that exists within the specified policy engine.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeletePolicyResponse": { + "type": "structure", + "members": { + "policyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy being deleted. This confirms which policy the deletion operation targets.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyName", + "traits": { + "smithy.api#documentation": "The customer-assigned name of the deleted policy. This confirms which policy was successfully removed from the system and matches the name that was originally assigned during policy creation.
", + "smithy.api#required": {} + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine from which the policy was deleted. This confirms the policy engine context for the deletion operation.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the deleted policy was originally created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the deleted policy was last modified before deletion. This tracks the final state of the policy before it was removed from the system.
", + "smithy.api#required": {} + } + }, + "policyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted policy. This globally unique identifier confirms which policy resource was successfully removed.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatus", + "traits": { + "smithy.api#documentation": "The status of the policy deletion operation. This provides information about any issues that occurred during the deletion process.
", + "smithy.api#required": {} + } + }, + "enforcementMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnforcementMode", + "traits": { + "smithy.api#default": "ACTIVE", + "smithy.api#documentation": "The enforcement mode of the deleted policy.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyDefinition", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The human-readable description of the deleted policy.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteRegistry": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteRegistryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteRegistryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a registry. The registry must contain zero records before it can be deleted. This operation initiates the deletion process asynchronously.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/registries/{registryId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteRegistryRecord": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteRegistryRecordRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteRegistryRecordResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a registry record. The record's status transitions to DELETING and the record is removed asynchronously.
The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "recordId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RecordIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the registry record to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteRegistryRecordResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteRegistryRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the registry to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteRegistryResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryStatus", + "traits": { + "smithy.api#documentation": "The current status of the registry, set to DELETING when deletion is initiated. For a list of all possible registry statuses, see the RegistryStatus data type.
Deletes the resource-based policy for a specified resource.
This feature is currently available only for AgentCore Runtime and Gateway.
The Amazon Resource Name (ARN) of the resource for which to delete the resource policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteResourcePolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteWorkloadIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteWorkloadIdentityRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteWorkloadIdentityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Deletes a workload identity.
", + "smithy.api#http": { + "code": 204, + "uri": "/identities/DeleteWorkloadIdentity", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteWorkloadIdentityRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameType", + "traits": { + "smithy.api#documentation": "The name of the workload identity to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DeleteWorkloadIdentityResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#DescriptorType": { + "type": "enum", + "members": { + "MCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MCP" + } + }, + "A2A": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A2A" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "AGENT_SKILLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_SKILLS" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#Descriptors": { + "type": "structure", + "members": { + "mcp": { + "target": "com.amazonaws.bedrockagentcorecontrol#McpDescriptor", + "traits": { + "smithy.api#documentation": "The Model Context Protocol (MCP) descriptor configuration. Use this when the descriptorType is MCP.
The Agent-to-Agent (A2A) protocol descriptor configuration. Use this when the descriptorType is A2A.
The custom descriptor configuration. Use this when the descriptorType is CUSTOM.
The agent skills descriptor configuration. Use this when the descriptorType is AGENT_SKILLS.
Contains descriptor-type-specific configurations for a registry record. Only the descriptor matching the record's descriptorType should be populated.
DRAFT has changes not yet reflected in any published version, or no versions have been published yet.
", + "smithy.api#enumValue": "MODIFIED" + } + }, + "UNMODIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "DRAFT content matches the latest published version exactly.
", + "smithy.api#enumValue": "UNMODIFIED" + } + } + }, + "traits": { + "smithy.api#documentation": "Publish synchronization state of the DRAFT working copy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EfsAccessPointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EfsAccessPointConfiguration": { + "type": "structure", + "members": { + "accessPointArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#EfsAccessPointArn", + "traits": { + "smithy.api#documentation": "The ARN of the EFS access point to mount into the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "mountPath": { + "target": "com.amazonaws.bedrockagentcorecontrol#MountPath", + "traits": { + "smithy.api#documentation": "The mount path for the EFS access point inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data).
Configuration for an Amazon EFS access point filesystem mounted into the AgentCore Runtime. EFS access points provide shared file storage accessible from your AgentCore Runtime sessions.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EfsConfiguration": { + "type": "structure", + "members": { + "accessPointArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#EfsAccessPointArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Elastic File System (Amazon EFS) access point to mount.
", + "smithy.api#required": {} + } + }, + "mountPath": { + "target": "com.amazonaws.bedrockagentcorecontrol#MountPath", + "traits": { + "smithy.api#documentation": "The absolute path within the session at which the access point is mounted, for example /mnt/efs. Each mount path must be unique across all file system configurations in the session.
The Amazon Resource Name (ARN) of the Amazon Elastic File System (Amazon EFS) file system that owns the access point.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for mounting an Amazon Elastic File System (Amazon EFS) access point that you own into a session.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EfsFileSystemArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Elastic File System (Amazon EFS) file system. The access points you specify must belong to this file system.
", + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:elasticfilesystem:[a-z0-9-]+:[0-9]{12}:file-system/fs-[0-9a-f]{8,40}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EnabledConnectors": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#EncryptionFailure": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Exception thrown when encryption of a secret fails.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagentcorecontrol#EndpointIpAddressType": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV6" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#EndpointName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#EnforcementMode": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "LOG_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOG_ONLY" + } + } + }, + "traits": { + "smithy.api#default": "ACTIVE", + "smithy.api#documentation": "The enforcement mode for a policy. Run this policy in LOG_ONLY mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to ACTIVE.
The text appended to the prompt for the consolidation step of the episodic memory strategy.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID used for the consolidation step of the episodic memory strategy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations to override the default consolidation step for the episodic memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EpisodicExtractionOverride": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text appended to the prompt for the extraction step of the episodic memory strategy.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID used for the extraction step of the episodic memory strategy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations to override the default extraction step for the episodic memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EpisodicMemoryStrategyInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#Name", + "traits": { + "smithy.api#documentation": "The name of the episodic memory strategy.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the episodic memory strategy.
" + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#deprecated": { + "message": "Use namespaceTemplates instead", + "since": "2026-03-02" + }, + "smithy.api#documentation": "This is a legacy parameter, use namespaceTemplates. The namespaces for which to create episodes.
The namespaceTemplates for which to create episodes.
" + } + }, + "reflectionConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicReflectionConfigurationInput", + "traits": { + "smithy.api#documentation": "The configuration for the reflections created with the episodic memory strategy.
" + } + }, + "memoryRecordSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryRecordSchema", + "traits": { + "smithy.api#documentation": "Schema for metadata fields on records generated by this strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for creating an episodic memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EpisodicOverrideConfigurationInput": { + "type": "structure", + "members": { + "extraction": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicOverrideExtractionConfigurationInput", + "traits": { + "smithy.api#documentation": "Contains configurations for overriding the extraction step of the episodic memory strategy.
" + } + }, + "consolidation": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicOverrideConsolidationConfigurationInput", + "traits": { + "smithy.api#documentation": "Contains configurations for overriding the consolidation step of the episodic memory strategy.
" + } + }, + "reflection": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicOverrideReflectionConfigurationInput", + "traits": { + "smithy.api#documentation": "Contains configurations for overriding the reflection step of the episodic memory strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for the configuration to override the episodic memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EpisodicOverrideConsolidationConfigurationInput": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for the consolidation step of the episodic memory strategy.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for the consolidation step of the episodic memory strategy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations for overriding the consolidation step of the episodic memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EpisodicOverrideExtractionConfigurationInput": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for the extraction step of the episodic memory strategy.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for the extraction step of the episodic memory strategy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations for overriding the extraction step of the episodic memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EpisodicOverrideReflectionConfigurationInput": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for reflection step of the episodic memory strategy.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for the reflection step of the episodic memory strategy.
", + "smithy.api#required": {} + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#deprecated": { + "message": "Use namespaceTemplates instead", + "since": "2026-03-02" + }, + "smithy.api#documentation": "This is a legacy parameter, use namespaceTemplates. The namespaces to use for episodic reflection. Can be less nested than the episodic namespaces.
The namespaceTemplates to use for episodic reflection. Can be less nested than the episodic namespaces.
" + } + }, + "memoryRecordSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryRecordSchema", + "traits": { + "smithy.api#documentation": "Schema for metadata fields on records generated by this reflection override.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations for overriding the reflection step of the episodic memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EpisodicReflectionConfiguration": { + "type": "structure", + "members": { + "namespaces": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#deprecated": { + "message": "Use namespaceTemplates instead", + "since": "2026-03-02" + }, + "smithy.api#documentation": "This is a legacy parameter, use namespaceTemplates. The namespaces for which to create reflections. Can be less nested than the episodic namespaces.
The namespaceTemplates for which to create reflections. Can be less nested than the episodic namespaces.
" + } + }, + "memoryRecordSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryRecordSchema", + "traits": { + "smithy.api#documentation": "\"Schema for metadata fields on records generated by reflections.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the reflections created with the episodic memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EpisodicReflectionConfigurationInput": { + "type": "structure", + "members": { + "namespaces": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#deprecated": { + "message": "Use namespaceTemplates instead", + "since": "2026-03-02" + }, + "smithy.api#documentation": "This is a legacy parameter, use namespaceTemplates. The namespaces over which to create reflections. Can be less nested than episode namespaces.
The namespaceTemplates over which to create reflections. Can be less nested than episode namespaces.
" + } + }, + "memoryRecordSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryRecordSchema", + "traits": { + "smithy.api#documentation": "Schema for metadata fields on records generated by reflections.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An episodic reflection configuration input.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EpisodicReflectionOverride": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text appended to the prompt for the reflection step of the episodic memory strategy.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID used for the reflection step of the episodic memory strategy.
", + "smithy.api#required": {} + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#deprecated": { + "message": "Use namespaceTemplates instead", + "since": "2026-03-02" + }, + "smithy.api#documentation": "This is a legacy parameter. The namespaces over which reflections were created. Can be less nested than the episodic namespaces.
" + } + }, + "namespaceTemplates": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#documentation": "The namespaceTemplates over which reflections were created. Can be less nested than the episodic namespaces.
" + } + }, + "memoryRecordSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryRecordSchema", + "traits": { + "smithy.api#documentation": "Schema for metadata fields on records generated by this reflection override.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations to override the default reflection step for the episodic memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluationConfigDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluationConfigName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Evaluator": { + "type": "resource", + "identifiers": { + "evaluatorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateEvaluator" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetEvaluator" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateEvaluator" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteEvaluator" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListEvaluators" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::Evaluator" + }, + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$|^arn:aws[a-zA-Z-]*:bedrock-agentcore:::evaluator/Builtin.[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorConfig": { + "type": "union", + "members": { + "llmAsAJudge": { + "target": "com.amazonaws.bedrockagentcorecontrol#LlmAsAJudgeEvaluatorConfig", + "traits": { + "smithy.api#documentation": "The LLM-as-a-Judge configuration that uses a language model to evaluate agent performance based on custom instructions and rating scales.
" + } + }, + "codeBased": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeBasedEvaluatorConfig", + "traits": { + "smithy.api#documentation": "Configuration for a code-based evaluator that uses a customer-managed Lambda function to programmatically assess agent performance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that defines how an evaluator assesses agent performance, including the evaluation method and parameters.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorInstructions": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorLevel": { + "type": "enum", + "members": { + "TOOL_CALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOOL_CALL" + } + }, + "TRACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRACE" + } + }, + "SESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SESSION" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorReference" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorModelConfig": { + "type": "union", + "members": { + "bedrockEvaluatorModelConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#BedrockEvaluatorModelConfig", + "traits": { + "smithy.api#documentation": "The Amazon Bedrock model configuration for evaluation.
" + } + }, + "responsesEvaluatorModelConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#OpenResponsesEvaluatorModelConfig", + "traits": { + "smithy.api#documentation": "The OpenResponses model configuration for evaluation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The model configuration that specifies which foundation model to use for evaluation and how to configure it.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9_]{0,47})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorReference": { + "type": "union", + "members": { + "evaluatorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the evaluator. Can reference builtin evaluators (e.g., Builtin.Helpfulness) or custom evaluators.
", + "smithy.api#suppress": [ + "MemberShouldReferenceResource" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The reference to an evaluator used in online evaluation configurations, containing the evaluator identifier.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorSummary": { + "type": "structure", + "members": { + "evaluatorArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the evaluator.
", + "smithy.api#required": {} + } + }, + "evaluatorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the evaluator.
", + "smithy.api#required": {} + } + }, + "evaluatorName": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorName", + "traits": { + "smithy.api#documentation": "The name of the evaluator.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorDescription", + "traits": { + "smithy.api#documentation": "The description of the evaluator.
" + } + }, + "evaluatorType": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorType", + "traits": { + "smithy.api#documentation": "The type of evaluator, indicating whether it is a built-in evaluator provided by the service or a custom evaluator created by the user.
", + "smithy.api#required": {} + } + }, + "level": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorLevel", + "traits": { + "smithy.api#documentation": " The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.
The current status of the evaluator.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the evaluator was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the evaluator was last updated.
", + "smithy.api#required": {} + } + }, + "lockedForModification": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt the evaluator's sensitive data. This field is only present for evaluators encrypted with a customer managed key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary information about an evaluator, including basic metadata and status information.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#EvaluatorType": { + "type": "enum", + "members": { + "BUILTIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Builtin" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Custom" + } + }, + "CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CustomCode" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ExampleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.:-]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ExampleIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ExampleId" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ExceptionLevel": { + "type": "enum", + "members": { + "DEBUG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ExtractionConfig": { + "type": "union", + "members": { + "llmExtractionConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#LlmExtractionConfig", + "traits": { + "smithy.api#documentation": "Model-based extraction using a definition and instructions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for metadata extraction from conversational content.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ExtractionConfiguration": { + "type": "union", + "members": { + "customExtractionConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomExtractionConfiguration", + "traits": { + "smithy.api#documentation": "The custom extraction configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains extraction configuration information for a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ExtractionType": { + "type": "enum", + "members": { + "LLM_INFERRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LLM_INFERRED" + } + }, + "STRICTLY_CONSISTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRICTLY_CONSISTENT" + } + } + }, + "traits": { + "smithy.api#documentation": "The extraction type for a metadata field, determining how the value is obtained during memory processing.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#FilesystemConfiguration": { + "type": "union", + "members": { + "sessionStorage": { + "target": "com.amazonaws.bedrockagentcorecontrol#SessionStorageConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for session storage. Session storage provides persistent storage that is preserved across AgentCore Runtime session invocations.
" + } + }, + "s3FilesAccessPoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3FilesAccessPointConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for an Amazon S3 Files access point to mount into the AgentCore Runtime.
" + } + }, + "efsAccessPoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#EfsAccessPointConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for an Amazon EFS access point to mount into the AgentCore Runtime.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a filesystem that can be mounted into the AgentCore Runtime.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#FilesystemConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#FilesystemConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#Filter": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The key or field name to filter on within the agent trace data.
", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$", + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.bedrockagentcorecontrol#FilterOperator", + "traits": { + "smithy.api#documentation": "The comparison operator to use for filtering.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrockagentcorecontrol#FilterValue", + "traits": { + "smithy.api#documentation": "The value to compare against using the specified operator.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter that applies conditions to agent traces during online evaluation to determine which traces should be evaluated.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#Filter" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#FilterOperator": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Equals" + } + }, + "NOT_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotEquals" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThan" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThan" + } + }, + "GREATER_THAN_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEqual" + } + }, + "LESS_THAN_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEqual" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Contains" + } + }, + "NOT_CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotContains" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#FilterValue": { + "type": "union", + "members": { + "stringValue": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The string value for text-based filtering.
", + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "doubleValue": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The numeric value for numerical filtering and comparisons.
" + } + }, + "booleanValue": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "The boolean value for true/false filtering conditions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The value used in filter comparisons, supporting different data types for flexible filtering criteria.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Finding": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#FindingType", + "traits": { + "smithy.api#documentation": "The type or category of the finding. This classifies the finding as an error, warning, recommendation, or informational message to help users understand the severity and nature of the issue.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#String", + "traits": { + "smithy.api#documentation": "A human-readable description of the finding. This provides detailed information about the issue, recommendation, or validation result to help users understand and address the finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a finding or issue discovered during policy generation or validation. Findings provide insights about potential problems, recommendations, or validation results from policy analysis operations. Finding types include: VALID (policy is ready to use), INVALID (policy has validation errors that must be fixed), NOT_TRANSLATABLE (input couldn't be converted to policy), ALLOW_ALL (policy would allow all actions, potential security risk), ALLOW_NONE (policy would allow no actions, unusable), DENY_ALL (policy would deny all actions, may be too restrictive), and DENY_NONE (policy would deny no actions, ineffective). Review all findings before creating policies from generated assets to ensure they match your security requirements.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#FindingType": { + "type": "enum", + "members": { + "VALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALID" + } + }, + "INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID" + } + }, + "NOT_TRANSLATABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_TRANSLATABLE" + } + }, + "ALLOW_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW_ALL" + } + }, + "ALLOW_NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW_NONE" + } + }, + "DENY_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY_ALL" + } + }, + "DENY_NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY_NONE" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#Findings": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#Finding" + } + }, + "com.amazonaws.bedrockagentcorecontrol#FromUrlSynchronizationConfiguration": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.bedrockagentcorecontrol#McpServerUrl", + "traits": { + "smithy.api#documentation": "The HTTPS URL of the MCP server to synchronize from.
", + "smithy.api#required": {} + } + }, + "credentialProviderConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordCredentialProviderConfigurationList", + "traits": { + "smithy.api#documentation": "Optional list of credential provider configurations for authenticating with the MCP server. At most one credential provider configuration can be specified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for synchronizing from a URL-based MCP server.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayApiKeyCredentialProvider": { + "type": "structure", + "members": { + "providerArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProviderArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.
", + "smithy.api#required": {} + } + }, + "credentialParameterName": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialParameterName", + "traits": { + "smithy.api#documentation": "The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.
" + } + }, + "credentialPrefix": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialPrefix", + "traits": { + "smithy.api#documentation": "The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.
" + } + }, + "credentialLocation": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialLocation", + "traits": { + "smithy.api#documentation": "The location of the API key credential. This field specifies where in the request the API key should be placed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An API key credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using an API key.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::Gateway" + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock-agentcore:[a-z0-9-]{1,20}:[0-9]{12}:gateway/([0-9a-z][-]?){1,48}-[a-z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayConfigurationBundleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:configuration-bundle/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-z][-]?){1,100}-[0-9a-z]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-z][-]?){1,100}-[0-9a-z]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayInterceptionPoint": { + "type": "enum", + "members": { + "REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUEST" + } + }, + "RESPONSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESPONSE" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayInterceptionPoints": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayInterceptionPoint" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayInterceptorConfiguration": { + "type": "structure", + "members": { + "interceptor": { + "target": "com.amazonaws.bedrockagentcorecontrol#InterceptorConfiguration", + "traits": { + "smithy.api#documentation": "The infrastructure settings of an interceptor configuration. This structure defines how the interceptor can be invoked.
", + "smithy.api#required": {} + } + }, + "interceptionPoints": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayInterceptionPoints", + "traits": { + "smithy.api#documentation": "The supported points of interception. This field specifies which points during the gateway invocation to invoke the interceptor
", + "smithy.api#required": {} + } + }, + "inputConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#InterceptorInputConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for the input of the interceptor. This field specifies how the input to the interceptor is constructed
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for an interceptor on a gateway. This structure defines settings for an interceptor that will be invoked during the invocation of the gateway.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayInterceptorConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayInterceptorConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][-]?){1,48}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayPolicyEngineArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 170 + }, + "smithy.api#pattern": "^arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:policy-engine\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9_]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayPolicyEngineConfiguration": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayPolicyEngineArn", + "traits": { + "smithy.api#documentation": "The ARN of the policy engine. The policy engine contains Cedar policies that define fine-grained authorization rules specifying who can perform what actions on which resources as agents interact through the gateway.
", + "smithy.api#required": {} + } + }, + "mode": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayPolicyEngineMode", + "traits": { + "smithy.api#documentation": "The enforcement mode for the policy engine. Valid values include:
LOG_ONLY - The policy engine evaluates each action against your policies and adds traces on whether tool calls would be allowed or denied, but does not enforce the decision. Use this mode to test and validate policies before enabling enforcement.
ENFORCE - The policy engine evaluates actions against your policies and enforces decisions by allowing or denying agent operations. Test and validate policies in LOG_ONLY mode before enabling enforcement to avoid unintended denials or adversely affecting production traffic.
The configuration for a policy engine associated with a gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayPolicyEngineMode": { + "type": "enum", + "members": { + "LOG_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOG_ONLY" + } + }, + "ENFORCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENFORCE" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolConfiguration": { + "type": "union", + "members": { + "mcp": { + "target": "com.amazonaws.bedrockagentcorecontrol#MCPGatewayConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for the Model Context Protocol (MCP). This protocol enables communication between Amazon Bedrock Agent and external tools.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolType": { + "type": "enum", + "members": { + "MCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MCP" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateGateway" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteGateway" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#GetGateway" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListGateways" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateGateway" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayRuleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayRuleDetail": { + "type": "structure", + "members": { + "ruleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the gateway rule.
", + "smithy.api#required": {} + } + }, + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway that the rule belongs to.
", + "smithy.api#required": {} + } + }, + "priority": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRulePriority", + "traits": { + "smithy.api#documentation": "The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.
", + "smithy.api#required": {} + } + }, + "conditions": { + "target": "com.amazonaws.bedrockagentcorecontrol#Conditions", + "traits": { + "smithy.api#documentation": "The conditions that must be met for the rule to apply.
" + } + }, + "actions": { + "target": "com.amazonaws.bedrockagentcorecontrol#Actions", + "traits": { + "smithy.api#documentation": "The actions to take when the rule conditions are met.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleDescription", + "traits": { + "smithy.api#documentation": "The description of the gateway rule.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the rule was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleStatus", + "traits": { + "smithy.api#documentation": "The current status of the rule.
", + "smithy.api#required": {} + } + }, + "system": { + "target": "com.amazonaws.bedrockagentcorecontrol#SystemManagedBlock", + "traits": { + "smithy.api#documentation": "System-managed metadata for rules created by automated processes.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the rule was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information about a gateway rule.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayRuleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayRuleMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayRuleNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayRulePriority": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000000 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayRuleResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateGatewayRule" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayRule" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#GetGatewayRule" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListGatewayRules" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayRule" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayRuleStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayRules": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleDetail" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_UNSUCCESSFUL" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewaySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewaySummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewaySummary": { + "type": "structure", + "members": { + "gatewayId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayId", + "traits": { + "smithy.api#documentation": "The unique identifier of the gateway.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayName", + "traits": { + "smithy.api#documentation": "The name of the gateway.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayStatus", + "traits": { + "smithy.api#documentation": "The current status of the gateway.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayDescription", + "traits": { + "smithy.api#documentation": "The description of the gateway.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the gateway was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the gateway was last updated.
", + "smithy.api#required": {} + } + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerType", + "traits": { + "smithy.api#documentation": "The type of authorizer used by the gateway.
", + "smithy.api#required": {} + } + }, + "protocolType": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "MCP", + "smithy.api#documentation": "The protocol type used by the gateway.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a gateway.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayTarget": { + "type": "structure", + "members": { + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway target.
", + "smithy.api#required": {} + } + }, + "targetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", + "traits": { + "smithy.api#documentation": "The target ID.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the target was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the target was updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetStatus", + "traits": { + "smithy.api#documentation": "The status of the gateway target.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", + "traits": { + "smithy.api#documentation": "The status reasons for the target status.
" + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetName", + "traits": { + "smithy.api#documentation": "The name of the gateway target.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetDescription", + "traits": { + "smithy.api#documentation": "The description for the gateway target.
" + } + }, + "targetConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "credentialProviderConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderConfigurations", + "traits": { + "smithy.api#documentation": "The provider configurations.
", + "smithy.api#required": {} + } + }, + "lastSynchronizedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The last synchronization time.
" + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#MetadataConfiguration", + "traits": { + "smithy.api#documentation": "The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.
" + } + }, + "privateEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpoint" + }, + "privateEndpointManagedResources": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointManagedResources", + "traits": { + "smithy.api#documentation": "A list of managed resources created by the gateway for private endpoint connectivity. These resources are created in your account when you use a managed VPC Lattice resource configuration.
" + } + }, + "authorizationData": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizationData", + "traits": { + "smithy.api#documentation": "OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.
" + } + }, + "protocolType": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetProtocolType", + "traits": { + "smithy.api#documentation": "The protocol type of the gateway target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The gateway target.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayTarget" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayTargetResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateGatewayTarget" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteGatewayTarget" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#GetGatewayTarget" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListGatewayTargets" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#SynchronizeGatewayTargets" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayTarget" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#GatewayUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntime": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntimeRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntimeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon Bedrock AgentCore Runtime.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/runtimes/{agentRuntimeId}/" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntimeEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntimeEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntimeEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an Amazon Secure AgentEndpoint.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/runtimes/{agentRuntimeId}/runtime-endpoints/{endpointName}/" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntimeEndpointRequest": { + "type": "structure", + "members": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime associated with the endpoint.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "endpointName": { + "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the AgentCore Runtime endpoint to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntimeEndpointResponse": { + "type": "structure", + "members": { + "liveVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The currently deployed version of the AgentCore Runtime on the endpoint.
" + } + }, + "targetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The target version of the AgentCore Runtime for the endpoint.
" + } + }, + "agentRuntimeEndpointArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.
", + "smithy.api#required": {} + } + }, + "agentRuntimeArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointDescription", + "traits": { + "smithy.api#documentation": "The description of the AgentCore Runtime endpoint.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointStatus", + "traits": { + "smithy.api#documentation": "The current status of the AgentCore Runtime endpoint.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the AgentCore Runtime endpoint was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the AgentCore Runtime endpoint was last updated.
", + "smithy.api#required": {} + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for failure if the AgentCore Runtime endpoint is in a failed state.
" + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the AgentCore Runtime endpoint.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime endpoint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntimeRequest": { + "type": "structure", + "members": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentRuntimeVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The version of the AgentCore Runtime to retrieve.
", + "smithy.api#httpQuery": "version" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntimeResponse": { + "type": "structure", + "members": { + "agentRuntimeArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "agentRuntimeName": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeName", + "traits": { + "smithy.api#documentation": "The name of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "agentRuntimeVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The version of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the AgentCore Runtime was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the AgentCore Runtime was last updated.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN that provides permissions for the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "networkConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "The network configuration for the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeStatus", + "traits": { + "smithy.api#documentation": "The current status of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "lifecycleConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#LifecycleConfiguration", + "traits": { + "smithy.api#documentation": "The life cycle configuration for the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for failure if the AgentCore Runtime is in a failed state.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the AgentCore Runtime.
" + } + }, + "workloadIdentityDetails": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails", + "traits": { + "smithy.api#documentation": "The workload identity details for the AgentCore Runtime.
" + } + }, + "agentRuntimeArtifact": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArtifact", + "traits": { + "smithy.api#documentation": "The artifact of the AgentCore Runtime.
" + } + }, + "protocolConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#ProtocolConfiguration" + }, + "environmentVariables": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnvironmentVariablesMap", + "traits": { + "smithy.api#documentation": "Environment variables set in the AgentCore Runtime environment.
" + } + }, + "authorizerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", + "traits": { + "smithy.api#documentation": "The authorizer configuration for the AgentCore Runtime.
" + } + }, + "requestHeaderConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#RequestHeaderConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for HTTP request headers that will be passed through to the runtime.
" + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#RuntimeMetadataConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.
" + } + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#FilesystemConfigurations", + "traits": { + "smithy.api#documentation": "The filesystem configurations mounted into the AgentCore Runtime.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetApiKeyCredentialProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetApiKeyCredentialProviderRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetApiKeyCredentialProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#DecryptionFailure" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Retrieves information about an API key credential provider.
", + "smithy.api#http": { + "uri": "/identities/GetApiKeyCredentialProvider", + "method": "POST" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetApiKeyCredentialProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the API key credential provider to retrieve.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetApiKeyCredentialProviderResponse": { + "type": "structure", + "members": { + "apiKeySecretArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Secret", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the API key secret in Amazon Web Services Secrets Manager.
", + "smithy.api#property": {}, + "smithy.api#required": {} + } + }, + "apiKeySecretJsonKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretJsonKeyType", + "traits": { + "smithy.api#documentation": "The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.
", + "smithy.api#property": {} + } + }, + "apiKeySecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.
The name of the API key credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProviderArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the API key credential provider.
", + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the API key credential provider was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the API key credential provider was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetBrowser": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetBrowserRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetBrowserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a custom browser.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/browsers/{browserId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetBrowserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetBrowserProfileRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetBrowserProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a browser profile.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/browser-profiles/{profileId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetBrowserProfileRequest": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser profile to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetBrowserProfileResponse": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser profile.
", + "smithy.api#required": {} + } + }, + "profileArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the browser profile.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileName", + "traits": { + "smithy.api#documentation": "The name of the browser profile.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the browser profile.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileStatus", + "traits": { + "smithy.api#documentation": "The current status of the browser profile.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser profile was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser profile was last updated.
", + "smithy.api#required": {} + } + }, + "lastSavedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when browser session data was last saved to this profile.
" + } + }, + "lastSavedBrowserSessionId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The identifier of the browser session from which data was last saved to this profile.
" + } + }, + "lastSavedBrowserId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserId", + "traits": { + "smithy.api#documentation": "The identifier of the browser from which data was last saved to this profile.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetBrowserRequest": { + "type": "structure", + "members": { + "browserId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetBrowserResponse": { + "type": "structure", + "members": { + "browserId": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser.
", + "smithy.api#required": {} + } + }, + "browserArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the browser.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#SandboxName", + "traits": { + "smithy.api#documentation": "The name of the browser.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the browser.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN that provides permissions for the browser.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserNetworkConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "recording": { + "target": "com.amazonaws.bedrockagentcorecontrol#RecordingConfig" + }, + "browserSigning": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserSigningConfigOutput", + "traits": { + "smithy.api#documentation": "The browser signing configuration that shows whether cryptographic agent identification is enabled for web bot authentication.
" + } + }, + "enterprisePolicies": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserEnterprisePolicies", + "traits": { + "smithy.api#documentation": "The list of enterprise policy files configured for the browser.
" + } + }, + "certificates": { + "target": "com.amazonaws.bedrockagentcorecontrol#Certificates", + "traits": { + "smithy.api#documentation": "The list of certificates configured for the browser.
" + } + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#ToolsFileSystemConfigurations", + "traits": { + "smithy.api#documentation": "The file system configurations mounted into the browser. Each entry describes an access point and its mount path.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserStatus", + "traits": { + "smithy.api#documentation": "The current status of the browser.
", + "smithy.api#required": {} + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for failure if the browser is in a failed state.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetCodeInterpreter": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetCodeInterpreterRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetCodeInterpreterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a custom code interpreter.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/code-interpreters/{codeInterpreterId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetCodeInterpreterRequest": { + "type": "structure", + "members": { + "codeInterpreterId": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterId", + "traits": { + "smithy.api#documentation": "The unique identifier of the code interpreter to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetCodeInterpreterResponse": { + "type": "structure", + "members": { + "codeInterpreterId": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterId", + "traits": { + "smithy.api#documentation": "The unique identifier of the code interpreter.
", + "smithy.api#required": {} + } + }, + "codeInterpreterArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the code interpreter.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#SandboxName", + "traits": { + "smithy.api#documentation": "The name of the code interpreter.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the code interpreter.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN that provides permissions for the code interpreter.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterNetworkConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterStatus", + "traits": { + "smithy.api#documentation": "The current status of the code interpreter.
", + "smithy.api#required": {} + } + }, + "certificates": { + "target": "com.amazonaws.bedrockagentcorecontrol#Certificates", + "traits": { + "smithy.api#documentation": "The list of certificates configured for the code interpreter.
" + } + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#ToolsFileSystemConfigurations", + "traits": { + "smithy.api#documentation": "The file system configurations mounted into the code interpreter. Each entry describes an access point and its mount path.
" + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for failure if the code interpreter is in a failed state.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the code interpreter was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the code interpreter was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetConfigurationBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetConfigurationBundleRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetConfigurationBundleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the latest version of a configuration bundle. By default, returns the latest version on the mainline branch. Use GetConfigurationBundleVersion to retrieve a specific historical version.
The unique identifier of the configuration bundle to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "branchName": { + "target": "com.amazonaws.bedrockagentcorecontrol#BranchName", + "traits": { + "smithy.api#documentation": "The branch name to get the latest version from. If not specified, returns the latest version on the mainline branch.
", + "smithy.api#httpQuery": "branchName" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetConfigurationBundleResponse": { + "type": "structure", + "members": { + "bundleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "bundleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "bundleName": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleName", + "traits": { + "smithy.api#documentation": "The name of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleDescription", + "traits": { + "smithy.api#documentation": "The description of the configuration bundle.
" + } + }, + "versionId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersion", + "traits": { + "smithy.api#documentation": "The version identifier of this configuration bundle.
", + "smithy.api#required": {} + } + }, + "components": { + "target": "com.amazonaws.bedrockagentcorecontrol#ComponentConfigurationMap", + "traits": { + "smithy.api#documentation": "A map of component identifiers to their configurations for this version.
", + "smithy.api#required": {} + } + }, + "lineageMetadata": { + "target": "com.amazonaws.bedrockagentcorecontrol#VersionLineageMetadata", + "traits": { + "smithy.api#documentation": "The version lineage metadata, including parent versions, branch name, and creation source.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the configuration bundle was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the configuration bundle was last updated.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "KMS key ARN used to encrypt component configurations, if CMK was provided.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetConfigurationBundleVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetConfigurationBundleVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetConfigurationBundleVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a specific version of a configuration bundle by its version identifier.
", + "smithy.api#http": { + "method": "GET", + "uri": "/configuration-bundles/{bundleId}/versions/{versionId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetConfigurationBundleVersionRequest": { + "type": "structure", + "members": { + "bundleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the configuration bundle.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersion", + "traits": { + "smithy.api#documentation": "The version identifier of the configuration bundle version to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetConfigurationBundleVersionResponse": { + "type": "structure", + "members": { + "bundleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "bundleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "bundleName": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleName", + "traits": { + "smithy.api#documentation": "The name of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleDescription", + "traits": { + "smithy.api#documentation": "The description of the configuration bundle.
" + } + }, + "versionId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersion", + "traits": { + "smithy.api#documentation": "The version identifier of this configuration bundle version.
", + "smithy.api#required": {} + } + }, + "components": { + "target": "com.amazonaws.bedrockagentcorecontrol#ComponentConfigurationMap", + "traits": { + "smithy.api#documentation": "A map of component identifiers to their configurations for this version.
", + "smithy.api#required": {} + } + }, + "lineageMetadata": { + "target": "com.amazonaws.bedrockagentcorecontrol#VersionLineageMetadata", + "traits": { + "smithy.api#documentation": "The version lineage metadata, including parent versions, branch name, and creation source.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the configuration bundle was created.
", + "smithy.api#required": {} + } + }, + "versionCreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this specific version was created.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "KMS key ARN used to encrypt component configurations, if CMK was provided.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetDatasetRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": " Retrieves dataset metadata. Use the datasetVersion query parameter to retrieve a specific version's metadata. If absent, defaults to DRAFT. For paginated example content, use ListDatasetExamples.
The unique identifier of the dataset to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "datasetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetVersion", + "traits": { + "smithy.api#documentation": "Version to retrieve: \"DRAFT\" or a version number. Defaults to DRAFT if absent.
", + "smithy.api#httpQuery": "datasetVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetDatasetResponse": { + "type": "structure", + "members": { + "datasetArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
", + "smithy.api#required": {} + } + }, + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset.
", + "smithy.api#required": {} + } + }, + "datasetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetVersion", + "traits": { + "smithy.api#documentation": "The resolved version: \"DRAFT\" (default) or the requested version number.
", + "smithy.api#required": {} + } + }, + "datasetName": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the dataset.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetStatus", + "traits": { + "smithy.api#documentation": "The current status of the dataset.
", + "smithy.api#required": {} + } + }, + "draftStatus": { + "target": "com.amazonaws.bedrockagentcorecontrol#DraftStatus", + "traits": { + "smithy.api#documentation": "Publish synchronization state. Only authoritative when status is ACTIVE. MODIFIED indicates DRAFT has unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version.
" + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Populated when status is CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED. Describes the reason for the failure.
" + } + }, + "schemaType": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetSchemaType", + "traits": { + "smithy.api#documentation": "The schema type declared at create time. Immutable after creation.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "KMS key ARN used for server-side encryption on service Amazon S3 writes, if configured.
" + } + }, + "exampleCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of examples in the DRAFT.
", + "smithy.api#required": {} + } + }, + "downloadUrl": { + "target": "com.amazonaws.bedrockagentcorecontrol#DownloadUrl", + "traits": { + "smithy.api#documentation": "Presigned Amazon S3 URL to download the consolidated dataset file for the resolved version. Expires after 5 minutes. Omitted if the file does not yet exist.
" + } + }, + "downloadUrlExpiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "Expiry timestamp for the download URL.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the dataset was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the dataset was last updated.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "The tags associated with the dataset.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetEvaluator": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetEvaluatorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetEvaluatorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about an evaluator, including its configuration, status, and metadata. Works with both built-in and custom evaluators.
", + "smithy.api#http": { + "method": "GET", + "uri": "/evaluators/{evaluatorId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetEvaluatorRequest": { + "type": "structure", + "members": { + "evaluatorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the evaluator to retrieve. Can be a built-in evaluator ID (e.g., Builtin.Helpfulness) or a custom evaluator ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "includedData": { + "target": "com.amazonaws.bedrockagentcorecontrol#IncludedData", + "traits": { + "smithy.api#documentation": " Controls which data is returned in the response. ALL_DATA (default) returns the full evaluator including decrypted instructions and rating scale. For evaluators encrypted with a customer managed KMS key, this requires kms:Decrypt permission on the key. METADATA_ONLY returns evaluator metadata and model configuration without instructions or rating scale, and does not require any KMS permissions.
The Amazon Resource Name (ARN) of the evaluator.
", + "smithy.api#required": {} + } + }, + "evaluatorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the evaluator.
", + "smithy.api#required": {} + } + }, + "evaluatorName": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorName", + "traits": { + "smithy.api#documentation": "The name of the evaluator.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorDescription", + "traits": { + "smithy.api#documentation": "The description of the evaluator.
" + } + }, + "evaluatorConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorConfig", + "traits": { + "smithy.api#documentation": "The configuration of the evaluator, including LLM-as-a-Judge or code-based settings.
", + "smithy.api#required": {} + } + }, + "level": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorLevel", + "traits": { + "smithy.api#documentation": " The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.
The current status of the evaluator.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the evaluator was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the evaluator was last updated.
", + "smithy.api#required": {} + } + }, + "lockedForModification": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt the evaluator's sensitive data. This field is only present for evaluators encrypted with a customer managed key.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetGatewayRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetGatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a specific Gateway.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/gateways/{gatewayIdentifier}/" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetGatewayRequest": { + "type": "structure", + "members": { + "gatewayIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the gateway to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetGatewayResponse": { + "type": "structure", + "members": { + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway.
", + "smithy.api#required": {} + } + }, + "gatewayId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayId", + "traits": { + "smithy.api#documentation": "The unique identifier of the gateway.
", + "smithy.api#required": {} + } + }, + "gatewayUrl": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayUrl", + "traits": { + "smithy.api#documentation": "An endpoint for invoking gateway.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the gateway was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the gateway was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayStatus", + "traits": { + "smithy.api#documentation": "The current status of the gateway.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", + "traits": { + "smithy.api#documentation": "The reasons for the current status of the gateway.
" + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayName", + "traits": { + "smithy.api#documentation": "The name of the gateway.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayDescription", + "traits": { + "smithy.api#documentation": "The description of the gateway.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN that provides permissions for the gateway.
" + } + }, + "protocolType": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "MCP", + "smithy.api#documentation": "Protocol applied to a gateway.
" + } + }, + "protocolConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolConfiguration" + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerType", + "traits": { + "smithy.api#documentation": "Authorizer type for the gateway.
", + "smithy.api#required": {} + } + }, + "authorizerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", + "traits": { + "smithy.api#documentation": "The authorizer configuration for the gateway.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the gateway.
" + } + }, + "customTransformConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomTransformConfiguration", + "traits": { + "smithy.api#documentation": "The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.
" + } + }, + "interceptorConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayInterceptorConfigurations", + "traits": { + "smithy.api#documentation": "The interceptors configured on the gateway.
" + } + }, + "policyEngineConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayPolicyEngineConfiguration", + "traits": { + "smithy.api#documentation": "The policy engine configuration for the gateway.
" + } + }, + "workloadIdentityDetails": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails", + "traits": { + "smithy.api#documentation": "The workload identity details for the gateway.
" + } + }, + "exceptionLevel": { + "target": "com.amazonaws.bedrockagentcorecontrol#ExceptionLevel", + "traits": { + "smithy.api#documentation": "The level of detail in error messages returned when invoking the gateway.
If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.
If the value is omitted, a generic error message is returned to the end user.
The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway.
" + } + }, + "wafConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#WafConfiguration", + "traits": { + "smithy.api#documentation": "The Amazon Web Services WAF configuration for the gateway.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetGatewayRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetGatewayRuleRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetGatewayRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about a specific gateway rule.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/gateways/{gatewayIdentifier}/rules/{ruleId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetGatewayRuleRequest": { + "type": "structure", + "members": { + "gatewayIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the gateway containing the rule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ruleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the rule to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetGatewayRuleResponse": { + "type": "structure", + "members": { + "ruleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the gateway rule.
", + "smithy.api#required": {} + } + }, + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway that the rule belongs to.
", + "smithy.api#required": {} + } + }, + "priority": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRulePriority", + "traits": { + "smithy.api#documentation": "The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.
", + "smithy.api#required": {} + } + }, + "conditions": { + "target": "com.amazonaws.bedrockagentcorecontrol#Conditions", + "traits": { + "smithy.api#documentation": "The conditions that must be met for the rule to apply.
" + } + }, + "actions": { + "target": "com.amazonaws.bedrockagentcorecontrol#Actions", + "traits": { + "smithy.api#documentation": "The actions to take when the rule conditions are met.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleDescription", + "traits": { + "smithy.api#documentation": "The description of the gateway rule.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the rule was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleStatus", + "traits": { + "smithy.api#documentation": "The current status of the rule.
", + "smithy.api#required": {} + } + }, + "system": { + "target": "com.amazonaws.bedrockagentcorecontrol#SystemManagedBlock", + "traits": { + "smithy.api#documentation": "System-managed metadata for rules created by automated processes.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the rule was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Create response excludes updatedAt (redundant on create).\nGet/Update responses include it via their own output structures.", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetGatewayTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetGatewayTargetRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetGatewayTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a specific gateway target.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/gateways/{gatewayIdentifier}/targets/{targetId}/" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetGatewayTargetRequest": { + "type": "structure", + "members": { + "gatewayIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the gateway that contains the target.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "targetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the target to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetGatewayTargetResponse": { + "type": "structure", + "members": { + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway.
", + "smithy.api#required": {} + } + }, + "targetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the gateway target.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the gateway target was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the gateway target was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetStatus", + "traits": { + "smithy.api#documentation": "The current status of the gateway target.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", + "traits": { + "smithy.api#documentation": "The reasons for the current status of the gateway target.
" + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetName", + "traits": { + "smithy.api#documentation": "The name of the gateway target.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetDescription", + "traits": { + "smithy.api#documentation": "The description of the gateway target.
" + } + }, + "targetConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "credentialProviderConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderConfigurations", + "traits": { + "smithy.api#documentation": "The credential provider configurations for the gateway target.
", + "smithy.api#required": {} + } + }, + "lastSynchronizedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The last synchronization of the target.
" + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#MetadataConfiguration", + "traits": { + "smithy.api#documentation": "The metadata configuration for HTTP header and query parameter propagation for the retrieved gateway target.
" + } + }, + "privateEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpoint", + "traits": { + "smithy.api#documentation": "The private endpoint configuration for the gateway target.
" + } + }, + "privateEndpointManagedResources": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointManagedResources", + "traits": { + "smithy.api#documentation": "The managed resources created by the gateway for private endpoint connectivity.
" + } + }, + "authorizationData": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizationData", + "traits": { + "smithy.api#documentation": "OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.
" + } + }, + "protocolType": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetProtocolType", + "traits": { + "smithy.api#documentation": "The protocol type of the gateway target.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetHarness": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetHarnessRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetHarnessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Operation to get a single harness.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/harnesses/{harnessId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetHarnessEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetHarnessEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetHarnessEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Operation to get a single harness endpoint.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/harnesses/{harnessId}/endpoints/{endpointName}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetHarnessEndpointRequest": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness that the endpoint belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "endpointName": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointName", + "traits": { + "smithy.api#documentation": "The name of the endpoint to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetHarnessEndpointResponse": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetHarnessRequest": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "harnessVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessVersion", + "traits": { + "smithy.api#documentation": "Specific version of the harness to retrieve. If omitted, returns the current Harness configuration, including its status.
", + "smithy.api#httpQuery": "harnessVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetHarnessResponse": { + "type": "structure", + "members": { + "harness": { + "target": "com.amazonaws.bedrockagentcorecontrol#Harness", + "traits": { + "smithy.api#documentation": "The harness resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetMemory": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetMemoryInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetMemoryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieve an existing Amazon Bedrock AgentCore Memory resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/memories/{memoryId}/details" + }, + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "MemoryCreated": { + "acceptors": [ + { + "state": "retry", + "matcher": { + "output": { + "path": "memory.status", + "expected": "CREATING", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "memory.status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "memory.status", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ] + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetMemoryInput": { + "type": "structure", + "members": { + "memoryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the memory to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "view": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryView", + "traits": { + "smithy.api#default": "full", + "smithy.api#documentation": "The level of detail to return for the memory.
", + "smithy.api#httpQuery": "view" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetMemoryOutput": { + "type": "structure", + "members": { + "memory": { + "target": "com.amazonaws.bedrockagentcorecontrol#Memory", + "traits": { + "smithy.api#documentation": "The retrieved AgentCore Memory resource details.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetOauth2CredentialProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetOauth2CredentialProviderRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetOauth2CredentialProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#DecryptionFailure" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Retrieves information about an OAuth2 credential provider.
", + "smithy.api#http": { + "uri": "/identities/GetOauth2CredentialProvider", + "method": "POST" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetOauth2CredentialProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the OAuth2 credential provider to retrieve.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetOauth2CredentialProviderResponse": { + "type": "structure", + "members": { + "clientSecretArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Secret", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.
", + "smithy.api#property": {}, + "smithy.api#required": {} + } + }, + "clientSecretJsonKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretJsonKeyType", + "traits": { + "smithy.api#documentation": "The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.
", + "smithy.api#property": {} + } + }, + "clientSecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.
The name of the OAuth2 credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderArnType", + "traits": { + "smithy.api#documentation": "ARN of the credential provider requested.
", + "smithy.api#required": {} + } + }, + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderVendorType", + "traits": { + "smithy.api#documentation": "The vendor of the OAuth2 credential provider.
", + "smithy.api#required": {} + } + }, + "callbackUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.
" + } + }, + "oauth2ProviderConfigOutput": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2ProviderConfigOutput", + "traits": { + "smithy.api#documentation": "The configuration output for the OAuth2 provider.
", + "smithy.api#notProperty": {}, + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the OAuth2 credential provider was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the OAuth2 credential provider was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#Status", + "traits": { + "smithy.api#documentation": "The current status of the OAuth2 credential provider.
" + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for failure if the OAuth2 credential provider is in a failed state.
", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetOnlineEvaluationConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetOnlineEvaluationConfigRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetOnlineEvaluationConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.
", + "smithy.api#http": { + "method": "GET", + "uri": "/online-evaluation-configs/{onlineEvaluationConfigId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetOnlineEvaluationConfigRequest": { + "type": "structure", + "members": { + "onlineEvaluationConfigId": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigId", + "traits": { + "smithy.api#documentation": "The unique identifier of the online evaluation configuration to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetOnlineEvaluationConfigResponse": { + "type": "structure", + "members": { + "onlineEvaluationConfigArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "onlineEvaluationConfigId": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigId", + "traits": { + "smithy.api#documentation": "The unique identifier of the online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "onlineEvaluationConfigName": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluationConfigName", + "traits": { + "smithy.api#documentation": "The name of the online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluationConfigDescription", + "traits": { + "smithy.api#documentation": "The description of the online evaluation configuration.
" + } + }, + "rule": { + "target": "com.amazonaws.bedrockagentcorecontrol#Rule", + "traits": { + "smithy.api#documentation": "The evaluation rule containing sampling configuration, filters, and session settings.
", + "smithy.api#required": {} + } + }, + "dataSourceConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#DataSourceConfig", + "traits": { + "smithy.api#documentation": "The data source configuration specifying CloudWatch log groups and service names to monitor.
", + "smithy.api#required": {} + } + }, + "evaluators": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorList", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": [], + "smithy.api#documentation": "The list of evaluators applied during online evaluation.
" + } + }, + "insights": { + "target": "com.amazonaws.bedrockagentcorecontrol#InsightList", + "traits": { + "smithy.api#documentation": "The list of insight types configured for this evaluation.
" + } + }, + "clusteringConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClusteringConfig", + "traits": { + "smithy.api#documentation": "The clustering configuration for periodic batch evaluation.
" + } + }, + "outputConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#OutputConfig", + "traits": { + "smithy.api#documentation": "The output configuration specifying where evaluation results are written.
" + } + }, + "evaluationExecutionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used for evaluation execution.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigStatus", + "traits": { + "smithy.api#documentation": "The status of the online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "executionStatus": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationExecutionStatus", + "traits": { + "smithy.api#documentation": "The execution status indicating whether the online evaluation is currently running.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the online evaluation configuration was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the online evaluation configuration was last updated.
", + "smithy.api#required": {} + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for failure if the online evaluation configuration execution failed.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPaymentConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPaymentConnectorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPaymentConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a specific payment connector.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/payments/managers/{paymentManagerId}/connectors/{paymentConnectorId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPaymentConnectorRequest": { + "type": "structure", + "members": { + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the parent payment manager.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment connector to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPaymentConnectorResponse": { + "type": "structure", + "members": { + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment connector.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorName", + "traits": { + "smithy.api#documentation": "The name of the payment connector.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsDescription", + "traits": { + "smithy.api#documentation": "The description of the payment connector.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorType", + "traits": { + "smithy.api#documentation": "The type of the payment connector, which determines the payment provider integration.
", + "smithy.api#required": {} + } + }, + "credentialProviderConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialsProviderConfigurations", + "traits": { + "smithy.api#documentation": "The credential provider configurations for the payment connector.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment connector was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment connector was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorStatus", + "traits": { + "smithy.api#documentation": "The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
Retrieves information about a specific payment credential provider.
", + "smithy.api#http": { + "uri": "/identities/GetPaymentCredentialProvider", + "method": "POST" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPaymentCredentialProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the payment credential provider to retrieve.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPaymentCredentialProviderResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the payment credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the payment credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderVendorType", + "traits": { + "smithy.api#documentation": "The vendor type for the payment credential provider.
", + "smithy.api#required": {} + } + }, + "providerConfigurationOutput": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentProviderConfigurationOutput", + "traits": { + "smithy.api#documentation": "Output configuration (contains secret ARNs, excludes actual secret values).
", + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment credential provider was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment credential provider was last updated.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "The tags associated with the payment credential provider.
", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPaymentManager": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPaymentManagerRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPaymentManagerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a specific payment manager.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/payments/managers/{paymentManagerId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPaymentManagerRequest": { + "type": "structure", + "members": { + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment manager to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPaymentManagerResponse": { + "type": "structure", + "members": { + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the payment manager.
", + "smithy.api#required": {} + } + }, + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment manager.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerName", + "traits": { + "smithy.api#documentation": "The name of the payment manager.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsDescription", + "traits": { + "smithy.api#documentation": "The description of the payment manager.
" + } + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsAuthorizerType", + "traits": { + "smithy.api#documentation": "The type of authorizer used by the payment manager.
CUSTOM_JWT - Authorize with a bearer token.
AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.
", + "smithy.api#required": {} + } + }, + "workloadIdentityDetails": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails" + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment manager was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment manager was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerStatus", + "traits": { + "smithy.api#documentation": "The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
The tags associated with the payment manager.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about a specific policy within the AgentCore Policy system. This operation returns the complete policy definition, metadata, and current status, allowing administrators to review and manage policy configurations.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engines/{policyEngineId}/policies/{policyId}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "PolicyActive": { + "documentation": "Wait until a Policy is active", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "UPDATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 120 + }, + "PolicyDeleted": { + "documentation": "Wait until a Policy is deleted", + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "status", + "expected": "DELETING", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 2, + "maxDelay": 120 + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyEngine": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyEngineRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyEngineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about a specific policy engine within the AgentCore Policy system. This operation returns the complete policy engine configuration, metadata, and current status, allowing administrators to review and manage policy engine settings.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engines/{policyEngineId}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "PolicyEngineActive": { + "documentation": "Wait until a PolicyEngine is active", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "UPDATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 120 + }, + "PolicyEngineDeleted": { + "documentation": "Wait until a PolicyEngine is deleted", + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "status", + "expected": "DELETING", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 2, + "maxDelay": 120 + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyEngineRequest": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy engine to be retrieved. This must be a valid policy engine ID that exists within the account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyEngineResponse": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the retrieved policy engine. This matches the policy engine ID provided in the request and serves as the system identifier.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineName", + "traits": { + "smithy.api#documentation": "The customer-assigned name of the policy engine. This is the human-readable identifier that was specified when the policy engine was created.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy engine was originally created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration.
", + "smithy.api#required": {} + } + }, + "policyEngineArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineStatus", + "traits": { + "smithy.api#documentation": "The current status of the policy engine.
", + "smithy.api#required": {} + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The human-readable description of the policy engine's purpose and scope. This helps administrators understand the policy engine's role in governance.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyEngineSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyEngineSummaryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyEngineSummaryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a metadata-only summary of a specific policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and the encryption key ARN, but does not include the description or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engine-summaries/{policyEngineId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyEngineSummaryRequest": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy engine to retrieve the summary for. This must be a valid policy engine ID that exists within the account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyEngineSummaryResponse": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy engine.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineName", + "traits": { + "smithy.api#documentation": "The customer-assigned name of the policy engine.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy engine was originally created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy engine was last modified.
", + "smithy.api#required": {} + } + }, + "policyEngineArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy engine.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineStatus", + "traits": { + "smithy.api#documentation": "The current status of the policy engine.
", + "smithy.api#required": {} + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyGeneration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyGenerationRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyGenerationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a policy generation request within the AgentCore Policy system. Policy generation converts natural language descriptions into Cedar policy statements using AI-powered translation, enabling non-technical users to create policies.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engines/{policyEngineId}/policy-generations/{policyGenerationId}" + }, + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "PolicyGenerationCompleted": { + "documentation": "Wait until policy generation is completed", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "GENERATED", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "status", + "expected": "GENERATING", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "GENERATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 120 + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyGenerationRequest": { + "type": "structure", + "members": { + "policyGenerationId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy generation request to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and schema validation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyGenerationResponse": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine associated with this policy generation. This confirms the policy engine context for the generation operation.
", + "smithy.api#required": {} + } + }, + "policyGenerationId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy generation request. This matches the generation ID provided in the request and serves as the tracking identifier.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationName", + "traits": { + "smithy.api#documentation": "The customer-assigned name for the policy generation request. This helps identify and track generation operations across multiple requests.
", + "smithy.api#required": {} + } + }, + "policyGenerationArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy generation. This globally unique identifier can be used for tracking, auditing, and cross-service references.
", + "smithy.api#required": {} + } + }, + "resource": { + "target": "com.amazonaws.bedrockagentcorecontrol#Resource", + "traits": { + "smithy.api#documentation": "The resource information associated with the policy generation. This provides context about the target resources for which the policies are being generated.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy generation request was created. This is used for tracking and auditing generation operations and their lifecycle.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy generation was last updated. This tracks the progress of the generation process and any status changes.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationStatus", + "traits": { + "smithy.api#documentation": "The current status of the policy generation. This indicates whether the generation is in progress, completed successfully, or failed during processing.
", + "smithy.api#required": {} + } + }, + "findings": { + "target": "com.amazonaws.bedrockagentcorecontrol#String", + "traits": { + "smithy.api#documentation": "The findings and results from the policy generation process. This includes any issues, recommendations, validation results, or insights from the generated policies.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the generation status. This provides details about any failures, warnings, or the current state of the generation process.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyGenerationSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyGenerationSummaryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyGenerationSummaryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a metadata-only summary of a specific policy generation request without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and findings, but does not include status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engines/{policyEngineId}/policy-generation-summaries/{policyGenerationId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyGenerationSummaryRequest": { + "type": "structure", + "members": { + "policyGenerationId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy generation request to retrieve the summary for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine associated with the policy generation request.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyGenerationSummaryResponse": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine associated with this policy generation.
", + "smithy.api#required": {} + } + }, + "policyGenerationId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy generation request.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationName", + "traits": { + "smithy.api#documentation": "The customer-assigned name for the policy generation request.
", + "smithy.api#required": {} + } + }, + "policyGenerationArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy generation request.
", + "smithy.api#required": {} + } + }, + "resource": { + "target": "com.amazonaws.bedrockagentcorecontrol#Resource", + "traits": { + "smithy.api#documentation": "The resource information associated with the policy generation.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy generation request was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy generation was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationStatus", + "traits": { + "smithy.api#documentation": "The current status of the policy generation request.
", + "smithy.api#required": {} + } + }, + "findings": { + "target": "com.amazonaws.bedrockagentcorecontrol#String", + "traits": { + "smithy.api#documentation": "The findings from the policy generation process, if available.
" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyRequest": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine that manages the policy to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy to be retrieved. This must be a valid policy ID that exists within the specified policy engine.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicyResponse": { + "type": "structure", + "members": { + "policyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the retrieved policy. This matches the policy ID provided in the request and serves as the system identifier for the policy.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyName", + "traits": { + "smithy.api#documentation": "The customer-assigned name of the policy. This is the human-readable identifier that was specified when the policy was created.
", + "smithy.api#required": {} + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine that manages this policy. This confirms the policy engine context for the retrieved policy.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was originally created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration.
", + "smithy.api#required": {} + } + }, + "policyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatus", + "traits": { + "smithy.api#documentation": "The current status of the policy.
", + "smithy.api#required": {} + } + }, + "enforcementMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnforcementMode", + "traits": { + "smithy.api#default": "ACTIVE", + "smithy.api#documentation": "The current enforcement mode of the policy.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyDefinition", + "traits": { + "smithy.api#documentation": "The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the policy status. This provides details about any failures or the current state of the policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicySummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicySummaryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicySummaryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a metadata-only summary of a specific policy without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps, but does not include the policy definition, description, or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engines/{policyEngineId}/policy-summaries/{policyId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicySummaryRequest": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine that manages the policy to retrieve the summary for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy to retrieve the summary for. This must be a valid policy ID that exists within the specified policy engine.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetPolicySummaryResponse": { + "type": "structure", + "members": { + "policyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyName", + "traits": { + "smithy.api#documentation": "The customer-assigned name of the policy.
", + "smithy.api#required": {} + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine that manages this policy.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was originally created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was last modified.
", + "smithy.api#required": {} + } + }, + "policyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatus", + "traits": { + "smithy.api#documentation": "The current status of the policy.
", + "smithy.api#required": {} + } + }, + "enforcementMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnforcementMode", + "traits": { + "smithy.api#default": "ACTIVE", + "smithy.api#documentation": "The current enforcement mode of the policy.
" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetRegistry": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetRegistryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetRegistryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a specific registry.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/registries/{registryId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetRegistryRecord": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetRegistryRecordRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetRegistryRecordResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a specific registry record.
", + "smithy.api#http": { + "method": "GET", + "uri": "/registries/{registryId}/records/{recordId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetRegistryRecordRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "recordId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RecordIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the registry record to retrieve. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetRegistryRecordResponse": { + "type": "structure", + "members": { + "registryArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the registry that contains the record.
", + "smithy.api#required": {} + } + }, + "recordArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the registry record.
", + "smithy.api#required": {} + } + }, + "recordId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordId", + "traits": { + "smithy.api#documentation": "The unique identifier of the registry record.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordName", + "traits": { + "smithy.api#documentation": "The name of the registry record.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the registry record.
" + } + }, + "descriptorType": { + "target": "com.amazonaws.bedrockagentcorecontrol#DescriptorType", + "traits": { + "smithy.api#documentation": "The descriptor type of the registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.
The descriptor-type-specific configuration containing the resource schema and metadata. For details, see the Descriptors data type.
The version of the registry record.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordStatus", + "traits": { + "smithy.api#documentation": "The current status of the registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED. A record transitions from CREATING to DRAFT, then to PENDING_APPROVAL (via SubmitRegistryRecordForApproval), and finally to APPROVED upon approval.
The timestamp when the registry record was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the registry record was last updated.
", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for the current status, typically set when the status is a failure state.
" + } + }, + "synchronizationType": { + "target": "com.amazonaws.bedrockagentcorecontrol#SynchronizationType", + "traits": { + "smithy.api#documentation": "The type of synchronization used for this record.
" + } + }, + "synchronizationConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#SynchronizationConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for synchronizing registry record metadata from an external source.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetRegistryRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the registry to retrieve. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetRegistryResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryName", + "traits": { + "smithy.api#documentation": "The name of the registry.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the registry.
" + } + }, + "registryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the registry.
", + "smithy.api#required": {} + } + }, + "registryArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the registry.
", + "smithy.api#required": {} + } + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryAuthorizerType", + "traits": { + "smithy.api#documentation": "The type of authorizer used by the registry. This controls the authorization method for the Search and Invoke APIs used by consumers.
CUSTOM_JWT - Authorize with a bearer token.
AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
The authorizer configuration for the registry. For details, see the AuthorizerConfiguration data type.
The approval configuration for registry records. For details, see the ApprovalConfiguration data type.
The current status of the registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.
The reason for the current status, typically set when the status is a failure state.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the registry was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the registry was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the resource-based policy for a specified resource.
This feature is currently available only for AgentCore Runtime and Gateway.
The Amazon Resource Name (ARN) of the resource for which to retrieve the resource policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "policy": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourcePolicyBody", + "traits": { + "smithy.api#documentation": "The resource policy associated with the specified resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetTokenVault": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetTokenVaultRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetTokenVaultResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Retrieves information about a token vault.
", + "smithy.api#http": { + "uri": "/identities/get-token-vault", + "method": "POST" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetTokenVaultRequest": { + "type": "structure", + "members": { + "tokenVaultId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TokenVaultIdType", + "traits": { + "smithy.api#documentation": "The unique identifier of the token vault to retrieve.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetTokenVaultResponse": { + "type": "structure", + "members": { + "tokenVaultId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TokenVaultIdType", + "traits": { + "smithy.api#documentation": "The ID of the token vault.
", + "smithy.api#required": {} + } + }, + "kmsConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsConfiguration", + "traits": { + "smithy.api#documentation": "The KMS configuration for the token vault.
", + "smithy.api#required": {} + } + }, + "lastModifiedDate": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the token vault was last modified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetWorkloadIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetWorkloadIdentityRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetWorkloadIdentityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Retrieves information about a workload identity.
", + "smithy.api#http": { + "uri": "/identities/GetWorkloadIdentity", + "method": "POST" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetWorkloadIdentityRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameType", + "traits": { + "smithy.api#documentation": "The name of the workload identity to retrieve.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GetWorkloadIdentityResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameType", + "traits": { + "smithy.api#documentation": "The name of the workload identity.
", + "smithy.api#required": {} + } + }, + "workloadIdentityArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the workload identity.
", + "smithy.api#required": {} + } + }, + "allowedResourceOauth2ReturnUrls": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceOauth2ReturnUrlListType", + "traits": { + "smithy.api#documentation": "The list of allowed OAuth2 return URLs for resources associated with this workload identity.
" + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the workload identity was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the workload identity was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#GithubOauth2ProviderConfigInput": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the GitHub OAuth2 provider.
", + "smithy.api#required": {} + } + }, + "clientSecret": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultClientSecretType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The client secret for the GitHub OAuth2 provider.
" + } + }, + "clientSecretConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretReference", + "traits": { + "smithy.api#documentation": "A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.
The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
Input configuration for a GitHub OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GithubOauth2ProviderConfigOutput": { + "type": "structure", + "members": { + "oauthDiscovery": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2Discovery", + "traits": { + "smithy.api#documentation": "The OAuth2 discovery information for the GitHub provider.
", + "smithy.api#required": {} + } + }, + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the GitHub OAuth2 provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Output configuration for a GitHub OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GoogleOauth2ProviderConfigInput": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the Google OAuth2 provider.
", + "smithy.api#required": {} + } + }, + "clientSecret": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultClientSecretType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The client secret for the Google OAuth2 provider.
" + } + }, + "clientSecretConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretReference", + "traits": { + "smithy.api#documentation": "A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.
The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
Input configuration for a Google OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#GoogleOauth2ProviderConfigOutput": { + "type": "structure", + "members": { + "oauthDiscovery": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2Discovery", + "traits": { + "smithy.api#documentation": "The OAuth2 discovery information for the Google provider.
", + "smithy.api#required": {} + } + }, + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the Google OAuth2 provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Output configuration for a Google OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Harness": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness.
", + "smithy.api#required": {} + } + }, + "harnessName": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessName", + "traits": { + "smithy.api#documentation": "The name of the harness.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessArn", + "traits": { + "smithy.api#documentation": "The ARN of the harness.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessStatus", + "traits": { + "smithy.api#documentation": "The status of the harness.
", + "smithy.api#required": {} + } + }, + "harnessVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessVersion", + "traits": { + "smithy.api#documentation": "The version of the harness. Incremented on every successful UpdateHarness.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "IAM role the harness assumes when running.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The createdAt time of the harness.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The updatedAt time of the harness.
", + "smithy.api#required": {} + } + }, + "model": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessModelConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the default model used by the Harness.
", + "smithy.api#required": {} + } + }, + "systemPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSystemPrompt", + "traits": { + "smithy.api#documentation": "The system prompt of the harness.
", + "smithy.api#required": {} + } + }, + "tools": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessTools", + "traits": { + "smithy.api#documentation": "The tools of the harness.
", + "smithy.api#required": {} + } + }, + "skills": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSkills", + "traits": { + "smithy.api#documentation": "The skills of the harness.
", + "smithy.api#required": {} + } + }, + "allowedTools": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAllowedTools", + "traits": { + "smithy.api#documentation": "The allowed tools of the harness. All tools are allowed by default.
", + "smithy.api#required": {} + } + }, + "truncation": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessTruncationConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for truncating model context.
", + "smithy.api#required": {} + } + }, + "environment": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEnvironmentProvider", + "traits": { + "smithy.api#documentation": "The compute environment on which the Harness runs.
", + "smithy.api#required": {} + } + }, + "environmentArtifact": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEnvironmentArtifact", + "traits": { + "smithy.api#documentation": "The environment artifact (e.g., container) in which the Harness operates.
" + } + }, + "environmentVariables": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnvironmentVariablesMap", + "traits": { + "smithy.api#documentation": "Environment variables exposed in the environment in which the harness operates.
" + } + }, + "authorizerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration" + }, + "memory": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessMemoryConfiguration", + "traits": { + "smithy.api#documentation": "AgentCore Memory instance configuration for short and long term memory.
" + } + }, + "maxIterations": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of iterations in the agent loop allowed before exiting per invocation.
" + } + }, + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum total number of output tokens the agent can generate across all model calls within a single invocation.
" + } + }, + "timeoutSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum duration per invocation.
" + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Reason why create or update operations fail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Representation of a harness.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreBrowserConfig": { + "type": "structure", + "members": { + "browserArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessBrowserArn", + "traits": { + "smithy.api#documentation": "If not populated, the built-in Browser ARN is used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Browser.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreCodeInterpreterConfig": { + "type": "structure", + "members": { + "codeInterpreterArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessCodeInterpreterArn", + "traits": { + "smithy.api#documentation": "If not populated, the built-in Code Interpreter ARN is used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Code Interpreter.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreGatewayConfig": { + "type": "structure", + "members": { + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The ARN of the desired AgentCore Gateway.
", + "smithy.api#required": {} + } + }, + "outboundAuth": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessGatewayOutboundAuth", + "traits": { + "smithy.api#documentation": "How harness authenticates to this Gateway. Defaults to AWS_IAM (SigV4) if omitted.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Gateway.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreMemoryConfiguration": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryArn", + "traits": { + "smithy.api#documentation": "The ARN of the AgentCore Memory resource.
", + "smithy.api#required": {} + } + }, + "actorId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The actor ID for memory operations.
" + } + }, + "messagesCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of messages to retrieve from memory.
" + } + }, + "retrievalConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreMemoryRetrievalConfigs", + "traits": { + "smithy.api#documentation": "The retrieval configuration for long-term memory, mapping namespace path templates to retrieval settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Memory integration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreMemoryRetrievalConfig": { + "type": "structure", + "members": { + "topK": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of memory entries to retrieve.
" + } + }, + "relevanceScore": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "The minimum relevance score for retrieved memories.
" + } + }, + "strategyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the retrieval strategy to use.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for memory retrieval within a namespace.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreMemoryRetrievalConfigs": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreMemoryRetrievalConfig" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreRuntimeEnvironment": { + "type": "structure", + "members": { + "agentRuntimeArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#BedrockAgentcoreResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the underlying AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "agentRuntimeName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the underlying AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "agentRuntimeId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the underlying AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "lifecycleConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#LifecycleConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "networkConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#NetworkConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#FilesystemConfigurations", + "traits": { + "smithy.api#documentation": "The filesystem configurations for the runtime environment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The AgentCore Runtime environment for a harness.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreRuntimeEnvironmentRequest": { + "type": "structure", + "members": { + "lifecycleConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#LifecycleConfiguration" + }, + "networkConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#NetworkConfiguration" + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#FilesystemConfigurations", + "traits": { + "smithy.api#documentation": "The filesystem configurations for the runtime environment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The AgentCore Runtime environment request configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessAllowedTool": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^(\\*|@?[^/]+(/[^/]+)?)$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessAllowedTools": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAllowedTool" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:([^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:harness/[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessAwsSkillPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^([^*?\\[\\]]|\\*)+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessAwsSkillPaths": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAwsSkillPath" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessBedrockApiFormat": { + "type": "enum", + "members": { + "CONVERSE_STREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Use the Bedrock Converse Stream API format.
", + "smithy.api#enumValue": "converse_stream" + } + }, + "RESPONSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Use the Responses API format.
", + "smithy.api#enumValue": "responses" + } + }, + "CHAT_COMPLETIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Use the Chat Completions API format.
", + "smithy.api#enumValue": "chat_completions" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessBedrockModelConfig": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModelId", + "traits": { + "smithy.api#documentation": "The Bedrock model ID.
", + "smithy.api#required": {} + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxTokens", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to allow in the generated response per model call.
" + } + }, + "temperature": { + "target": "com.amazonaws.bedrockagentcorecontrol#Temperature", + "traits": { + "smithy.api#documentation": "The temperature to set when calling the model.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagentcorecontrol#TopP", + "traits": { + "smithy.api#documentation": "The topP set when calling the model.
" + } + }, + "apiFormat": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessBedrockApiFormat", + "traits": { + "smithy.api#documentation": "The API format to use when calling the Bedrock provider.
" + } + }, + "additionalParams": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Provider-specific parameters passed through to the model provider unchanged.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for an Amazon Bedrock model provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessBrowserArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Browser ARN for Harness tool configuration. Accepts both managed (aws.browser.v1) and custom browser ARNs.", + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws\\.browser\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessCodeInterpreterArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Code Interpreter ARN for Harness tool configuration. Accepts both managed (aws.codeinterpreter.v1) and custom code interpreter ARNs.", + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):code-interpreter(-custom)?/(aws\\.codeinterpreter\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessDisabledMemoryConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Explicitly opt out of memory.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessEndpoint": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness that the endpoint belongs to.
", + "smithy.api#required": {} + } + }, + "harnessName": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessName", + "traits": { + "smithy.api#documentation": "The name of the harness that the endpoint belongs to.
", + "smithy.api#required": {} + } + }, + "endpointName": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointName", + "traits": { + "smithy.api#documentation": "The name of the endpoint.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointArn", + "traits": { + "smithy.api#documentation": "The ARN of the endpoint.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointStatus", + "traits": { + "smithy.api#documentation": "The status of the endpoint.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the endpoint was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the endpoint was last updated.
", + "smithy.api#required": {} + } + }, + "liveVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessVersion", + "traits": { + "smithy.api#documentation": "The harness version that the endpoint is currently serving.
" + } + }, + "targetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessVersion", + "traits": { + "smithy.api#documentation": "The harness version that the endpoint points to. While an update is in progress, this can differ from the live version until the endpoint finishes transitioning.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointDescription", + "traits": { + "smithy.api#documentation": "The description of the endpoint.
" + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason the endpoint's last create or update operation failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Representation of a harness endpoint. An endpoint is a named, stable reference to a specific version of a harness that callers invoke, allowing the underlying version to be updated without changing how the agent is invoked.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:([^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:harness/[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}/harness-endpoint/[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateHarnessEndpoint" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteHarnessEndpoint" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#GetHarnessEndpoint" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListHarnessEndpoints" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateHarnessEndpoint" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessEndpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpoint" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessEnvironmentArtifact": { + "type": "union", + "members": { + "containerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#ContainerConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "The environment artifact for a harness, such as a container image containing custom dependencies.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessEnvironmentProvider": { + "type": "union", + "members": { + "agentCoreRuntimeEnvironment": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreRuntimeEnvironment", + "traits": { + "smithy.api#documentation": "The AgentCore Runtime environment configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The environment provider for a harness.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessEnvironmentProviderRequest": { + "type": "union", + "members": { + "agentCoreRuntimeEnvironment": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreRuntimeEnvironmentRequest", + "traits": { + "smithy.api#documentation": "The AgentCore Runtime environment configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The environment provider request configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessGatewayOutboundAuth": { + "type": "union", + "members": { + "awsIam": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "SigV4-sign requests using the agent's execution role.
" + } + }, + "none": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "No authentication.
" + } + }, + "oauth": { + "target": "com.amazonaws.bedrockagentcorecontrol#OAuthCredentialProvider", + "traits": { + "smithy.api#documentation": "Use OAuth credentials for outbound authentication to the gateway.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Authentication method for calling a Gateway.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessGeminiModelConfig": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModelId", + "traits": { + "smithy.api#documentation": "The Gemini model ID.
", + "smithy.api#required": {} + } + }, + "apiKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of your Gemini API key on AgentCore Identity.
", + "smithy.api#required": {} + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxTokens", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to allow in the generated response per model call.
" + } + }, + "temperature": { + "target": "com.amazonaws.bedrockagentcorecontrol#Temperature", + "traits": { + "smithy.api#documentation": "The temperature to set when calling the model.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagentcorecontrol#TopP", + "traits": { + "smithy.api#documentation": "The topP set when calling the model.
" + } + }, + "topK": { + "target": "com.amazonaws.bedrockagentcorecontrol#TopK", + "traits": { + "smithy.api#documentation": "The topK set when calling the model.
" + } + }, + "additionalParams": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Provider-specific parameters passed through to the Gemini model provider unchanged.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a Google Gemini model provider. Requires an API key stored in AgentCore Identity.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessInlineFunctionConfig": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessInlineFunctionDescription", + "traits": { + "smithy.api#documentation": "Description of what the tool does, provided to the model.
", + "smithy.api#required": {} + } + }, + "inputSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#SensitiveJson", + "traits": { + "smithy.api#documentation": "JSON Schema describing the tool's input parameters.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for an inline function tool. When the agent calls this tool, the tool call is returned to the caller for external execution.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessInlineFunctionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessLiteLlmApiBase": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16383 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessLiteLlmModelConfig": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModelId", + "traits": { + "smithy.api#documentation": "The LiteLLM model identifier (e.g., \"anthropic/claude-3-sonnet\").
", + "smithy.api#required": {} + } + }, + "apiKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the API key in AgentCore Identity for authenticating with the model provider.
" + } + }, + "apiBase": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessLiteLlmApiBase", + "traits": { + "smithy.api#documentation": "The base URL for the model provider's API endpoint.
" + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxTokens", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to allow in the generated response per iteration.
" + } + }, + "temperature": { + "target": "com.amazonaws.bedrockagentcorecontrol#Temperature", + "traits": { + "smithy.api#documentation": "The temperature to set when calling the model.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagentcorecontrol#TopP", + "traits": { + "smithy.api#documentation": "The topP set when calling the model.
" + } + }, + "additionalParams": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Provider-specific parameters passed through to the model provider unchanged.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a LiteLLM model provider, enabling connection to third-party model providers.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessManagedMemoryConfiguration": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryArn", + "traits": { + "smithy.api#documentation": "The ARN of the managed AgentCore Memory resource. Read-only on Get, ignored on Create/Update input.
" + } + }, + "strategies": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessManagedMemoryStrategyList", + "traits": { + "smithy.api#documentation": "Strategy types to enable. Defaults to [SEMANTIC, SUMMARIZATION].
" + } + }, + "eventExpiryDuration": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Event retention in days. Defaults to 30.
", + "smithy.api#range": { + "min": 3, + "max": 365 + } + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "Customer-managed KMS key. Defaults to AWS-owned key. Not updatable after creation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for managed memory creation.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessManagedMemoryStrategyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessManagedMemoryStrategyType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessManagedMemoryStrategyType": { + "type": "enum", + "members": { + "SEMANTIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEMANTIC" + } + }, + "SUMMARIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUMMARIZATION" + } + }, + "USER_PREFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_PREFERENCE" + } + }, + "EPISODIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EPISODIC" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessMemoryConfiguration": { + "type": "union", + "members": { + "agentCoreMemoryConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreMemoryConfiguration", + "traits": { + "smithy.api#documentation": "The AgentCore Memory configuration.
" + } + }, + "managedMemoryConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessManagedMemoryConfiguration", + "traits": { + "smithy.api#documentation": "Harness creates and manages a memory resource in the customer's account.
" + } + }, + "disabled": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessDisabledMemoryConfiguration", + "traits": { + "smithy.api#documentation": "Explicitly opt out of memory.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The memory configuration for a harness.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessModelConfiguration": { + "type": "union", + "members": { + "bedrockModelConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessBedrockModelConfig", + "traits": { + "smithy.api#documentation": "Configuration for an Amazon Bedrock model.
" + } + }, + "openAiModelConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessOpenAiModelConfig", + "traits": { + "smithy.api#documentation": "Configuration for an OpenAI model.
" + } + }, + "geminiModelConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessGeminiModelConfig", + "traits": { + "smithy.api#documentation": "Configuration for a Google Gemini model.
" + } + }, + "liteLlmModelConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessLiteLlmModelConfig", + "traits": { + "smithy.api#documentation": "The LiteLLM model configuration for connecting to third-party model providers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specification of which model to use.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,39}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessOpenAiApiFormat": { + "type": "enum", + "members": { + "CHAT_COMPLETIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Use the Chat Completions API format.
", + "smithy.api#enumValue": "chat_completions" + } + }, + "RESPONSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Use the Responses API format.
", + "smithy.api#enumValue": "responses" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessOpenAiModelConfig": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModelId", + "traits": { + "smithy.api#documentation": "The OpenAI model ID.
", + "smithy.api#required": {} + } + }, + "apiKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of your OpenAI API key on AgentCore Identity.
", + "smithy.api#required": {} + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxTokens", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to allow in the generated response per model call.
" + } + }, + "temperature": { + "target": "com.amazonaws.bedrockagentcorecontrol#Temperature", + "traits": { + "smithy.api#documentation": "The temperature to set when calling the model.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagentcorecontrol#TopP", + "traits": { + "smithy.api#documentation": "The topP set when calling the model.
" + } + }, + "apiFormat": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessOpenAiApiFormat", + "traits": { + "smithy.api#documentation": "The API format to use when calling the OpenAI provider.
" + } + }, + "additionalParams": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Provider-specific parameters passed through to the model provider unchanged.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for an OpenAI model provider. Requires an API key stored in AgentCore Identity.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessRemoteMcpConfig": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessRemoteMcpUrl", + "traits": { + "smithy.api#documentation": "URL of the MCP endpoint.
", + "smithy.api#required": {} + } + }, + "headers": { + "target": "com.amazonaws.bedrockagentcorecontrol#HttpHeadersMap", + "traits": { + "smithy.api#documentation": "Custom headers to include when connecting to the remote MCP server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for connecting to a remote MCP server.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessRemoteMcpUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16383 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateHarness" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteHarness" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#GetHarness" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListHarnesses" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListHarnessVersions" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateHarness" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSkill": { + "type": "union", + "members": { + "path": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSkillPath", + "traits": { + "smithy.api#documentation": "The filesystem path to the skill definition.
" + } + }, + "s3": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSkillS3Source", + "traits": { + "smithy.api#documentation": "An S3 source containing the skill.
" + } + }, + "git": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSkillGitSource", + "traits": { + "smithy.api#documentation": "A git repository containing the skill.
" + } + }, + "awsSkills": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSkillAwsSkillsSource", + "traits": { + "smithy.api#documentation": "AWS Skills baked into the harness's underlying Runtime.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A skill available to the agent.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSkillAwsSkillsSource": { + "type": "structure", + "members": { + "paths": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAwsSkillPaths", + "traits": { + "smithy.api#documentation": "Optionally filter allowed skills with glob syntax, e.g., ['core-skills/*'].
" + } + } + }, + "traits": { + "smithy.api#documentation": "Passed to show that AWS Skills should be included.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSkillGitAuth": { + "type": "structure", + "members": { + "credentialArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the credential in AgentCore Identity containing the password or personal access token.
", + "smithy.api#required": {} + } + }, + "username": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Username for authentication. Defaults to 'oauth2' if not specified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Authentication configuration for accessing a private git repository.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSkillGitSource": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSkillGitUrl", + "traits": { + "smithy.api#documentation": "The HTTPS URL of the git repository.
", + "smithy.api#required": {} + } + }, + "path": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Subdirectory within the repository containing the skill.
" + } + }, + "auth": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSkillGitAuth", + "traits": { + "smithy.api#documentation": "Authentication configuration for private repositories.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A git repository source for a skill.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSkillGitUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 16383 + }, + "smithy.api#pattern": "^https://[^#@]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSkillPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSkillS3Source": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSkillS3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI pointing to the skill directory (e.g., s3://bucket/skills/my-skill/).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An S3 source for a skill.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSkillS3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 16383 + }, + "smithy.api#pattern": "^s3://" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSkills": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSkill" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSlidingWindowConfiguration": { + "type": "structure", + "members": { + "messagesCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of recent messages to retain in the context window.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for sliding window truncation strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSummarizationConfiguration": { + "type": "structure", + "members": { + "summaryRatio": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "The ratio of content to summarize.
" + } + }, + "preserveRecentMessages": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of recent messages to preserve without summarization.
" + } + }, + "summarizationSystemPrompt": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The system prompt used for generating summaries.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for summarization-based truncation strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSummary": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness.
", + "smithy.api#required": {} + } + }, + "harnessName": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessName", + "traits": { + "smithy.api#documentation": "The name of the harness.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessArn", + "traits": { + "smithy.api#documentation": "The ARN of the harness.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessStatus", + "traits": { + "smithy.api#documentation": "The current status of the harness.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the harness was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the harness was last updated.
", + "smithy.api#required": {} + } + }, + "harnessVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessVersion", + "traits": { + "smithy.api#documentation": "The latest version of the harness.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a harness.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSystemContentBlock": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentcorecontrol#SensitiveText", + "traits": { + "smithy.api#documentation": "The text content of the system prompt block.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A content block in the system prompt.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessSystemPrompt": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSystemContentBlock" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessTool": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessToolType", + "traits": { + "smithy.api#documentation": "The type of tool.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessToolName", + "traits": { + "smithy.api#documentation": "Unique name for the tool. If not provided, a name will be inferred or generated.
" + } + }, + "config": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessToolConfiguration", + "traits": { + "smithy.api#documentation": "Tool-specific configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A tool available to the agent loop.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessToolConfiguration": { + "type": "union", + "members": { + "remoteMcp": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessRemoteMcpConfig", + "traits": { + "smithy.api#documentation": "Configuration for remote MCP server.
" + } + }, + "agentCoreBrowser": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreBrowserConfig", + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Browser.
" + } + }, + "agentCoreGateway": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreGatewayConfig", + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Gateway.
" + } + }, + "inlineFunction": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessInlineFunctionConfig", + "traits": { + "smithy.api#documentation": "Configuration for an inline function tool.
" + } + }, + "agentCoreCodeInterpreter": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAgentCoreCodeInterpreterConfig", + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Code Interpreter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration union for different tool types.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessToolName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessToolType": { + "type": "enum", + "members": { + "REMOTE_MCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "remote_mcp" + } + }, + "AGENTCORE_BROWSER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "agentcore_browser" + } + }, + "AGENTCORE_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "agentcore_gateway" + } + }, + "INLINE_FUNCTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inline_function" + } + }, + "AGENTCORE_CODE_INTERPRETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "agentcore_code_interpreter" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessTools": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessTool" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessTruncationConfiguration": { + "type": "structure", + "members": { + "strategy": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessTruncationStrategy", + "traits": { + "smithy.api#documentation": "The truncation strategy to use.
", + "smithy.api#required": {} + } + }, + "config": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessTruncationStrategyConfiguration", + "traits": { + "smithy.api#documentation": "The strategy-specific configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for truncating conversation context when it exceeds model limits.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessTruncationStrategy": { + "type": "enum", + "members": { + "SLIDING_WINDOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sliding_window" + } + }, + "SUMMARIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "summarization" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessTruncationStrategyConfiguration": { + "type": "union", + "members": { + "slidingWindow": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSlidingWindowConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for sliding window truncation.
" + } + }, + "summarization": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSummarizationConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for summarization-based truncation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Strategy-specific truncation configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^([1-9][0-9]{0,4})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessVersionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessVersionSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HarnessVersionSummary": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness.
", + "smithy.api#required": {} + } + }, + "harnessName": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessName", + "traits": { + "smithy.api#documentation": "The name of the harness.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessArn", + "traits": { + "smithy.api#documentation": "The ARN of the harness.
", + "smithy.api#required": {} + } + }, + "harnessVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessVersion", + "traits": { + "smithy.api#documentation": "The version of the harness that this summary describes.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessStatus", + "traits": { + "smithy.api#documentation": "The status of this harness version.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this harness version was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this harness version was last updated.
", + "smithy.api#required": {} + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Reason why the create or update operation for this harness version failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a single version of a harness.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HeaderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_-]{0,255}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HostingEnvironment": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#BedrockAgentcoreResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hosting environment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A hosting environment whose workloads are allowed to invoke the target. At launch, the only supported hosting environment is AgentCore Gateway.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HostingEnvironmentListType": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HostingEnvironment" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#HttpApiSchemaConfiguration": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiSchemaConfiguration", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The API schema configuration for an HTTP target. This schema defines the API structure that the target exposes.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#HttpHeaderKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "The key of an HTTP header.", + "smithy.api#length": { + "min": 1, + "max": 16383 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HttpHeaderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HttpHeaderValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "The value of an HTTP header.", + "smithy.api#length": { + "min": 1, + "max": 16383 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HttpHeadersMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcorecontrol#HttpHeaderKey" + }, + "value": { + "target": "com.amazonaws.bedrockagentcorecontrol#HttpHeaderValue" + }, + "traits": { + "smithy.api#documentation": "Map of key/value pairs for HTTP headers.", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#HttpQueryParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#HttpTargetConfiguration": { + "type": "union", + "members": { + "agentcoreRuntime": { + "target": "com.amazonaws.bedrockagentcorecontrol#RuntimeTargetConfiguration", + "traits": { + "smithy.api#documentation": "The AgentCore Runtime target configuration for HTTP-based communication with an agent runtime.
" + } + }, + "passthrough": { + "target": "com.amazonaws.bedrockagentcorecontrol#PassthroughTargetConfiguration", + "traits": { + "smithy.api#documentation": "The passthrough configuration for the HTTP target. A passthrough target forwards requests directly to an external HTTP endpoint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The HTTP target configuration for a gateway target. Contains the configuration for HTTP-based target endpoints.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#IamCredentialProvider": { + "type": "structure", + "members": { + "service": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The target Amazon Web Services service name used for SigV4 signing. This value identifies the service that the gateway authenticates with when making requests to the target endpoint.
", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$", + "smithy.api#required": {} + } + }, + "region": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region used for SigV4 signing. If not specified, defaults to the gateway's Region.
", + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + } + }, + "traits": { + "smithy.api#documentation": "An IAM credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using IAM credentials and SigV4 signing.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#IamPrincipal": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#IamPrincipalArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM principal. Supports user, role, and assumed-role ARNs. Wildcards can be used with the StringLike operator.
The match operator. StringEquals requires an exact match. StringLike supports wildcard patterns using * and ?.
An IAM principal specification for rule matching.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#IamPrincipalArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws[a-zA-Z-]*:iam::(\\d{12}|\\*):(user|role)/[\\w+=,.@*?/-]+|arn:aws[a-zA-Z-]*:sts::(\\d{12}|\\*):assumed-role/[\\w+=,.@*?/-]+)$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#IamSigningRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-z0-9-]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#IamSigningServiceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InboundTokenClaimNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z0-9_.-:]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InboundTokenClaimValueType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "STRING_ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING_ARRAY" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#IncludedData": { + "type": "enum", + "members": { + "ALL_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_DATA" + } + }, + "METADATA_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METADATA_ONLY" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#IncludedOauth2ProviderConfigInput": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the supported OAuth2 provider. This identifier is assigned by the OAuth2 provider when you register your application.
", + "smithy.api#required": {} + } + }, + "clientSecret": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultClientSecretType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The client secret for the supported OAuth2 provider. This secret is assigned by the OAuth2 provider and used along with the client ID to authenticate your application.
" + } + }, + "clientSecretConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretReference", + "traits": { + "smithy.api#documentation": "A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.
The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
Token issuer of your isolated OAuth2 application tenant. This URL identifies the authorization server that issues tokens for this provider.
" + } + }, + "authorizationEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizationEndpointType", + "traits": { + "smithy.api#documentation": "OAuth2 authorization endpoint for your isolated OAuth2 application tenant. This is where users are redirected to authenticate and authorize access to their resources.
" + } + }, + "tokenEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#TokenEndpointType", + "traits": { + "smithy.api#documentation": "OAuth2 token endpoint for your isolated OAuth2 application tenant. This is where authorization codes are exchanged for access tokens.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for connecting to a supported OAuth2 provider. This includes client credentials and OAuth2 discovery information for providers that have built-in support.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#IncludedOauth2ProviderConfigOutput": { + "type": "structure", + "members": { + "oauthDiscovery": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2Discovery", + "traits": { + "smithy.api#required": {} + } + }, + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the supported OAuth2 provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details returned for a supported OAuth2 provider, including client credentials and OAuth2 discovery information.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#IndexedKey": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrockagentcorecontrol#MetadataKey", + "traits": { + "smithy.api#documentation": "The metadata key name to index.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#MetadataValueType", + "traits": { + "smithy.api#documentation": "The data type of the indexed key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A metadata key indexed for filtering.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#IndexedKeysList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#IndexedKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#InferenceConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to generate in the model response during evaluation.
", + "smithy.api#range": { + "min": 1 + } + } + }, + "temperature": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "The temperature value that controls randomness in the model's responses. Lower values produce more deterministic outputs.
", + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "topP": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "The top-p sampling parameter that controls the diversity of the model's responses by limiting the cumulative probability of token choices.
", + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "stopSequences": { + "target": "com.amazonaws.bedrockagentcorecontrol#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "The list of sequences that will cause the model to stop generating tokens when encountered.
", + "smithy.api#length": { + "max": 2500 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration parameters that control how the foundation model behaves during evaluation, including response generation settings.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InferenceConnectorId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#InferenceConnectorSource": { + "type": "structure", + "members": { + "connectorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#InferenceConnectorId", + "traits": { + "smithy.api#documentation": "The identifier for the inference connector (for example, bedrock-mantle, openai, or anthropic).
The source identifying the inference connector.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InferenceConnectorTargetConfiguration": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.bedrockagentcorecontrol#InferenceConnectorSource", + "traits": { + "smithy.api#documentation": "The source configuration identifying which inference connector to use.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a connector-based inference target. This configuration uses a built-in connector that provides predefined rules for a large language model (LLM) provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InferenceOperationConfiguration": { + "type": "structure", + "members": { + "path": { + "target": "com.amazonaws.bedrockagentcorecontrol#InferenceOperationPath", + "traits": { + "smithy.api#documentation": "The request path for this operation (for example, /v1/messages or /v1/responses).
The provider path to forward requests to, if it differs from the request path. For example, /anthropic/v1/messages when the provider expects a different path than the client-facing /v1/messages.
The list of models supported for this operation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a specific inference operation, including its request path and the models that the operation supports.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InferenceOperationConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#InferenceOperationConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#InferenceOperationPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^/[a-zA-Z0-9\\-\\._/]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InferenceProviderTargetConfiguration": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#PassthroughEndpoint", + "traits": { + "smithy.api#documentation": "The HTTPS endpoint of the inference provider that the gateway forwards requests to.
", + "smithy.api#required": {} + } + }, + "modelMapping": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModelMapping", + "traits": { + "smithy.api#documentation": "The configuration that translates client-facing model IDs to the model IDs expected by the provider.
" + } + }, + "operations": { + "target": "com.amazonaws.bedrockagentcorecontrol#InferenceOperationConfigurations", + "traits": { + "smithy.api#documentation": "A list of per-operation configurations that map request paths to the models supported for each operation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a provider-based inference target. This configuration explicitly defines the endpoint, model mapping, and operations used to route requests to a large language model (LLM) provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InferenceTargetConfiguration": { + "type": "union", + "members": { + "connector": { + "target": "com.amazonaws.bedrockagentcorecontrol#InferenceConnectorTargetConfiguration", + "traits": { + "smithy.api#documentation": "The connector-based inference configuration. Use this option to route requests to an LLM provider through a built-in connector that includes predefined provider rules.
" + } + }, + "provider": { + "target": "com.amazonaws.bedrockagentcorecontrol#InferenceProviderTargetConfiguration", + "traits": { + "smithy.api#documentation": "The provider-based inference configuration. Use this option to explicitly configure the endpoint, model mapping, and operations for an LLM provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for an inference target. An inference target routes requests to a large language model (LLM) provider, either through a built-in connector or an explicitly configured provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InlineContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 102400 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#InlineExamplesSource": { + "type": "structure", + "members": { + "examples": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetExampleList", + "traits": { + "smithy.api#documentation": "Examples to add. Each example is assigned an auto-generated UUID.
", + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Inline examples provided directly in the request body.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InlinePayload": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#Insight": { + "type": "structure", + "members": { + "insightId": { + "target": "com.amazonaws.bedrockagentcorecontrol#InsightId", + "traits": { + "smithy.api#documentation": "The unique identifier of the insight to run.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to an insight analysis to run against sessions during evaluation. Insights provide deeper analysis beyond individual evaluator scores, including failure detection, user intent clustering, and execution summarization.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InsightId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Canonical insight identifiers using the Builtin.Insight.* naming convention.\nUsed by BatchEvaluate, InternalEvaluate, and ServiceEngineEvaluate flows.", + "smithy.api#pattern": "^(Builtin\\.[a-zA-Z0-9._-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InsightList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#Insight" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#InterceptorConfiguration": { + "type": "union", + "members": { + "lambda": { + "target": "com.amazonaws.bedrockagentcorecontrol#LambdaInterceptorConfiguration", + "traits": { + "smithy.api#documentation": "The details of the lambda function used for the interceptor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The interceptor configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InterceptorInputConfiguration": { + "type": "structure", + "members": { + "passRequestHeaders": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to pass request headers as input into the interceptor. When set to true, request headers will be passed.
", + "smithy.api#required": {} + } + }, + "payloadFilter": { + "target": "com.amazonaws.bedrockagentcorecontrol#InterceptorPayloadFilter", + "traits": { + "smithy.api#documentation": "The filter that determines which parts of the request or response payload are passed as input to the interceptor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input configuration of the interceptor.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InterceptorPayloadExclusion": { + "type": "enum", + "members": { + "RESPONSE_BODY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESPONSE_BODY" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#InterceptorPayloadExclusionSelector": { + "type": "union", + "members": { + "field": { + "target": "com.amazonaws.bedrockagentcorecontrol#InterceptorPayloadExclusion", + "traits": { + "smithy.api#documentation": "The field to exclude from the interceptor input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A selector that identifies a payload field to exclude from the interceptor input.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InterceptorPayloadExclusionSelectorList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#InterceptorPayloadExclusionSelector" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#InterceptorPayloadFilter": { + "type": "structure", + "members": { + "exclude": { + "target": "com.amazonaws.bedrockagentcorecontrol#InterceptorPayloadExclusionSelectorList", + "traits": { + "smithy.api#documentation": "The list of selectors that identify payload fields to exclude from the interceptor input.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter that controls which fields of the request or response payload are included in the input to the interceptor.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcorecontrol#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown if there was an unexpected error during processing of request
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockagentcorecontrol#InvocationConfiguration": { + "type": "structure", + "members": { + "topicArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the SNS topic for job notifications.
", + "smithy.api#required": {} + } + }, + "payloadDeliveryBucketName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The S3 bucket name for event payload delivery.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration to invoke a self-managed memory processing pipeline with.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#InvocationConfigurationInput": { + "type": "structure", + "members": { + "topicArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the SNS topic for job notifications.
", + "smithy.api#required": {} + } + }, + "payloadDeliveryBucketName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The S3 bucket name for event payload delivery.
", + "smithy.api#pattern": "^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration to invoke a self-managed memory processing pipeline with.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#IssuerUrlType": { + "type": "string" + }, + "com.amazonaws.bedrockagentcorecontrol#KeyType": { + "type": "enum", + "members": { + "CustomerManagedKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CustomerManagedKey" + } + }, + "ServiceManagedKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceManagedKey" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#KinesisResource": { + "type": "structure", + "members": { + "dataStreamArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Arn", + "traits": { + "smithy.api#documentation": "ARN of the Kinesis Data Stream.
", + "smithy.api#required": {} + } + }, + "contentConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#ContentConfigurationList", + "traits": { + "smithy.api#documentation": "Content configurations for stream delivery.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for Kinesis Data Stream delivery.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#KmsConfiguration": { + "type": "structure", + "members": { + "keyType": { + "target": "com.amazonaws.bedrockagentcorecontrol#KeyType", + "traits": { + "smithy.api#documentation": "The type of KMS key (CustomerManagedKey or ServiceManagedKey).
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the KMS configuration for a resource.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#KmsKeySourceType": { + "type": "structure", + "members": { + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to sign the JWT client assertion. The key must be an asymmetric key with key usage SIGN_VERIFY and a key spec compatible with the configured signing algorithm.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the KMS key configuration for a JWT client assertion.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\\d{1}):(\\d{12}):function:([a-zA-Z0-9-_.]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#LambdaEvaluatorConfig": { + "type": "structure", + "members": { + "lambdaArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function that implements the evaluation logic.
", + "smithy.api#required": {} + } + }, + "lambdaTimeoutInSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The timeout in seconds for the Lambda function invocation. Defaults to 60. Must be between 1 and 300.
", + "smithy.api#range": { + "min": 1, + "max": 300 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a Lambda function used as a code-based evaluator.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#LambdaFunctionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 170 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\\d{1}):(\\d{12}):function:([a-zA-Z0-9-_.]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#LambdaInterceptorConfiguration": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "The arn of the lambda function to be invoked for the interceptor.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The lambda configuration for the interceptor
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#LambdaTransformConfiguration": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to transform data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda configuration for custom transformations. This structure defines the Lambda function that the gateway invokes to transform data.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#LifecycleConfiguration": { + "type": "structure", + "members": { + "idleRuntimeSessionTimeout": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Timeout in seconds for idle runtime sessions. When a session remains idle for this duration, it will be automatically terminated. Default: 900 seconds (15 minutes).
", + "smithy.api#range": { + "min": 60, + "max": 28800 + } + } + }, + "maxLifetime": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Maximum lifetime for the instance in seconds. Once reached, instances will be automatically terminated and replaced. Default: 28800 seconds (8 hours).
", + "smithy.api#range": { + "min": 60, + "max": 28800 + } + } + } + }, + "traits": { + "smithy.api#documentation": "LifecycleConfiguration lets you manage the lifecycle of runtime sessions and resources in AgentCore Runtime. This configuration helps optimize resource utilization by automatically cleaning up idle sessions and preventing long-running instances from consuming resources indefinitely.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#LinkedinOauth2ProviderConfigInput": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the LinkedIn OAuth2 provider. This identifier is assigned by LinkedIn when you register your application.
", + "smithy.api#required": {} + } + }, + "clientSecret": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultClientSecretType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The client secret for the LinkedIn OAuth2 provider. This secret is assigned by LinkedIn and used along with the client ID to authenticate your application.
" + } + }, + "clientSecretConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretReference", + "traits": { + "smithy.api#documentation": "A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.
The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
Configuration settings for connecting to LinkedIn services using OAuth2 authentication. This includes the client credentials required to authenticate with LinkedIn's OAuth2 authorization server.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#LinkedinOauth2ProviderConfigOutput": { + "type": "structure", + "members": { + "oauthDiscovery": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2Discovery", + "traits": { + "smithy.api#required": {} + } + }, + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the LinkedIn OAuth2 provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details returned for a LinkedIn OAuth2 provider, including the client ID and OAuth2 discovery information.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeEndpointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all endpoints for a specific Amazon Secure Agent.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/runtimes/{agentRuntimeId}/runtime-endpoints/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "runtimeEndpoints" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeEndpointsRequest": { + "type": "structure", + "members": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime to list endpoints for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeEndpointsResponse": { + "type": "structure", + "members": { + "runtimeEndpoints": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpoints", + "traits": { + "smithy.api#documentation": "The list of AgentCore Runtime endpoints.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeVersionsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all versions of a specific Amazon Secure Agent.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/runtimes/{agentRuntimeId}/versions/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentRuntimes" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeVersionsRequest": { + "type": "structure", + "members": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime to list versions for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeVersionsResponse": { + "type": "structure", + "members": { + "agentRuntimes": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimes", + "traits": { + "smithy.api#documentation": "The list of AgentCore Runtime versions.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimes": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all Amazon Secure Agents in your account.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/runtimes/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentRuntimes" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimesResponse": { + "type": "structure", + "members": { + "agentRuntimes": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimes", + "traits": { + "smithy.api#documentation": "The list of AgentCore Runtime resources.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListApiKeyCredentialProviders": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListApiKeyCredentialProvidersRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListApiKeyCredentialProvidersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Lists all API key credential providers in your account.
", + "smithy.api#http": { + "uri": "/identities/ListApiKeyCredentialProviders", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "credentialProviders" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListApiKeyCredentialProvidersRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Pagination token.
" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "Maximum number of results to return.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListApiKeyCredentialProvidersResponse": { + "type": "structure", + "members": { + "credentialProviders": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProviders", + "traits": { + "smithy.api#documentation": "The list of API key credential providers.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Pagination token for the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListBrowserProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListBrowserProfilesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListBrowserProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all browser profiles in your account.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/browser-profiles" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "profileSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListBrowserProfilesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileName", + "traits": { + "smithy.api#documentation": "The name of the browser profile to filter results by.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListBrowserProfilesResponse": { + "type": "structure", + "members": { + "profileSummaries": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserProfileSummaries", + "traits": { + "smithy.api#documentation": "The list of browser profile summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListBrowsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListBrowsersRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListBrowsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all custom browsers in your account.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/browsers" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "browserSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListBrowsersRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceType", + "traits": { + "smithy.api#documentation": "The type of browsers to list. If not specified, all browser types are returned.
", + "smithy.api#httpQuery": "type" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListBrowsersResponse": { + "type": "structure", + "members": { + "browserSummaries": { + "target": "com.amazonaws.bedrockagentcorecontrol#BrowserSummaries", + "traits": { + "smithy.api#documentation": "The list of browser summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListCodeInterpreters": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListCodeInterpretersRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListCodeInterpretersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all custom code interpreters in your account.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/code-interpreters" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "codeInterpreterSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListCodeInterpretersRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceType", + "traits": { + "smithy.api#documentation": "The type of code interpreters to list.
", + "smithy.api#httpQuery": "type" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListCodeInterpretersResponse": { + "type": "structure", + "members": { + "codeInterpreterSummaries": { + "target": "com.amazonaws.bedrockagentcorecontrol#CodeInterpreterSummaries", + "traits": { + "smithy.api#documentation": "The list of code interpreter summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A token to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListConfigurationBundleVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListConfigurationBundleVersionsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListConfigurationBundleVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all versions of a configuration bundle, with optional filtering by branch name or creation source.
", + "smithy.api#http": { + "method": "POST", + "uri": "/configuration-bundles/{bundleId}/versions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "versions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListConfigurationBundleVersionsRequest": { + "type": "structure", + "members": { + "bundleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the configuration bundle to list versions for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
An optional filter for listing versions, including branch name, creation source, and whether to return only the latest version per branch.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListConfigurationBundleVersionsResponse": { + "type": "structure", + "members": { + "versions": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersionSummaryList", + "traits": { + "smithy.api#documentation": "The list of configuration bundle version summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists all configuration bundles in the account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/configuration-bundles" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "bundles" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListConfigurationBundlesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The list of configuration bundle summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns paginated examples from the dataset. The server embeds the resolved version in the pagination token. Once pagination begins, all subsequent pages are pinned to that version regardless of concurrent mutations.
", + "smithy.api#http": { + "method": "GET", + "uri": "/datasets/{datasetId}/examples" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "examples" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListDatasetExamplesRequest": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "datasetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetVersion", + "traits": { + "smithy.api#documentation": "Version to paginate: \"DRAFT\" or a version number. Defaults to DRAFT if absent. Only used on the first request; for subsequent pages, the version is extracted from the pagination token.
", + "smithy.api#httpQuery": "datasetVersion" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Maximum number of examples to return per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "max": 2048 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListDatasetExamplesResponse": { + "type": "structure", + "members": { + "datasetArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
", + "smithy.api#required": {} + } + }, + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset.
", + "smithy.api#required": {} + } + }, + "datasetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetVersion", + "traits": { + "smithy.api#documentation": "The version returned.
", + "smithy.api#required": {} + } + }, + "examples": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetExampleList", + "traits": { + "smithy.api#documentation": " Paginated example content. Each element is a JSON object containing at least an exampleId field plus the schema-specific content fields.
The token for the next page of results, or null if there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListDatasetVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListDatasetVersionsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListDatasetVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all published versions of a dataset, sorted by version number descending (newest first). Does not include the DRAFT working copy.
", + "smithy.api#http": { + "method": "GET", + "uri": "/datasets/{datasetId}/versions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "versions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListDatasetVersionsRequest": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of versions to return per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListDatasetVersionsResponse": { + "type": "structure", + "members": { + "versions": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetVersionSummaryList", + "traits": { + "smithy.api#documentation": "The list of published dataset versions.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next page of results, or null if there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListDatasets": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListDatasetsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListDatasetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all datasets in the caller's account, paginated.
", + "smithy.api#http": { + "method": "GET", + "uri": "/datasets" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "datasets" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListDatasetsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "max": 2048 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of datasets to return per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListDatasetsResponse": { + "type": "structure", + "members": { + "datasets": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetSummaryList", + "traits": { + "smithy.api#documentation": "The list of datasets.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next page of results, or null if there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListEvaluators": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListEvaluatorsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListEvaluatorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.
", + "smithy.api#http": { + "method": "POST", + "uri": "/evaluators" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "evaluators" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListEvaluatorsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of evaluators to return in a single response.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListEvaluatorsResponse": { + "type": "structure", + "members": { + "evaluators": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorSummaryList", + "traits": { + "smithy.api#documentation": "The list of evaluator summaries containing basic information about each evaluator.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pagination token to use in a subsequent request to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListGatewayRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListGatewayRulesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListGatewayRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all rules for a gateway.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/gateways/{gatewayIdentifier}/rules" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "gatewayRules" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListGatewayRulesRequest": { + "type": "structure", + "members": { + "gatewayIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the gateway to list rules for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The pagination token from a previous request.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListGatewayRulesResponse": { + "type": "structure", + "members": { + "gatewayRules": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRules", + "traits": { + "smithy.api#documentation": "The list of gateway rules.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleNextToken", + "traits": { + "smithy.api#documentation": "The pagination token to use in a subsequent request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListGatewayTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListGatewayTargetsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListGatewayTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all targets for a specific gateway.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/gateways/{gatewayIdentifier}/targets/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListGatewayTargetsRequest": { + "type": "structure", + "members": { + "gatewayIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the gateway to list targets for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The list of gateway target summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetNextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists all gateways in the account.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/gateways/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListGatewaysRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The list of gateway summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayNextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Operation to list the endpoints of a harness.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/harnesses/{harnessId}/endpoints" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "endpoints" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListHarnessEndpointsRequest": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness whose endpoints are listed.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListHarnessEndpointsResponse": { + "type": "structure", + "members": { + "endpoints": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpoints", + "traits": { + "smithy.api#documentation": "The list of harness endpoints.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListHarnessVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListHarnessVersionsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListHarnessVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Operation to list the versions of a Harness.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/harnesses/{harnessId}/versions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "harnessVersions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListHarnessVersionsRequest": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness whose versions are listed.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListHarnessVersionsResponse": { + "type": "structure", + "members": { + "harnessVersions": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessVersionSummaries", + "traits": { + "smithy.api#documentation": "The list of harness version summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListHarnesses": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListHarnessesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListHarnessesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Operation to list harnesses.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/harnesses" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "harnesses" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListHarnessesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListHarnessesResponse": { + "type": "structure", + "members": { + "harnesses": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSummaries", + "traits": { + "smithy.api#documentation": "The list of harness summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListMemories": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListMemoriesInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListMemoriesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.
", + "smithy.api#http": { + "method": "POST", + "uri": "/memories/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "memories" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListMemoriesInput": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListMemoriesOutput": { + "type": "structure", + "members": { + "memories": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemorySummaryList", + "traits": { + "smithy.api#documentation": "The list of AgentCore Memory resource summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A token to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListOauth2CredentialProviders": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListOauth2CredentialProvidersRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListOauth2CredentialProvidersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Lists all OAuth2 credential providers in your account.
", + "smithy.api#http": { + "uri": "/identities/ListOauth2CredentialProviders", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "credentialProviders" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListOauth2CredentialProvidersRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Pagination token.
" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "Maximum number of results to return.
", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListOauth2CredentialProvidersResponse": { + "type": "structure", + "members": { + "credentialProviders": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2CredentialProviders", + "traits": { + "smithy.api#documentation": "The list of OAuth2 credential providers.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Pagination token for the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListOnlineEvaluationConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListOnlineEvaluationConfigsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListOnlineEvaluationConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all online evaluation configurations in the account, providing summary information about each configuration's status and settings.
", + "smithy.api#http": { + "method": "POST", + "uri": "/online-evaluation-configs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "onlineEvaluationConfigs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListOnlineEvaluationConfigsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of online evaluation configurations to return in a single response.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListOnlineEvaluationConfigsResponse": { + "type": "structure", + "members": { + "onlineEvaluationConfigs": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigSummaryList", + "traits": { + "smithy.api#documentation": "The list of online evaluation configuration summaries containing basic information about each configuration.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pagination token to use in a subsequent request to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPaymentConnectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPaymentConnectorsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPaymentConnectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all payment connectors for a specified payment manager.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/payments/managers/{paymentManagerId}/connectors-list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "paymentConnectors" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPaymentConnectorsRequest": { + "type": "structure", + "members": { + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment manager whose connectors to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The list of payment connector summaries. For details about the fields in each summary, see the PaymentConnectorSummary data type.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists all payment credential providers in the account.
", + "smithy.api#http": { + "uri": "/identities/ListPaymentCredentialProviders", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "credentialProviders" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPaymentCredentialProvidersRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Pagination token.
" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "Maximum number of results to return.
", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPaymentCredentialProvidersResponse": { + "type": "structure", + "members": { + "credentialProviders": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviders", + "traits": { + "smithy.api#documentation": "The list of payment credential providers.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Pagination token for the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPaymentManagers": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPaymentManagersRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPaymentManagersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all payment managers in the account.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/payments/managers-list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "paymentManagers" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPaymentManagersRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The list of payment manager summaries. For details about the fields in each summary, see the PaymentManagerSummary data type.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Retrieves a list of policies within the AgentCore Policy engine. This operation supports pagination and filtering to help administrators manage and discover policies across policy engines. Results can be filtered by policy engine or resource associations.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engines/{policyEngineId}/policies", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "policies", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPoliciesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token returned from a previous ListPolicies call. Use this token to retrieve the next page of results when the response is paginated.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of policies to return in a single response. If not specified, the default is 10 policies per page, with a maximum of 100 per page.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine whose policies to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "targetResourceScope": { + "target": "com.amazonaws.bedrockagentcorecontrol#BedrockAgentcoreResourceArn", + "traits": { + "smithy.api#documentation": "Optional filter to list policies that apply to a specific resource scope or resource type. This helps narrow down policy results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.
", + "smithy.api#httpQuery": "targetResourceScope" + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource", + "ids": { + "policyEngineId": "policyEngineId" + } + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPoliciesResponse": { + "type": "structure", + "members": { + "policies": { + "target": "com.amazonaws.bedrockagentcorecontrol#Policies", + "traits": { + "smithy.api#documentation": "An array of policy objects that match the specified criteria. Each policy object contains the policy metadata, status, and key identifiers for further operations.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in subsequent ListPolicies calls to retrieve additional results. This token is only present when there are more results available.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyEngineSummaries": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyEngineSummariesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyEngineSummariesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a paginated list of metadata-only policy engine summaries without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy engine, but does not include descriptions or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engine-summaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "policyEngines", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyEngineSummariesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token returned from a previous ListPolicyEngineSummaries call. Use this token to retrieve the next page of results when the response is paginated.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of policy engine summaries to return in a single response.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyEngineSummariesResponse": { + "type": "structure", + "members": { + "policyEngines": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineSummaryList", + "traits": { + "smithy.api#documentation": "An array of policy engine summary objects that exist in the account. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in subsequent ListPolicyEngineSummaries calls to retrieve additional results. This token is only present when there are more results available.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyEngines": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyEnginesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyEnginesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of policy engines within the AgentCore Policy system. This operation supports pagination to help administrators discover and manage policy engines across their account. Each policy engine serves as a container for related policies.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engines", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "policyEngines", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyEnginesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token returned from a previous ListPolicyEngines call. Use this token to retrieve the next page of results when the response is paginated.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of policy engines to return in a single response. If not specified, the default is 10 policy engines per page, with a maximum of 100 per page.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyEnginesResponse": { + "type": "structure", + "members": { + "policyEngines": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngines", + "traits": { + "smithy.api#documentation": "An array of policy engine objects that exist in the account. Each policy engine object contains the engine metadata, status, and key identifiers for further operations.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in subsequent ListPolicyEngines calls to retrieve additional results. This token is only present when there are more results available.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationAssets": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationAssetsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationAssetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of generated policy assets from a policy generation request within the AgentCore Policy system. This operation returns the actual Cedar policies and related artifacts produced by the AI-powered policy generation process, allowing users to review and select from multiple generated policy options.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engines/{policyEngineId}/policy-generations/{policyGenerationId}/assets" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "policyGenerationAssets", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationAssetsRequest": { + "type": "structure", + "members": { + "policyGenerationId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy generation request whose assets are to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call that has completed processing.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and ensures assets are retrieved from the correct policy engine.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token returned from a previous ListPolicyGenerationAssets call. Use this token to retrieve the next page of assets when the response is paginated due to large numbers of generated policy options.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of policy generation assets to return in a single response. If not specified, the default is 10 assets per page, with a maximum of 100 per page. This helps control response size when dealing with policy generations that produce many alternative policy options.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationAssetsResponse": { + "type": "structure", + "members": { + "policyGenerationAssets": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationAssets", + "traits": { + "smithy.api#documentation": "An array of generated policy assets including Cedar policies and related artifacts from the AI-powered policy generation process. Each asset represents a different policy option or variation generated from the original natural language input.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in subsequent ListPolicyGenerationAssets calls to retrieve additional assets. This token is only present when there are more generated policy assets available beyond the current response.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationSummaries": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationSummariesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationSummariesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a paginated list of metadata-only policy generation summaries within a policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and findings for each policy generation, but does not include status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engines/{policyEngineId}/policy-generation-summaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "policyGenerations", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationSummariesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token returned from a previous ListPolicyGenerationSummaries call. Use this token to retrieve the next page of results when the response is paginated.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of policy generation summaries to return in a single response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine whose policy generation summaries to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationSummariesResponse": { + "type": "structure", + "members": { + "policyGenerations": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationSummaryList", + "traits": { + "smithy.api#documentation": "An array of policy generation summary objects that match the specified criteria. Each summary contains resource identifiers, status, timestamps, and findings without customer-encrypted content.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in subsequent ListPolicyGenerationSummaries calls to retrieve additional results. This token is only present when there are more results available.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerations": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of policy generation requests within the AgentCore Policy system. This operation supports pagination and filtering to help track and manage AI-powered policy generation operations.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engines/{policyEngineId}/policy-generations" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "policyGenerations", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token for retrieving additional policy generations when results are paginated.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of policy generations to return in a single response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine whose policy generations to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationsResponse": { + "type": "structure", + "members": { + "policyGenerations": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerations", + "traits": { + "smithy.api#documentation": "An array of policy generation objects that match the specified criteria.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token for retrieving additional policy generations if more results are available.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicySummaries": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicySummariesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicySummariesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a paginated list of metadata-only policy summaries within a policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy, but does not include policy definitions, descriptions, or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policy-engines/{policyEngineId}/policy-summaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "policies", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicySummariesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token returned from a previous ListPolicySummaries call. Use this token to retrieve the next page of results when the response is paginated.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of policy summaries to return in a single response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine whose policy summaries to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "targetResourceScope": { + "target": "com.amazonaws.bedrockagentcorecontrol#BedrockAgentcoreResourceArn", + "traits": { + "smithy.api#documentation": "Optional filter to list policy summaries that apply to a specific resource scope or resource type. This helps narrow down results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.
", + "smithy.api#httpQuery": "targetResourceScope" + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource", + "ids": { + "policyEngineId": "policyEngineId" + } + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListPolicySummariesResponse": { + "type": "structure", + "members": { + "policies": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicySummaryList", + "traits": { + "smithy.api#documentation": "An array of policy summary objects that match the specified criteria. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in subsequent ListPolicySummaries calls to retrieve additional results. This token is only present when there are more results available.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListRegistries": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListRegistriesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListRegistriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all registries in the account. You can optionally filter results by status using the status parameter, or by authorizer type using the authorizerType parameter.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
Filter registries by their current status. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.
Filter registries by their authorizer type. Possible values are CUSTOM_JWT and AWS_IAM. For more information about authorizer types, see the RegistryAuthorizerType enum.
The list of registry summaries. For details about the fields in each summary, see the RegistrySummary data type.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists registry records within a registry. You can optionally filter results using the name, status, and descriptorType parameters. When multiple filters are specified, they are combined using AND logic.
The identifier of the registry to list records from. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcorecontrol#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
Filter registry records by name.
", + "smithy.api#httpQuery": "name" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordStatus", + "traits": { + "smithy.api#documentation": "Filter registry records by their current status. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.
Filter registry records by their descriptor type. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.
The list of registry record summaries. For details about the fields in each summary, see the RegistryRecordSummary data type.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the tags associated with the specified resource.
This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "The tags associated with the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListWorkloadIdentities": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListWorkloadIdentitiesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListWorkloadIdentitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Lists all workload identities in your account.
", + "smithy.api#http": { + "uri": "/identities/ListWorkloadIdentities", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "workloadIdentities" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListWorkloadIdentitiesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Pagination token.
" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "Maximum number of results to return.
", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListWorkloadIdentitiesResponse": { + "type": "structure", + "members": { + "workloadIdentities": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityList", + "traits": { + "smithy.api#documentation": "The list of workload identities.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Pagination token for the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListingMode": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "DYNAMIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMIC" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#LlmAsAJudgeEvaluatorConfig": { + "type": "structure", + "members": { + "instructions": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorInstructions", + "traits": { + "smithy.api#documentation": "The evaluation instructions that guide the language model in assessing agent performance, including criteria and evaluation guidelines.
", + "smithy.api#required": {} + } + }, + "ratingScale": { + "target": "com.amazonaws.bedrockagentcorecontrol#RatingScale", + "traits": { + "smithy.api#documentation": "The rating scale that defines how the evaluator should score agent performance, either numerical or categorical.
", + "smithy.api#required": {} + } + }, + "modelConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorModelConfig", + "traits": { + "smithy.api#documentation": "The model configuration that specifies which foundation model to use and how to configure it for evaluation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for LLM-as-a-Judge evaluation that uses a language model to assess agent performance based on custom instructions and rating scales.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#LlmExtractionConfig": { + "type": "structure", + "members": { + "llmExtractionInstruction": { + "target": "com.amazonaws.bedrockagentcorecontrol#LlmExtractionInstruction", + "traits": { + "smithy.api#documentation": "Instructions for extraction. Supports built-in operators like LATEST_VALUE or custom natural-language instructions.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagentcorecontrol#Definition", + "traits": { + "smithy.api#documentation": "Description of what this metadata field represents.
", + "smithy.api#required": {} + } + }, + "validation": { + "target": "com.amazonaws.bedrockagentcorecontrol#Validation", + "traits": { + "smithy.api#documentation": "Validation rules to constrain extracted values.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Model-based metadata extraction configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#LlmExtractionInstruction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#LogGroupNamesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#LogGroupName" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MCPGatewayConfiguration": { + "type": "structure", + "members": { + "supportedVersions": { + "target": "com.amazonaws.bedrockagentcorecontrol#McpSupportedVersions", + "traits": { + "smithy.api#documentation": "The supported versions of the Model Context Protocol. This field specifies which versions of the protocol the gateway can use.
" + } + }, + "instructions": { + "target": "com.amazonaws.bedrockagentcorecontrol#McpInstructions", + "traits": { + "smithy.api#documentation": "The instructions for using the Model Context Protocol gateway. These instructions provide guidance on how to interact with the gateway.
" + } + }, + "searchType": { + "target": "com.amazonaws.bedrockagentcorecontrol#SearchType", + "traits": { + "smithy.api#documentation": "The search type for the Model Context Protocol gateway. This field specifies how the gateway handles search operations.
" + } + }, + "sessionConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#SessionConfiguration", + "traits": { + "smithy.api#documentation": "The session configuration for the MCP gateway. This configuration controls session behavior, including session timeout settings.
" + } + }, + "streamingConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#StreamingConfiguration", + "traits": { + "smithy.api#documentation": "The streaming configuration for the MCP gateway. This configuration controls whether response streaming is enabled for the gateway.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a Model Context Protocol (MCP) gateway. This structure defines how the gateway implements the MCP protocol.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ManagedResourceDetails": { + "type": "structure", + "members": { + "domain": { + "target": "com.amazonaws.bedrockagentcorecontrol#DomainName", + "traits": { + "smithy.api#documentation": "The domain associated with this managed resource.
" + } + }, + "resourceGatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceGatewayArn", + "traits": { + "smithy.api#documentation": "The ARN of the VPC Lattice resource gateway created in your account.
" + } + }, + "resourceAssociationArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceAssociationArn", + "traits": { + "smithy.api#documentation": "The ARN of the service network resource association.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of a resource created and managed by the gateway for private endpoint connectivity.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ManagedVpcResource": { + "type": "structure", + "members": { + "vpcIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#VpcIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the VPC that contains your private resource.
", + "smithy.api#required": {} + } + }, + "subnetIds": { + "target": "com.amazonaws.bedrockagentcorecontrol#SubnetIds", + "traits": { + "smithy.api#documentation": "The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.
", + "smithy.api#required": {} + } + }, + "endpointIpAddressType": { + "target": "com.amazonaws.bedrockagentcorecontrol#EndpointIpAddressType", + "traits": { + "smithy.api#documentation": "The IP address type for the resource configuration endpoint.
", + "smithy.api#required": {} + } + }, + "securityGroupIds": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "Tags to apply to the managed VPC Lattice resource gateway.
" + } + }, + "routingDomain": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoutingDomain", + "traits": { + "smithy.api#documentation": "An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resource gateway and resource configuration on your behalf using a service-linked role.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MatchPathPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 512 + }, + "smithy.api#pattern": "^/[\\w\\-.]+/\\*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MatchPathPatterns": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#MatchPathPattern" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MatchPaths": { + "type": "structure", + "members": { + "anyOf": { + "target": "com.amazonaws.bedrockagentcorecontrol#MatchPathPatterns", + "traits": { + "smithy.api#documentation": "A list of path patterns. The condition is met if the request path matches any of the patterns.
", + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A condition that matches requests based on the request path.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MatchPrincipalEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#MatchPrincipalEntry" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MatchPrincipalEntry": { + "type": "union", + "members": { + "iamPrincipal": { + "target": "com.amazonaws.bedrockagentcorecontrol#IamPrincipal", + "traits": { + "smithy.api#documentation": "An IAM principal to match against, specified by ARN.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Union for principal matching. Currently supports IAM principal ARN glob matching.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MatchPrincipals": { + "type": "structure", + "members": { + "anyOf": { + "target": "com.amazonaws.bedrockagentcorecontrol#MatchPrincipalEntries", + "traits": { + "smithy.api#documentation": "A list of principal entries. The condition is met if any of the entries match the caller's identity.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A condition that matches requests based on the caller's identity.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MatchValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z0-9_.-]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MatchValueStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#MatchValueString" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#MaxTokens": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#McpDescriptor": { + "type": "structure", + "members": { + "server": { + "target": "com.amazonaws.bedrockagentcorecontrol#ServerDefinition", + "traits": { + "smithy.api#documentation": "The MCP server definition, containing the server configuration and schema as defined by the MCP protocol specification.
" + } + }, + "tools": { + "target": "com.amazonaws.bedrockagentcorecontrol#ToolsDefinition", + "traits": { + "smithy.api#documentation": "The MCP tools definition, containing the tools available on the MCP server as defined by the MCP protocol specification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Model Context Protocol (MCP) descriptor for a registry record. Contains the server definition and tools definition for an MCP-compatible server. The schema is validated against the MCP protocol specification.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#McpInstructions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#McpLambdaTargetConfiguration": { + "type": "structure", + "members": { + "lambdaArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.
", + "smithy.api#required": {} + } + }, + "toolSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#ToolSchema", + "traits": { + "smithy.api#documentation": "The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda configuration for a Model Context Protocol target. This structure defines how the gateway uses a Lambda function to communicate with the target.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#McpServerTargetConfiguration": { + "type": "structure", + "members": { + "endpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The endpoint for the MCP server target configuration.
", + "smithy.api#pattern": "^https://.*", + "smithy.api#required": {} + } + }, + "mcpToolSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#McpToolSchemaConfiguration", + "traits": { + "smithy.api#documentation": "The tool schema configuration for the MCP server target. Supported only when the credential provider is configured with an authorization code grant type. Dynamic tool discovery/synchronization will be disabled when target is configured with mcpToolSchema.
" + } + }, + "listingMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListingMode", + "traits": { + "smithy.api#documentation": "The listing mode for the MCP server target configuration. MCP resources for default targets are cached at the control plane for faster access. MCP resources for dynamic targets will be dynamically retrieved when listing tools.
" + } + }, + "resourcePriority": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetResourcePriority", + "traits": { + "smithy.api#documentation": "Priority for resolving MCP server targets with shared resource URIs. Lower values take precedence. Defaults to 1000 when not set.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The target configuration for the MCP server.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#McpServerUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^https://.*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#McpSupportedVersions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#McpVersion" + } + }, + "com.amazonaws.bedrockagentcorecontrol#McpTargetConfiguration": { + "type": "union", + "members": { + "openApiSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiSchemaConfiguration", + "traits": { + "smithy.api#documentation": "The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.
" + } + }, + "smithyModel": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiSchemaConfiguration", + "traits": { + "smithy.api#documentation": "The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.
" + } + }, + "lambda": { + "target": "com.amazonaws.bedrockagentcorecontrol#McpLambdaTargetConfiguration", + "traits": { + "smithy.api#documentation": "The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.
" + } + }, + "mcpServer": { + "target": "com.amazonaws.bedrockagentcorecontrol#McpServerTargetConfiguration", + "traits": { + "smithy.api#documentation": "The MCP server specified as the gateway target.
" + } + }, + "apiGateway": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiGatewayTargetConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for an Amazon API Gateway target.
" + } + }, + "connector": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConnectorTargetConfiguration", + "traits": { + "smithy.api#documentation": "The connector integration configuration for the Model Context Protocol target. This configuration defines how the gateway uses a pre-built connector to communicate with the target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Model Context Protocol (MCP) configuration for a target. This structure defines how the gateway uses MCP to communicate with the target.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#McpToolSchemaConfiguration": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3Configuration", + "traits": { + "smithy.api#documentation": "The Amazon S3 location of the tool schema. This location contains the schema definition file.
" + } + }, + "inlinePayload": { + "target": "com.amazonaws.bedrockagentcorecontrol#InlinePayload", + "traits": { + "smithy.api#documentation": "The inline payload containing the MCP tool schema definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The MCP tool schema configuration for an MCP server target. The tool schema must be aligned with the MCP specification.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#McpVersion": { + "type": "string", + "traits": { + "smithy.api#default": "2025-03-26" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Memory": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the memory.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the memory.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#Name", + "traits": { + "smithy.api#documentation": "The name of the memory.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the memory.
" + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key used to encrypt the memory.
" + } + }, + "memoryExecutionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that provides permissions for the memory.
" + } + }, + "eventExpiryDuration": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of days after which memory events will expire.
", + "smithy.api#range": { + "min": 1, + "max": 365 + }, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryStatus", + "traits": { + "smithy.api#documentation": "The current status of the memory.
", + "smithy.api#required": {} + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for failure if the memory is in a failed state.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the memory was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the memory was last updated.
", + "smithy.api#required": {} + } + }, + "strategies": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyList", + "traits": { + "smithy.api#documentation": "The list of memory strategies associated with this memory.
" + } + }, + "indexedKeys": { + "target": "com.amazonaws.bedrockagentcorecontrol#IndexedKeysList", + "traits": { + "smithy.api#documentation": "The indexed metadata keys for this memory. Only indexed keys can be used in metadata filters.
" + } + }, + "streamDeliveryResources": { + "target": "com.amazonaws.bedrockagentcorecontrol#StreamDeliveryResources", + "traits": { + "smithy.api#documentation": "Configuration for streaming memory record data to external resources.
" + } + }, + "managedByResourceArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Arn", + "traits": { + "smithy.api#documentation": "ARN of the resource managing this memory (e.g. a harness). When set, strategy modifications and deletion are only allowed through the managing resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a memory resource.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::Memory" + }, + "smithy.api#pattern": "^arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:memory\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryRecordSchema": { + "type": "structure", + "members": { + "metadataSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#MetadataSchemaList", + "traits": { + "smithy.api#documentation": "The metadata field definitions for this strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Schema for metadata on memory records generated by a strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryResource": { + "type": "resource", + "identifiers": { + "memoryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateMemory" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetMemory" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateMemory" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteMemory" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListMemories" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryStrategy": { + "type": "structure", + "members": { + "strategyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyId", + "traits": { + "smithy.api#documentation": "The unique identifier of the memory strategy.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#Name", + "traits": { + "smithy.api#documentation": "The name of the memory strategy.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the memory strategy.
" + } + }, + "configuration": { + "target": "com.amazonaws.bedrockagentcorecontrol#StrategyConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the memory strategy.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyType", + "traits": { + "smithy.api#documentation": "The type of the memory strategy.
", + "smithy.api#required": {} + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#deprecated": { + "message": "Use namespaceTemplates instead", + "since": "2026-03-02" + }, + "smithy.api#documentation": "This is a legacy parameter. The namespaces associated with the memory strategy.
", + "smithy.api#required": {} + } + }, + "namespaceTemplates": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#documentation": "The namespaceTemplates associated with the memory strategy.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the memory strategy was created.
" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the memory strategy was last updated.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyStatus", + "traits": { + "smithy.api#documentation": "The current status of the memory strategy.
" + } + }, + "memoryRecordSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryRecordSchema", + "traits": { + "smithy.api#documentation": "Schema for metadata fields on records generated by this strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyInput": { + "type": "union", + "members": { + "semanticMemoryStrategy": { + "target": "com.amazonaws.bedrockagentcorecontrol#SemanticMemoryStrategyInput", + "traits": { + "smithy.api#documentation": "Input for creating a semantic memory strategy.
" + } + }, + "summaryMemoryStrategy": { + "target": "com.amazonaws.bedrockagentcorecontrol#SummaryMemoryStrategyInput", + "traits": { + "smithy.api#documentation": "Input for creating a summary memory strategy.
" + } + }, + "userPreferenceMemoryStrategy": { + "target": "com.amazonaws.bedrockagentcorecontrol#UserPreferenceMemoryStrategyInput", + "traits": { + "smithy.api#documentation": "Input for creating a user preference memory strategy.
" + } + }, + "customMemoryStrategy": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomMemoryStrategyInput", + "traits": { + "smithy.api#documentation": "Input for creating a custom memory strategy.
" + } + }, + "episodicMemoryStrategy": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicMemoryStrategyInput", + "traits": { + "smithy.api#documentation": "Input for creating an episodic memory strategy
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains input information for creating a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyInput" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryStrategy" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyType": { + "type": "enum", + "members": { + "SEMANTIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEMANTIC" + } + }, + "SUMMARIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUMMARIZATION" + } + }, + "USER_PREFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_PREFERENCE" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "EPISODIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EPISODIC" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemorySummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the memory.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the memory.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryStatus", + "traits": { + "smithy.api#documentation": "The current status of the memory.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the memory was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the memory was last updated.
", + "smithy.api#required": {} + } + }, + "managedByResourceArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Arn", + "traits": { + "smithy.api#documentation": "ARN of the resource managing this memory (e.g. a harness). Null if not managed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a memory resource.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemorySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemorySummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MemoryView": { + "type": "enum", + "members": { + "FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "full" + } + }, + "WITHOUT_DECRYPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "without_decryption" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#MessageBasedTrigger": { + "type": "structure", + "members": { + "messageCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of messages that trigger memory processing.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The trigger configuration based on a message.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MessageBasedTriggerInput": { + "type": "structure", + "members": { + "messageCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 6, + "smithy.api#documentation": "The number of messages that trigger memory processing.
", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The trigger configuration based on a message.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MetadataConfiguration": { + "type": "structure", + "members": { + "allowedRequestHeaders": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedRequestHeaders", + "traits": { + "smithy.api#documentation": "A list of HTTP headers that are allowed to be propagated from incoming client requests to the target.
" + } + }, + "allowedQueryParameters": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedQueryParameters", + "traits": { + "smithy.api#documentation": "A list of URL query parameters that are allowed to be propagated from incoming gateway URL to the target.
" + } + }, + "allowedResponseHeaders": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedResponseHeaders", + "traits": { + "smithy.api#documentation": "A list of HTTP headers that are allowed to be propagated from the target response back to the client.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for HTTP header and query parameter propagation between the gateway and target servers.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MetadataKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MetadataSchemaEntry": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrockagentcorecontrol#MetadataKey", + "traits": { + "smithy.api#documentation": "The metadata field name. Must match an indexed key to be queryable via metadata filters.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#MetadataValueType", + "traits": { + "smithy.api#documentation": "The MetadataValueType.
" + } + }, + "extractionType": { + "target": "com.amazonaws.bedrockagentcorecontrol#ExtractionType", + "traits": { + "smithy.api#documentation": "Specifies whether the metadata value is extracted by the LLM or passed through deterministically from the event.
" + } + }, + "extractionConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#ExtractionConfig", + "traits": { + "smithy.api#documentation": "Configuration for extracting this metadata value from conversational content. Applicable only if extractionType is LLM inferred.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A metadata field definition within a strategy's schema.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MetadataSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#MetadataSchemaEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#MetadataValueType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "STRINGLIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRINGLIST" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#MicrosoftOauth2ProviderConfigInput": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the Microsoft OAuth2 provider.
", + "smithy.api#required": {} + } + }, + "clientSecret": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultClientSecretType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The client secret for the Microsoft OAuth2 provider.
" + } + }, + "clientSecretConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretReference", + "traits": { + "smithy.api#documentation": "A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.
The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
The Microsoft Entra ID (formerly Azure AD) tenant ID for your organization. This identifies the specific tenant within Microsoft's identity platform where your application is registered.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input configuration for a Microsoft OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MicrosoftOauth2ProviderConfigOutput": { + "type": "structure", + "members": { + "oauthDiscovery": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2Discovery", + "traits": { + "smithy.api#documentation": "The OAuth2 discovery information for the Microsoft provider.
", + "smithy.api#required": {} + } + }, + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the Microsoft OAuth2 provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Output configuration for a Microsoft OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModelEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModelEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModelEntry": { + "type": "structure", + "members": { + "model": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModelPattern", + "traits": { + "smithy.api#documentation": "The model ID or glob pattern that identifies the model (for example, anthropic.claude-opus-* or openai.gpt-oss-*).
A model entry that specifies a model supported for an inference operation.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModelId": { + "type": "string" + }, + "com.amazonaws.bedrockagentcorecontrol#ModelMapping": { + "type": "structure", + "members": { + "providerPrefix": { + "target": "com.amazonaws.bedrockagentcorecontrol#ProviderPrefix", + "traits": { + "smithy.api#documentation": "The provider prefix configuration used for model ID translation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that translates model IDs between client-facing names and provider model IDs.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModelPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\._\\*\\?@]+(/[a-zA-Z0-9\\-\\._\\*\\?@]+)*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModifyConsolidationConfiguration": { + "type": "union", + "members": { + "customConsolidationConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomConsolidationConfigurationInput", + "traits": { + "smithy.api#documentation": "The updated custom consolidation configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information for modifying a consolidation configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModifyExtractionConfiguration": { + "type": "union", + "members": { + "customExtractionConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomExtractionConfigurationInput", + "traits": { + "smithy.api#documentation": "The updated custom extraction configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information for modifying an extraction configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModifyInvocationConfigurationInput": { + "type": "structure", + "members": { + "topicArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Arn", + "traits": { + "smithy.api#documentation": "The updated ARN of the SNS topic for job notifications.
" + } + }, + "payloadDeliveryBucketName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The updated S3 bucket name for event payload delivery.
", + "smithy.api#pattern": "^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for updating invocation settings.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModifyMemoryStrategies": { + "type": "structure", + "members": { + "addMemoryStrategies": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryStrategyInputList", + "traits": { + "smithy.api#documentation": "The list of memory strategies to add.
" + } + }, + "modifyMemoryStrategies": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModifyMemoryStrategiesList", + "traits": { + "smithy.api#documentation": "The list of memory strategies to modify.
" + } + }, + "deleteMemoryStrategies": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteMemoryStrategiesList", + "traits": { + "smithy.api#documentation": "The list of memory strategies to delete.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information for modifying memory strategies.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModifyMemoryStrategiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModifyMemoryStrategyInput" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModifyMemoryStrategyInput": { + "type": "structure", + "members": { + "memoryStrategyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the memory strategy to modify.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The updated description of the memory strategy.
" + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#deprecated": { + "message": "Use namespaceTemplates instead", + "since": "2026-03-02" + }, + "smithy.api#documentation": "This is a legacy parameter, use namespaceTemplates. The updated namespaces for the memory strategy.
The updated namespaceTemplates for the memory strategy.
" + } + }, + "configuration": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModifyStrategyConfiguration", + "traits": { + "smithy.api#documentation": "The updated configuration for the memory strategy.
" + } + }, + "memoryRecordSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryRecordSchema", + "traits": { + "smithy.api#documentation": "Updated metadata schema for records generated by this strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for modifying a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModifyReflectionConfiguration": { + "type": "union", + "members": { + "episodicReflectionConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicReflectionConfigurationInput", + "traits": { + "smithy.api#documentation": "The updated episodic reflection configuration.
" + } + }, + "customReflectionConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomReflectionConfigurationInput", + "traits": { + "smithy.api#documentation": "The updated custom reflection configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information for modifying a reflection configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModifySelfManagedConfiguration": { + "type": "structure", + "members": { + "triggerConditions": { + "target": "com.amazonaws.bedrockagentcorecontrol#TriggerConditionInputList", + "traits": { + "smithy.api#documentation": "The updated list of conditions that trigger memory processing.
" + } + }, + "invocationConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModifyInvocationConfigurationInput", + "traits": { + "smithy.api#documentation": "The updated configuration to invoke self-managed memory processing pipeline.
" + } + }, + "historicalContextWindowSize": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The updated number of historical messages to include in processing context.
", + "smithy.api#range": { + "min": 0, + "max": 50 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for updating the self-managed memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ModifyStrategyConfiguration": { + "type": "structure", + "members": { + "extraction": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModifyExtractionConfiguration", + "traits": { + "smithy.api#documentation": "The updated extraction configuration.
" + } + }, + "consolidation": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModifyConsolidationConfiguration", + "traits": { + "smithy.api#documentation": "The updated consolidation configuration.
" + } + }, + "reflection": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModifyReflectionConfiguration", + "traits": { + "smithy.api#documentation": "The updated reflection configuration.
" + } + }, + "selfManagedConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModifySelfManagedConfiguration", + "traits": { + "smithy.api#documentation": "The updated self-managed configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information for modifying a strategy configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#MountPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 6, + "max": 200 + }, + "smithy.api#pattern": "^/mnt/[a-zA-Z0-9._-]+/?$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Name": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-_\\/]*(\\{(actorId|sessionId|memoryStrategyId)\\}[a-zA-Z0-9\\-_\\/]*)*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#NamespacesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#Namespace" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#NaturalLanguage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#NetworkConfiguration": { + "type": "structure", + "members": { + "networkMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#NetworkMode", + "traits": { + "smithy.api#documentation": "The network mode for the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "networkModeConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#VpcConfig", + "traits": { + "smithy.api#documentation": "The network mode configuration for the AgentCore Runtime.
" + } + } + }, + "traits": { + "smithy.api#documentation": "SecurityConfig for the Agent.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#NetworkMode": { + "type": "enum", + "members": { + "PUBLIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLIC" + } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#NonEmptyStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#NonEmptyString" + } + }, + "com.amazonaws.bedrockagentcorecontrol#NumberValidation": { + "type": "structure", + "members": { + "minValue": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "Minimum allowed value.
" + } + }, + "maxValue": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "Maximum allowed value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Validation for NUMBER fields.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#NumericalScaleDefinition": { + "type": "structure", + "members": { + "definition": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description that explains what this numerical rating represents and when it should be used.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The numerical value for this rating scale option.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "label": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The label or name that describes this numerical rating option.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The definition of a numerical rating scale option that provides a numeric value with its description for evaluation scoring.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#NumericalScaleDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#NumericalScaleDefinition" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OAuth2AuthorizationData": { + "type": "structure", + "members": { + "authorizationUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The URL to initiate the authorization process. This URL is provided when the OAuth2 access token requires user authorization.
", + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "userId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The user identifier associated with the OAuth2 authorization session that is defined by AgentCore Gateway.
", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + } + }, + "traits": { + "smithy.api#documentation": "OAuth2-specific authorization data, including the authorization URL and user identifier for the authorization session.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OAuthCredentialProvider": { + "type": "structure", + "members": { + "providerArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#OAuthCredentialProviderArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.
", + "smithy.api#required": {} + } + }, + "scopes": { + "target": "com.amazonaws.bedrockagentcorecontrol#OAuthScopes", + "traits": { + "smithy.api#documentation": "The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
", + "smithy.api#required": {} + } + }, + "customParameters": { + "target": "com.amazonaws.bedrockagentcorecontrol#OAuthCustomParameters", + "traits": { + "smithy.api#documentation": "The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
" + } + }, + "grantType": { + "target": "com.amazonaws.bedrockagentcorecontrol#OAuthGrantType", + "traits": { + "smithy.api#default": "CLIENT_CREDENTIALS", + "smithy.api#documentation": "Specifies the kind of credentials to use for authorization:
CLIENT_CREDENTIALS - Authorization with a client ID and secret.
AUTHORIZATION_CODE - Authorization with a token that is specific to an individual end user.
TOKEN_EXCHANGE - Authorization using on-behalf-of token exchange. An inbound user token is exchanged for a downstream access token scoped to the target audience.
The URL where the end user's browser is redirected after obtaining the authorization code. Generally points to the customer's application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An OAuth credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using OAuth.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OAuthCredentialProviderArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OAuthCustomParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcorecontrol#OAuthCustomParametersKey" + }, + "value": { + "target": "com.amazonaws.bedrockagentcorecontrol#OAuthCustomParametersValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#OAuthCustomParametersKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#OAuthCustomParametersValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#OAuthDefaultReturnUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\w+:(\\/?\\/?)[^\\s]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OAuthGrantType": { + "type": "enum", + "members": { + "CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIENT_CREDENTIALS" + } + }, + "AUTHORIZATION_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZATION_CODE" + } + }, + "TOKEN_EXCHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN_EXCHANGE" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#OAuthScope": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#OAuthScopes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#OAuthScope" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#Oauth2AuthorizationServerMetadata": { + "type": "structure", + "members": { + "issuer": { + "target": "com.amazonaws.bedrockagentcorecontrol#IssuerUrlType", + "traits": { + "smithy.api#documentation": "The issuer URL for the OAuth2 authorization server.
", + "smithy.api#required": {} + } + }, + "authorizationEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizationEndpointType", + "traits": { + "smithy.api#documentation": "The authorization endpoint URL for the OAuth2 authorization server.
", + "smithy.api#required": {} + } + }, + "tokenEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#TokenEndpointType", + "traits": { + "smithy.api#documentation": "The token endpoint URL for the OAuth2 authorization server.
", + "smithy.api#required": {} + } + }, + "responseTypes": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResponseListType", + "traits": { + "smithy.api#documentation": "The supported response types for the OAuth2 authorization server.
" + } + }, + "tokenEndpointAuthMethods": { + "target": "com.amazonaws.bedrockagentcorecontrol#TokenEndpointAuthMethodsType", + "traits": { + "smithy.api#documentation": "The authentication methods supported by the token endpoint. This specifies how clients can authenticate when requesting tokens from the authorization server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the authorization server metadata for an OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Oauth2CredentialProvider": { + "type": "resource", + "identifiers": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName" + } + }, + "properties": { + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderVendorType" + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderArnType" + }, + "oauth2ProviderConfigInput": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2ProviderConfigInput" + }, + "callbackUrl": { + "target": "smithy.api#String" + }, + "clientSecretArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Secret" + }, + "clientSecretJsonKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretJsonKeyType" + }, + "clientSecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType" + }, + "createdTime": { + "target": "smithy.api#Timestamp" + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp" + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#Status" + } + }, + "put": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateOauth2CredentialProvider" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetOauth2CredentialProvider" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateOauth2CredentialProvider" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteOauth2CredentialProvider" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListOauth2CredentialProviders" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#Oauth2CredentialProviderItem": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the OAuth2 credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderVendorType", + "traits": { + "smithy.api#documentation": "The vendor of the OAuth2 credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OAuth2 credential provider.
", + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the OAuth2 credential provider was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the OAuth2 credential provider was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an OAuth2 credential provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Oauth2CredentialProviders": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2CredentialProviderItem" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Oauth2Discovery": { + "type": "union", + "members": { + "discoveryUrl": { + "target": "com.amazonaws.bedrockagentcorecontrol#DiscoveryUrlType", + "traits": { + "smithy.api#documentation": "The discovery URL for the OAuth2 provider.
" + } + }, + "authorizationServerMetadata": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2AuthorizationServerMetadata", + "traits": { + "smithy.api#documentation": "The authorization server metadata for the OAuth2 provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the discovery information for an OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Oauth2ProviderConfigInput": { + "type": "union", + "members": { + "customOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomOauth2ProviderConfigInput", + "traits": { + "smithy.api#documentation": "The configuration for a custom OAuth2 provider.
" + } + }, + "googleOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#GoogleOauth2ProviderConfigInput", + "traits": { + "smithy.api#documentation": "The configuration for a Google OAuth2 provider.
" + } + }, + "githubOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#GithubOauth2ProviderConfigInput", + "traits": { + "smithy.api#documentation": "The configuration for a GitHub OAuth2 provider.
" + } + }, + "slackOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SlackOauth2ProviderConfigInput", + "traits": { + "smithy.api#documentation": "The configuration for a Slack OAuth2 provider.
" + } + }, + "salesforceOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SalesforceOauth2ProviderConfigInput", + "traits": { + "smithy.api#documentation": "The configuration for a Salesforce OAuth2 provider.
" + } + }, + "microsoftOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#MicrosoftOauth2ProviderConfigInput", + "traits": { + "smithy.api#documentation": "The configuration for a Microsoft OAuth2 provider.
" + } + }, + "atlassianOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#AtlassianOauth2ProviderConfigInput", + "traits": { + "smithy.api#documentation": "Configuration settings for Atlassian OAuth2 provider integration.
" + } + }, + "linkedinOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#LinkedinOauth2ProviderConfigInput", + "traits": { + "smithy.api#documentation": "Configuration settings for LinkedIn OAuth2 provider integration.
" + } + }, + "includedOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#IncludedOauth2ProviderConfigInput", + "traits": { + "smithy.api#documentation": "The configuration for a non-custom OAuth2 provider. This includes settings for supported OAuth2 providers that have built-in integration support.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the input configuration for an OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Oauth2ProviderConfigOutput": { + "type": "union", + "members": { + "customOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomOauth2ProviderConfigOutput", + "traits": { + "smithy.api#documentation": "The output configuration for a custom OAuth2 provider.
" + } + }, + "googleOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#GoogleOauth2ProviderConfigOutput", + "traits": { + "smithy.api#documentation": "The output configuration for a Google OAuth2 provider.
" + } + }, + "githubOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#GithubOauth2ProviderConfigOutput", + "traits": { + "smithy.api#documentation": "The output configuration for a GitHub OAuth2 provider.
" + } + }, + "slackOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SlackOauth2ProviderConfigOutput", + "traits": { + "smithy.api#documentation": "The output configuration for a Slack OAuth2 provider.
" + } + }, + "salesforceOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SalesforceOauth2ProviderConfigOutput", + "traits": { + "smithy.api#documentation": "The output configuration for a Salesforce OAuth2 provider.
" + } + }, + "microsoftOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#MicrosoftOauth2ProviderConfigOutput", + "traits": { + "smithy.api#documentation": "The output configuration for a Microsoft OAuth2 provider.
" + } + }, + "atlassianOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#AtlassianOauth2ProviderConfigOutput", + "traits": { + "smithy.api#documentation": "The configuration details for the Atlassian OAuth2 provider.
" + } + }, + "linkedinOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#LinkedinOauth2ProviderConfigOutput", + "traits": { + "smithy.api#documentation": "The configuration details for the LinkedIn OAuth2 provider.
" + } + }, + "includedOauth2ProviderConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#IncludedOauth2ProviderConfigOutput", + "traits": { + "smithy.api#documentation": "The configuration for a non-custom OAuth2 provider. This includes the configuration details for supported OAuth2 providers that have built-in integration support.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the output configuration for an OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OnBehalfOfTokenExchangeConfigType": { + "type": "structure", + "members": { + "grantType": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnBehalfOfTokenExchangeGrantTypeType", + "traits": { + "smithy.api#documentation": "The grant type for the on-behalf-of token exchange.
", + "smithy.api#required": {} + } + }, + "tokenExchangeGrantTypeConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#TokenExchangeGrantTypeConfigType", + "traits": { + "smithy.api#documentation": "Configuration specific to the TOKEN_EXCHANGE grant type (RFC 8693).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for on-behalf-of token exchange.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OnBehalfOfTokenExchangeGrantTypeType": { + "type": "enum", + "members": { + "TOKEN_EXCHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "RFC 8693 token exchange, adopted by the majority of identity providers supporting on-behalf-of flows.
", + "smithy.api#enumValue": "TOKEN_EXCHANGE" + } + }, + "JWT_AUTHORIZATION_GRANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "RFC 7523 JWT authorization grant, adopted by Microsoft Entra ID.
", + "smithy.api#enumValue": "JWT_AUTHORIZATION_GRANT" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfig": { + "type": "resource", + "identifiers": { + "onlineEvaluationConfigId": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateOnlineEvaluationConfig" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetOnlineEvaluationConfig" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateOnlineEvaluationConfig" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteOnlineEvaluationConfig" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListOnlineEvaluationConfigs" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::OnlineEvaluationConfig" + }, + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:online-evaluation-config\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigSummary": { + "type": "structure", + "members": { + "onlineEvaluationConfigArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "onlineEvaluationConfigId": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigId", + "traits": { + "smithy.api#documentation": "The unique identifier of the online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "onlineEvaluationConfigName": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluationConfigName", + "traits": { + "smithy.api#documentation": "The name of the online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluationConfigDescription", + "traits": { + "smithy.api#documentation": "The description of the online evaluation configuration.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigStatus", + "traits": { + "smithy.api#documentation": "The status of the online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "executionStatus": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationExecutionStatus", + "traits": { + "smithy.api#documentation": "The execution status indicating whether the online evaluation is currently running.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the online evaluation configuration was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the online evaluation configuration was last updated.
", + "smithy.api#required": {} + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for failure if the online evaluation configuration execution failed.
" + } + }, + "insights": { + "target": "com.amazonaws.bedrockagentcorecontrol#InsightList", + "traits": { + "smithy.api#documentation": "The list of insight types configured for this evaluation.
" + } + }, + "clusteringConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClusteringConfig", + "traits": { + "smithy.api#documentation": "The clustering configuration for periodic batch evaluation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary information about an online evaluation configuration, including basic metadata and execution status.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationExecutionStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#OpenResponsesEvaluatorModelConfig": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModelId", + "traits": { + "smithy.api#documentation": "The identifier of the model to use for evaluation.
", + "smithy.api#required": {} + } + }, + "maxOutputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to generate in the model response, including visible output and reasoning tokens.
", + "smithy.api#range": { + "min": 1 + } + } + }, + "temperature": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "The temperature value that controls randomness in the model's responses. Lower values produce more deterministic outputs.
", + "smithy.api#range": { + "min": 0, + "max": 2 + } + } + }, + "topP": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "The top-p sampling parameter that controls the diversity of the model's responses by limiting the cumulative probability of token choices.
", + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "reasoning": { + "target": "com.amazonaws.bedrockagentcorecontrol#ReasoningConfiguration", + "traits": { + "smithy.api#documentation": "The reasoning configuration for reasoning models. Non-reasoning models ignore this configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for using models served through the OpenResponses API in evaluator assessments, including model selection and inference parameters.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OutputConfig": { + "type": "structure", + "members": { + "cloudWatchConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#CloudWatchOutputConfig", + "traits": { + "smithy.api#documentation": "The CloudWatch configuration for writing evaluation results to CloudWatch logs with embedded metric format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that specifies where evaluation results should be written for monitoring and analysis.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#OverrideType": { + "type": "enum", + "members": { + "SEMANTIC_OVERRIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEMANTIC_OVERRIDE" + } + }, + "SUMMARY_OVERRIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUMMARY_OVERRIDE" + } + }, + "USER_PREFERENCE_OVERRIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_PREFERENCE_OVERRIDE" + } + }, + "SELF_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELF_MANAGED" + } + }, + "EPISODIC_OVERRIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EPISODIC_OVERRIDE" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PassthroughEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^https://[a-zA-Z0-9\\-\\.]+(:[0-9]{1,5})?(/.*)?$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PassthroughProtocolType": { + "type": "enum", + "members": { + "MCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MCP" + } + }, + "A2A": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A2A" + } + }, + "INFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFERENCE" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PassthroughTargetConfiguration": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#PassthroughEndpoint", + "traits": { + "smithy.api#documentation": "The HTTPS endpoint that the gateway forwards requests to for this passthrough target.
", + "smithy.api#required": {} + } + }, + "protocolType": { + "target": "com.amazonaws.bedrockagentcorecontrol#PassthroughProtocolType", + "traits": { + "smithy.api#documentation": "The application protocol that the passthrough target implements. This value is required for passthrough targets:
MCP - The Model Context Protocol.
A2A - The Agent-to-Agent protocol.
INFERENCE - The protocol for routing requests to a large language model (LLM) provider.
CUSTOM - A custom application protocol.
The API schema configuration that defines the structure of the passthrough target's API.
" + } + }, + "stickinessConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#StickinessConfiguration", + "traits": { + "smithy.api#documentation": "The session stickiness configuration for the passthrough target. This configuration routes requests within the same session to the same target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for an HTTP passthrough target. A passthrough target forwards requests directly to an external HTTP endpoint.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 211 + }, + "smithy.api#pattern": "^([0-9a-z][-]?){1,100}-[0-9a-z]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 48 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorResource": { + "type": "resource", + "identifiers": { + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId" + }, + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreatePaymentConnector" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPaymentConnector" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentConnector" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePaymentConnector" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPaymentConnectors" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorSummary": { + "type": "structure", + "members": { + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment connector.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorName", + "traits": { + "smithy.api#documentation": "The name of the payment connector.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorType", + "traits": { + "smithy.api#documentation": "The type of the payment connector, which determines the payment provider integration.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorStatus", + "traits": { + "smithy.api#documentation": "The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
The timestamp when the payment connector was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a payment connector.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorType": { + "type": "enum", + "members": { + "COINBASE_CDP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CoinbaseCDP" + } + }, + "STRIPE_PRIVY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StripePrivy" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProvider": { + "type": "resource", + "identifiers": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName" + } + }, + "properties": { + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderVendorType" + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderArnType" + }, + "providerConfigurationOutput": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentProviderConfigurationOutput" + }, + "createdTime": { + "target": "smithy.api#Timestamp" + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp" + } + }, + "put": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreatePaymentCredentialProvider" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPaymentCredentialProvider" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentCredentialProvider" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePaymentCredentialProvider" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPaymentCredentialProviders" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::PaymentCredentialProvider" + }, + "smithy.api#length": { + "min": 69, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b|aws-iso-e|aws-iso-f|aws-eusc):(acps|bedrock-agentcore):[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/paymentcredentialprovider/[a-zA-Z0-9-.]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderArnType": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::PaymentCredentialProvider" + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/paymentcredentialprovider/[a-zA-Z0-9-.]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderConfiguration": { + "type": "structure", + "members": { + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a payment credential provider that stores authentication credentials for a payment provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderItem": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the payment credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderVendorType", + "traits": { + "smithy.api#documentation": "The vendor type for the payment credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the payment credential provider.
", + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment credential provider was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment credential provider was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a payment credential provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderVendorType": { + "type": "enum", + "members": { + "CoinbaseCDP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Coinbase Developer Platform.
", + "smithy.api#enumValue": "CoinbaseCDP" + } + }, + "StripePrivy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Stripe and Privy.
", + "smithy.api#enumValue": "StripePrivy" + } + } + }, + "traits": { + "smithy.api#documentation": "Supported vendor types for payment providers using non-standard auth protocols.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviders": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderItem" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentManagerArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::PaymentManager" + }, + "smithy.api#length": { + "min": 66, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/([0-9a-z][-]?){1,48}-[a-z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 211 + }, + "smithy.api#pattern": "^([0-9a-z][-]?){1,100}-[0-9a-z]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentManagerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 48 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentManagerResource": { + "type": "resource", + "identifiers": { + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreatePaymentManager" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPaymentManager" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentManager" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePaymentManager" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPaymentManagers" + }, + "resources": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorResource" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentManagerStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentManagerSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentManagerSummary": { + "type": "structure", + "members": { + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the payment manager.
", + "smithy.api#required": {} + } + }, + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment manager.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerName", + "traits": { + "smithy.api#documentation": "The name of the payment manager.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsDescription", + "traits": { + "smithy.api#documentation": "The description of the payment manager.
" + } + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsAuthorizerType", + "traits": { + "smithy.api#documentation": "The type of authorizer used by the payment manager.
CUSTOM_JWT - Authorize with a bearer token.
AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerStatus", + "traits": { + "smithy.api#documentation": "The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
The timestamp when the payment manager was created.
" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment manager was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a payment manager.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentProviderConfigurationInput": { + "type": "union", + "members": { + "coinbaseCdpConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CoinbaseCdpConfigurationInput", + "traits": { + "smithy.api#documentation": "The Coinbase CDP configuration.
" + } + }, + "stripePrivyConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#StripePrivyConfigurationInput", + "traits": { + "smithy.api#documentation": "The Stripe Privy configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provider configuration input — contains secrets for creation and update. Varies by vendor type.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentProviderConfigurationOutput": { + "type": "union", + "members": { + "coinbaseCdpConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CoinbaseCdpConfigurationOutput", + "traits": { + "smithy.api#documentation": "The Coinbase CDP configuration.
" + } + }, + "stripePrivyConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#StripePrivyConfigurationOutput", + "traits": { + "smithy.api#documentation": "The Stripe Privy configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provider configuration output — no raw secrets, only ARNs. Varies by vendor type.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentsAuthorizerType": { + "type": "enum", + "members": { + "CUSTOM_JWT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_JWT" + } + }, + "AWS_IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IAM" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PaymentsDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Policies": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#Policy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#Policy": { + "type": "structure", + "members": { + "policyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier for the policy. This system-generated identifier consists of the user name plus a 10-character generated suffix and serves as the primary key for policy operations.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyName", + "traits": { + "smithy.api#documentation": "The customer-assigned immutable name for the policy. This human-readable identifier must be unique within the account and cannot exceed 48 characters.
", + "smithy.api#required": {} + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine that manages this policy. This establishes the policy engine context for policy evaluation and management.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was originally created. This is automatically set by the service and used for auditing and lifecycle management.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration or metadata.
", + "smithy.api#required": {} + } + }, + "policyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatus", + "traits": { + "smithy.api#documentation": "The current status of the policy.
", + "smithy.api#required": {} + } + }, + "enforcementMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnforcementMode", + "traits": { + "smithy.api#default": "ACTIVE", + "smithy.api#documentation": "The current enforcement mode of the policy.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyDefinition", + "traits": { + "smithy.api#documentation": "The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "A human-readable description of the policy's purpose and functionality. Limited to 4,096 characters, this helps administrators understand and manage the policy.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the policy status. This provides details about any failures or the current state of the policy lifecycle.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a complete policy resource within the AgentCore Policy system. Policies are ARN-able resources that contain Cedar policy statements and associated metadata for controlling agent behavior and access decisions. Each policy belongs to a policy engine and defines fine-grained authorization rules that are evaluated in real-time as agents interact with tools through Gateway. Policies use the Cedar policy language to specify who (principals based on OAuth claims like username, role, or scope) can perform what actions (tool calls) on which resources (Gateways), with optional conditions for attribute-based access control. Multiple policies can apply to a single request, with Cedar's forbid-wins semantics ensuring that security restrictions are never accidentally overridden.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::Policy" + }, + "smithy.api#length": { + "min": 96, + "max": 203 + }, + "smithy.api#pattern": "^arn:aws[-a-z]{0,7}:bedrock-agentcore:[a-z0-9-]{9,15}:[0-9]{12}:policy-engine/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}/policy/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyDefinition": { + "type": "union", + "members": { + "cedar": { + "target": "com.amazonaws.bedrockagentcorecontrol#CedarPolicy", + "traits": { + "smithy.api#documentation": "The Cedar policy definition within the policy definition structure. This contains the Cedar policy statement that defines the authorization logic using Cedar's human-readable, analyzable policy language. Cedar policies specify principals (who can access), actions (what operations are allowed), resources (what can be accessed), and optional conditions for fine-grained control. Cedar provides a formal policy language designed for authorization with deterministic evaluation, making policies testable, reviewable, and auditable. All Cedar policies follow a default-deny model where actions are denied unless explicitly permitted, and forbid policies always override permit policies.
" + } + }, + "policyGeneration": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationDetails", + "traits": { + "smithy.api#documentation": "The generated policy asset information within the policy definition structure. This contains information identifying a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option.
" + } + }, + "policy": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatement", + "traits": { + "smithy.api#documentation": "An AgentCore policy statement that defines the access control rules. The statement can be a Cedar policy or a guardrails definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the definition structure for policies within the AgentCore Policy system. This structure encapsulates different policy formats and languages that can be used to define access control rules.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyEngine": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier for the policy engine. This system-generated identifier consists of the user name plus a 10-character generated suffix and serves as the primary key for policy engine operations.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineName", + "traits": { + "smithy.api#documentation": "The customer-assigned immutable name for the policy engine. This human-readable identifier must be unique within the account and cannot exceed 48 characters.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy engine was originally created. This is automatically set by the service and used for auditing and lifecycle management.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration or metadata.
", + "smithy.api#required": {} + } + }, + "policyEngineArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineStatus", + "traits": { + "smithy.api#documentation": "The current status of the policy engine.
", + "smithy.api#required": {} + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "A human-readable description of the policy engine's purpose and scope. Limited to 4,096 characters, this helps administrators understand the policy engine's role in the overall governance strategy.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine lifecycle.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a policy engine resource within the AgentCore Policy system. Policy engines serve as containers for grouping related policies and provide the execution context for policy evaluation and management. Each policy engine can be associated with one Gateway (one engine per Gateway), where it intercepts all agent tool calls and evaluates them against the contained policies before allowing tools to execute. The policy engine maintains the Cedar schema generated from the Gateway's tool manifest, ensuring that policies are validated against the actual tools and parameters available. Policy engines support two enforcement modes that can be configured when associating with a Gateway: log-only mode for testing (evaluates decisions without blocking) and enforce mode for production (actively allows or denies based on policy evaluation).
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyEngineArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::PolicyEngine" + }, + "smithy.api#length": { + "min": 76, + "max": 136 + }, + "smithy.api#pattern": "^arn:aws[-a-z]{0,7}:bedrock-agentcore:[a-z0-9-]{9,15}:[0-9]{12}:policy-engine/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyEngineName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 48 + }, + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_]*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource": { + "type": "resource", + "identifiers": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreatePolicyEngine" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyEngine" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatePolicyEngine" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePolicyEngine" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyEngines" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyEngineSummary" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyEngineSummaries" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyEngineStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyEngineSummary": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier for the policy engine.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineName", + "traits": { + "smithy.api#documentation": "The customer-assigned name of the policy engine.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy engine was originally created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy engine was last modified.
", + "smithy.api#required": {} + } + }, + "policyEngineArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy engine.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineStatus", + "traits": { + "smithy.api#documentation": "The current status of the policy engine.
", + "smithy.api#required": {} + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a metadata-only summary of a policy engine resource. This structure contains resource identifiers, status, and timestamps without customer-encrypted fields such as description or status reasons. Policy engine summaries are returned by operations that do not require access to the customer's KMS key.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyEngineSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyEngines": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngine" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyGeneration": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine associated with this generation request.
", + "smithy.api#required": {} + } + }, + "policyGenerationId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier for this policy generation request.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationName", + "traits": { + "smithy.api#documentation": "The customer-assigned name for this policy generation request.
", + "smithy.api#required": {} + } + }, + "policyGenerationArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationArn", + "traits": { + "smithy.api#documentation": "The ARN of this policy generation request.
", + "smithy.api#required": {} + } + }, + "resource": { + "target": "com.amazonaws.bedrockagentcorecontrol#Resource", + "traits": { + "smithy.api#documentation": "The resource information associated with this policy generation.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this policy generation request was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this policy generation was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationStatus", + "traits": { + "smithy.api#documentation": "The current status of this policy generation request.
", + "smithy.api#required": {} + } + }, + "findings": { + "target": "com.amazonaws.bedrockagentcorecontrol#String", + "traits": { + "smithy.api#documentation": "Findings and insights from this policy generation process.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the generation status.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a policy generation request within the AgentCore Policy system. Tracks the AI-powered conversion of natural language descriptions into Cedar policy statements, enabling users to author policies by describing authorization requirements in plain English. The generation process analyzes the natural language input along with the Gateway's tool context and Cedar schema to produce one or more validated policy options. Each generation request tracks the status of the conversion process and maintains findings about the generated policies, including validation results and potential issues. Generated policy assets remain available for one week after successful generation, allowing time to review and create policies from the generated options.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::PolicyGeneration" + }, + "smithy.api#length": { + "min": 103, + "max": 210 + }, + "smithy.api#pattern": "^arn:aws[-a-z]{0,7}:bedrock-agentcore:[a-z0-9-]{9,15}:[0-9]{12}:policy-engine/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}/policy-generation/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationAsset": { + "type": "structure", + "members": { + "policyGenerationAssetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier for this generated policy asset within the policy generation request. This ID can be used to reference specific generated policy options when creating actual policies from the generation results.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyDefinition" + }, + "rawTextFragment": { + "target": "com.amazonaws.bedrockagentcorecontrol#NaturalLanguage", + "traits": { + "smithy.api#documentation": "The portion of the original natural language input that this generated policy asset addresses. This helps users understand which part of their policy description was translated into this specific Cedar policy statement, enabling better policy selection and refinement. When a single natural language input describes multiple authorization requirements, the generation process creates separate policy assets for each requirement, with each asset's rawTextFragment showing which requirement it addresses. Use this mapping to verify that all parts of your natural language input were correctly translated into Cedar policies.
", + "smithy.api#required": {} + } + }, + "findings": { + "target": "com.amazonaws.bedrockagentcorecontrol#Findings", + "traits": { + "smithy.api#documentation": "Analysis findings and insights related to this specific generated policy asset. These findings may include validation results, potential issues, or recommendations for improvement to help users evaluate the quality and appropriateness of the generated policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationAssets": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationAsset" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationDetails": { + "type": "structure", + "members": { + "policyGenerationId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier for this policy generation request.
", + "smithy.api#required": {} + } + }, + "policyGenerationAssetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier for this generated policy asset within the policy generation request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the information identifying a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 48 + }, + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_]*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationResource": { + "type": "resource", + "identifiers": { + "policyGenerationId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#StartPolicyGeneration" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyGeneration" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerations" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicyGenerationSummary" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationAssets" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicyGenerationSummaries" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationStatus": { + "type": "enum", + "members": { + "GENERATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERATING" + } + }, + "GENERATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERATED" + } + }, + "GENERATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationSummary": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine associated with this generation request.
", + "smithy.api#required": {} + } + }, + "policyGenerationId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier for this policy generation request.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationName", + "traits": { + "smithy.api#documentation": "The customer-assigned name for this policy generation request.
", + "smithy.api#required": {} + } + }, + "policyGenerationArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationArn", + "traits": { + "smithy.api#documentation": "The ARN of this policy generation request.
", + "smithy.api#required": {} + } + }, + "resource": { + "target": "com.amazonaws.bedrockagentcorecontrol#Resource", + "traits": { + "smithy.api#documentation": "The resource information associated with this policy generation.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this policy generation request was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this policy generation was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationStatus", + "traits": { + "smithy.api#documentation": "The current status of this policy generation request.
", + "smithy.api#required": {} + } + }, + "findings": { + "target": "com.amazonaws.bedrockagentcorecontrol#String", + "traits": { + "smithy.api#documentation": "Findings and insights from this policy generation process.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a metadata-only summary of a policy generation resource. This structure contains resource identifiers, status, timestamps, and findings without customer-encrypted fields such as status reasons. Policy generation summaries are returned by operations that do not require access to the customer's KMS key.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyGenerations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGeneration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 48 + }, + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_]*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyResource": { + "type": "resource", + "identifiers": { + "policyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreatePolicy" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicy" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatePolicy" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeletePolicy" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicies" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#GetPolicySummary" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListPolicySummaries" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyStatement": { + "type": "structure", + "members": { + "statement": { + "target": "com.amazonaws.bedrockagentcorecontrol#Statement", + "traits": { + "smithy.api#documentation": "The body of the AgentCore policy statement. Contains the policy logic, which can be a Cedar policy or a guardrails definition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An AgentCore policy statement, which supports plain Cedar policies as well as guardrails definitions.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#String" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicySummary": { + "type": "structure", + "members": { + "policyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier for the policy.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyName", + "traits": { + "smithy.api#documentation": "The customer-assigned name of the policy.
", + "smithy.api#required": {} + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine that manages this policy.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was originally created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was last modified.
", + "smithy.api#required": {} + } + }, + "policyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatus", + "traits": { + "smithy.api#documentation": "The current status of the policy.
", + "smithy.api#required": {} + } + }, + "enforcementMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnforcementMode", + "traits": { + "smithy.api#default": "ACTIVE", + "smithy.api#documentation": "The current enforcement mode of the policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a metadata-only summary of a policy resource. This structure contains resource identifiers, status, and timestamps without customer-encrypted fields such as definition, description, or status reasons. Policy summaries are returned by operations that do not require access to the customer's KMS key.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicySummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PolicyValidationMode": { + "type": "enum", + "members": { + "FAIL_ON_ANY_FINDINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAIL_ON_ANY_FINDINGS" + } + }, + "IGNORE_ALL_FINDINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGNORE_ALL_FINDINGS" + } + } + }, + "traits": { + "smithy.api#default": "FAIL_ON_ANY_FINDINGS" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PrincipalMatchOperator": { + "type": "enum", + "members": { + "StringEquals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StringEquals" + } + }, + "StringLike": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StringLike" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PrivateEndpoint": { + "type": "union", + "members": { + "selfManagedLatticeResource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SelfManagedLatticeResource", + "traits": { + "smithy.api#documentation": "Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
" + } + }, + "managedVpcResource": { + "target": "com.amazonaws.bedrockagentcorecontrol#ManagedVpcResource", + "traits": { + "smithy.api#documentation": "Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointManagedResources": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ManagedResourceDetails" + }, + "traits": { + "smithy.api#documentation": "A list of managed resources created by the gateway for private endpoint connectivity.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointOverride": { + "type": "structure", + "members": { + "domain": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointOverrideDomain", + "traits": { + "smithy.api#documentation": "The domain to override with a private endpoint.
", + "smithy.api#required": {} + } + }, + "privateEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpoint", + "traits": { + "smithy.api#documentation": "The private endpoint configuration for the specified domain.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mapping of a specific domain to a private endpoint for secure connectivity through a VPC Lattice resource configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointOverrideDomain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointOverrides": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointOverride" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#PrivateKeyJwtConfig": { + "type": "structure", + "members": { + "privateKeySource": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateKeySource", + "traits": { + "smithy.api#documentation": "The private key source for the JWT client assertion.
" + } + }, + "signingAlgorithm": { + "target": "com.amazonaws.bedrockagentcorecontrol#SigningAlgorithm", + "traits": { + "smithy.api#documentation": "The algorithm used to sign the JWT client assertion. Valid values are RS256, PS256, and ES256.
A map of additional claims to include in the JWT client assertion header. Standard header claims such as alg and typ cannot be added.
A map of additional claims to include in the JWT client assertion payload. Payload claims generated by the service, such as iss, sub, jti, and exp, cannot be added.
The KMS key source for the JWT client assertion.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the private key source configuration for a JWT client assertion.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Prompt": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ProtocolConfiguration": { + "type": "structure", + "members": { + "serverProtocol": { + "target": "com.amazonaws.bedrockagentcorecontrol#ServerProtocol", + "traits": { + "smithy.api#documentation": "The server protocol for the agent runtime. This field specifies which protocol the agent runtime uses to communicate with clients.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ProviderPrefix": { + "type": "structure", + "members": { + "strip": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether clients can omit the provider prefix from model IDs. If true, the gateway accepts model IDs without the prefix and restores the full prefixed form before forwarding to the provider. The default is false.
The single character that separates the provider prefix from the model name (for example, .). The default is ..
The configuration that controls how a provider prefix is applied to model IDs during translation.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates a resource-based policy for a resource with the specified resourceArn.
This feature is currently available only for AgentCore Runtime and Gateway.
The Amazon Resource Name (ARN) of the resource for which to create or update the resource policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourcePolicyBody", + "traits": { + "smithy.api#documentation": "The resource policy to create or update.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "policy": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourcePolicyBody", + "traits": { + "smithy.api#documentation": "The resource policy that was created or updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#RatingScale": { + "type": "union", + "members": { + "numerical": { + "target": "com.amazonaws.bedrockagentcorecontrol#NumericalScaleDefinitions", + "traits": { + "smithy.api#documentation": "The numerical rating scale with defined score values and descriptions for quantitative evaluation.
" + } + }, + "categorical": { + "target": "com.amazonaws.bedrockagentcorecontrol#CategoricalScaleDefinitions", + "traits": { + "smithy.api#documentation": "The categorical rating scale with named categories and definitions for qualitative evaluation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The rating scale that defines how evaluators should score agent performance, supporting both numerical and categorical scales.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ReasoningConfiguration": { + "type": "structure", + "members": { + "effort": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The level of reasoning effort the model applies when generating a response. For supported values, see the model provider's documentation.
", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The reasoning configuration that controls how a reasoning model allocates effort during evaluation.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RecordIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/)?[a-zA-Z0-9]{12}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RecordingConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether recording is enabled for the browser. When set to true, browser sessions are recorded.
" + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3Location", + "traits": { + "smithy.api#documentation": "The Amazon S3 location where browser recordings are stored. This location contains the recorded browser sessions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The recording configuration for a browser. This structure defines how browser sessions are recorded.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ReflectionConfiguration": { + "type": "union", + "members": { + "customReflectionConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomReflectionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for a custom reflection strategy.
" + } + }, + "episodicReflectionConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#EpisodicReflectionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for the episodic reflection strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains reflection configuration information for a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::Registry" + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryAuthorizerType": { + "type": "enum", + "members": { + "CUSTOM_JWT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_JWT" + } + }, + "AWS_IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IAM" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 16 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{12,16}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/)?[a-zA-Z0-9]{12,16}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-\\.\\/]*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/[a-zA-Z0-9]{12}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordCredentialProviderConfiguration": { + "type": "structure", + "members": { + "credentialProviderType": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordCredentialProviderType", + "traits": { + "smithy.api#documentation": "The type of credential provider.
OAUTH - OAuth-based authentication.
IAM - Amazon Web Services IAM-based authentication using SigV4 signing.
The credential provider configuration details. The structure depends on the credentialProviderType.
A pairing of a credential provider type with its corresponding provider details for authenticating with external sources.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordCredentialProviderConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordCredentialProviderConfiguration" + }, + "traits": { + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordCredentialProviderType": { + "type": "enum", + "members": { + "OAUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH" + } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordCredentialProviderUnion": { + "type": "union", + "members": { + "oauthCredentialProvider": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordOAuthCredentialProvider", + "traits": { + "smithy.api#documentation": "The OAuth credential provider configuration for authenticating with the external source.
" + } + }, + "iamCredentialProvider": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordIamCredentialProvider", + "traits": { + "smithy.api#documentation": "The IAM credential provider configuration for authenticating with the external source using SigV4 signing.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Union of supported credential provider types for registry record synchronization.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordIamCredentialProvider": { + "type": "structure", + "members": { + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to assume for SigV4 signing.
" + } + }, + "service": { + "target": "com.amazonaws.bedrockagentcorecontrol#IamSigningServiceName", + "traits": { + "smithy.api#documentation": "The SigV4 signing service name (for example, execute-api or bedrock-agentcore).
The Amazon Web Services region for SigV4 signing (for example, us-west-2). If not specified, the region is extracted from the MCP server URL hostname, with fallback to the service's own region.
IAM credential provider configuration for authenticating with an external source using SigV4 signing during synchronization.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{12}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-\\.\\/]*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordOAuthCredentialProvider": { + "type": "structure", + "members": { + "providerArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OAuth credential provider resource.
", + "smithy.api#required": {} + } + }, + "grantType": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordOAuthGrantType", + "traits": { + "smithy.api#documentation": "The OAuth grant type. Currently only CLIENT_CREDENTIALS is supported.
The OAuth scopes to request during authentication.
" + } + }, + "customParameters": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomParameterMap", + "traits": { + "smithy.api#documentation": "Additional custom parameters for the OAuth flow.
" + } + } + }, + "traits": { + "smithy.api#documentation": "OAuth credential provider configuration for authenticating with an external source during synchronization.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordOAuthGrantType": { + "type": "enum", + "members": { + "CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIENT_CREDENTIALS" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordResource": { + "type": "resource", + "identifiers": { + "registryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryIdentifier" + }, + "recordId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RecordIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateRegistryRecord" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetRegistryRecord" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRecord" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteRegistryRecord" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListRegistryRecords" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#SubmitRegistryRecordForApproval" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRecordStatus" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordStatus": { + "type": "enum", + "members": { + "DRAFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRAFT" + } + }, + "PENDING_APPROVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_APPROVAL" + } + }, + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPROVED" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + }, + "DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATED" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordSummary": { + "type": "structure", + "members": { + "registryArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the registry that contains the record.
", + "smithy.api#required": {} + } + }, + "recordArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the registry record.
", + "smithy.api#required": {} + } + }, + "recordId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordId", + "traits": { + "smithy.api#documentation": "The unique identifier of the registry record.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordName", + "traits": { + "smithy.api#documentation": "The name of the registry record.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the registry record.
" + } + }, + "descriptorType": { + "target": "com.amazonaws.bedrockagentcorecontrol#DescriptorType", + "traits": { + "smithy.api#documentation": "The descriptor type of the registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.
The version of the registry record.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordStatus", + "traits": { + "smithy.api#documentation": "The current status of the registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.
The timestamp when the registry record was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the registry record was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a registry record.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryRecordVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9.-]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryResource": { + "type": "resource", + "identifiers": { + "registryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateRegistry" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetRegistry" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateRegistry" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteRegistry" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListRegistries" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistryStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistrySummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryName", + "traits": { + "smithy.api#documentation": "The name of the registry.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the registry.
" + } + }, + "registryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the registry.
", + "smithy.api#required": {} + } + }, + "registryArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the registry.
", + "smithy.api#required": {} + } + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryAuthorizerType", + "traits": { + "smithy.api#documentation": "The type of authorizer used by the registry. This controls the authorization method for the Search and Invoke APIs used by consumers.
CUSTOM_JWT - Authorize with a bearer token.
AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
The current status of the registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.
The reason for the current status, typically set when the status is a failure state.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the registry was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the registry was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a registry.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RegistrySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistrySummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RequestHeaderAllowlist": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HeaderName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#RequestHeaderConfiguration": { + "type": "union", + "members": { + "requestHeaderAllowlist": { + "target": "com.amazonaws.bedrockagentcorecontrol#RequestHeaderAllowlist", + "traits": { + "smithy.api#documentation": "A list of HTTP request headers that are allowed to be passed through to the runtime.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for HTTP request headers that will be passed through to the runtime.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RequiredProperties": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Resource": { + "type": "union", + "members": { + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#BedrockAgentcoreResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource. This globally unique identifier specifies the exact resource that policies will be evaluated against for access control decisions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a resource within the AgentCore Policy system. Resources are the targets of policy evaluation. Currently, only AgentCore Gateways are supported as resources for policy enforcement.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResourceAssociationArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetworkresourceassociation/snra-[0-9a-f]{17}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResourceConfigurationIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^((rcfg-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}))$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResourceGatewayArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:resourcegateway/rgw-[0-9a-z]{17}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 59 + }, + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_]*-[a-z0-9_]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResourceLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "Exception thrown when a resource limit is exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResourceLocation": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3Location" + } + }, + "traits": { + "smithy.api#documentation": "The location of a resource.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcorecontrol#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a resource referenced by the operation does not exist
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResourceOauth2ReturnUrlListType": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceOauth2ReturnUrlType" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResourceOauth2ReturnUrlType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\w+:(\\/?\\/?)[^\\s]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResourcePolicyBody": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20480 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResourceType": { + "type": "enum", + "members": { + "SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResponseListType": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResponseType" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ResponseType": { + "type": "string" + }, + "com.amazonaws.bedrockagentcorecontrol#RestApiMethod": { + "type": "enum", + "members": { + "GET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GET" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + }, + "HEAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEAD" + } + }, + "OPTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPTIONS" + } + }, + "PATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PATCH" + } + }, + "PUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT" + } + }, + "POST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#RestApiMethods": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#RestApiMethod" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RouteToTargetAction": { + "type": "union", + "members": { + "staticRoute": { + "target": "com.amazonaws.bedrockagentcorecontrol#StaticRoute", + "traits": { + "smithy.api#documentation": "A static route that sends all matching requests to a single target.
" + } + }, + "weightedRoute": { + "target": "com.amazonaws.bedrockagentcorecontrol#WeightedRoute", + "traits": { + "smithy.api#documentation": "A weighted route that splits traffic between multiple targets.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An action that routes requests to a gateway target, either statically or with weighted traffic splitting.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RoutingDomain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#Rule": { + "type": "structure", + "members": { + "samplingConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SamplingConfig", + "traits": { + "smithy.api#documentation": "The sampling configuration that determines what percentage of agent traces to evaluate.
", + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.bedrockagentcorecontrol#FilterList", + "traits": { + "smithy.api#documentation": "The list of filters that determine which agent traces should be included in the evaluation based on trace properties.
" + } + }, + "sessionConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SessionConfig", + "traits": { + "smithy.api#documentation": "The session configuration that defines timeout settings for detecting when agent sessions are complete and ready for evaluation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The evaluation rule that defines sampling configuration, filtering criteria, and session detection settings for online evaluation.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RuntimeArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::Runtime" + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RuntimeContainerUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^(([0-9]{12})\\.dkr\\.ecr\\.([a-z0-9-]+)\\.amazonaws\\.com(\\.cn)?|public\\.ecr\\.aws)/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?::([^:@]{1,300}))?(?:@(.+))?$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RuntimeMetadataConfiguration": { + "type": "structure", + "members": { + "requireMMDSV2": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Enables MMDSv2 (microVM Metadata Service Version 2) requirement for the agent runtime. When set to true, the runtime microVM will only accept MMDSv2 requests.
Configuration for microVM metadata service settings.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RuntimeQualifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "([1-9][0-9]{0,4})|([a-zA-Z][a-zA-Z0-9_]{0,47})" + } + }, + "com.amazonaws.bedrockagentcorecontrol#RuntimeTargetConfiguration": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RuntimeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AgentCore Runtime to route requests to.
", + "smithy.api#required": {} + } + }, + "qualifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#RuntimeQualifier", + "traits": { + "smithy.api#documentation": "The qualifier for the agent runtime, used to target a specific endpoint version. If not specified, the default endpoint is used.
" + } + }, + "schema": { + "target": "com.amazonaws.bedrockagentcorecontrol#HttpApiSchemaConfiguration", + "traits": { + "smithy.api#documentation": "The API schema configuration that defines the structure of the runtime target's API.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for an AgentCore Runtime target. Specifies the agent runtime to route requests to via HTTP.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#S3BucketUri": { + "type": "string", + "traits": { + "smithy.api#pattern": "^s3://.{1,2043}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#S3Configuration": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3BucketUri", + "traits": { + "smithy.api#documentation": "The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
" + } + }, + "bucketOwnerAccountId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AwsAccountId", + "traits": { + "smithy.api#documentation": "The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#S3FilesAccessPointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#S3FilesAccessPointConfiguration": { + "type": "structure", + "members": { + "accessPointArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3FilesAccessPointArn", + "traits": { + "smithy.api#documentation": "The ARN of the S3 Files access point to mount into the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "mountPath": { + "target": "com.amazonaws.bedrockagentcorecontrol#MountPath", + "traits": { + "smithy.api#documentation": "The mount path for the S3 Files access point inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data).
Configuration for an Amazon S3 Files access point filesystem mounted into the AgentCore Runtime. S3 Files access points provide shared file storage accessible from your AgentCore Runtime sessions.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#S3FilesConfiguration": { + "type": "structure", + "members": { + "accessPointArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3FilesAccessPointArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Simple Storage Service (Amazon S3) Files access point to mount.
", + "smithy.api#required": {} + } + }, + "mountPath": { + "target": "com.amazonaws.bedrockagentcorecontrol#MountPath", + "traits": { + "smithy.api#documentation": "The absolute path within the session at which the access point is mounted, for example /mnt/s3data. Each mount path must be unique across all file system configurations in the session.
The Amazon Resource Name (ARN) of the Amazon Simple Storage Service (Amazon S3) Files file system that owns the access point.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for mounting an Amazon Simple Storage Service (Amazon S3) Files access point that you own into a session.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#S3FilesFileSystemArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Simple Storage Service (Amazon S3) Files file system. The access points you specify must belong to this file system.
", + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:s3files:[a-z0-9-]+:[0-9]{12}:file-system/fs-[0-9a-f]{17,40}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#S3Location": { + "type": "structure", + "members": { + "bucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket. This bucket contains the stored data.
", + "smithy.api#pattern": "^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$", + "smithy.api#required": {} + } + }, + "prefix": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The prefix for objects in the Amazon S3 bucket. This prefix is added to the object keys to organize the data.
", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#required": {} + } + }, + "versionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version ID of the Amazon Amazon S3 object. If not specified, the latest version of the object is used.
", + "smithy.api#length": { + "min": 3, + "max": 1024 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location for storing data. This structure defines where in Amazon S3 data is stored.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#S3Source": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3Uri", + "traits": { + "smithy.api#documentation": " Amazon S3 URI of the JSONL file (for example, s3://my-bucket/path/to/examples.jsonl).
Amazon S3 location of a JSONL file containing dataset examples.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#S3Uri": { + "type": "string", + "traits": { + "smithy.api#documentation": " Amazon S3 URI string in the format s3://bucket/key.
The client ID for the Salesforce OAuth2 provider.
", + "smithy.api#required": {} + } + }, + "clientSecret": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultClientSecretType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The client secret for the Salesforce OAuth2 provider.
" + } + }, + "clientSecretConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretReference", + "traits": { + "smithy.api#documentation": "A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.
The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
Input configuration for a Salesforce OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SalesforceOauth2ProviderConfigOutput": { + "type": "structure", + "members": { + "oauthDiscovery": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2Discovery", + "traits": { + "smithy.api#documentation": "The OAuth2 discovery information for the Salesforce provider.
", + "smithy.api#required": {} + } + }, + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the Salesforce OAuth2 provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Output configuration for a Salesforce OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SamplingConfig": { + "type": "structure", + "members": { + "samplingPercentage": { + "target": "com.amazonaws.bedrockagentcorecontrol#SamplingPercentage", + "traits": { + "smithy.api#documentation": "The percentage of agent traces to sample for evaluation, ranging from 0.01% to 100%.
", + "smithy.api#range": { + "min": 0.01, + "max": 100.0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that controls what percentage of agent traces are sampled for evaluation to manage evaluation volume and costs.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SamplingPercentage": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0.01, + "max": 100.0 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#SandboxName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SchemaDefinition": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#SchemaType", + "traits": { + "smithy.api#documentation": "The type of the schema definition. This field specifies the data type of the schema.
", + "smithy.api#required": {} + } + }, + "properties": { + "target": "com.amazonaws.bedrockagentcorecontrol#SchemaProperties", + "traits": { + "smithy.api#documentation": "The properties of the schema definition. These properties define the fields in the schema.
" + } + }, + "required": { + "target": "com.amazonaws.bedrockagentcorecontrol#RequiredProperties", + "traits": { + "smithy.api#documentation": "The required fields in the schema definition. These fields must be provided when using the schema.
" + } + }, + "items": { + "target": "com.amazonaws.bedrockagentcorecontrol#SchemaDefinition", + "traits": { + "smithy.api#documentation": "The items in the schema definition. This field is used for array types to define the structure of the array elements.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the schema definition. This description provides information about the purpose and usage of the schema.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SchemaProperties": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.bedrockagentcorecontrol#SchemaDefinition" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SchemaType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "string" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "number" + } + }, + "OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "object" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "array" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "boolean" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "integer" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#SchemaVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ScopeList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ScopeType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ScopesListType": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ScopeType" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SearchType": { + "type": "enum", + "members": { + "SEMANTIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEMANTIC" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#Secret": { + "type": "structure", + "members": { + "secretArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret in Amazon Web Services Secrets Manager.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a secret in Amazon Web Services Secrets Manager.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SecretArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-us-gov):secretsmanager:[A-Za-z0-9-]{1,64}:[0-9]{12}:secret:[a-zA-Z0-9-_/+=.@!]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SecretIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#SecretJsonKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#SecretReference": { + "type": "structure", + "members": { + "secretId": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretIdType", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services Secrets Manager secret that stores the secret value.
", + "smithy.api#required": {} + } + }, + "jsonKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretJsonKeyType", + "traits": { + "smithy.api#documentation": "The JSON key used to extract the secret value from the Amazon Web Services Secrets Manager secret.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a reference to a secret stored in Amazon Web Services Secrets Manager.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SecretSourceType": { + "type": "enum", + "members": { + "MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED" + } + }, + "EXTERNAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#SecretsManagerLocation": { + "type": "structure", + "members": { + "secretArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ToolSecretArn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Web Services Secrets Manager secret containing the certificate.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon Web Services Secrets Manager location configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^sg-[0-9a-zA-Z]{8,17}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SecurityGroupIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecurityGroupIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#SecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#SelfManagedConfiguration": { + "type": "structure", + "members": { + "triggerConditions": { + "target": "com.amazonaws.bedrockagentcorecontrol#TriggerConditionsList", + "traits": { + "smithy.api#documentation": "A list of conditions that trigger memory processing.
", + "smithy.api#required": {} + } + }, + "invocationConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#InvocationConfiguration", + "traits": { + "smithy.api#documentation": "The configuration to use when invoking memory processing.
", + "smithy.api#required": {} + } + }, + "historicalContextWindowSize": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of historical messages to include in processing context.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A configuration for a self-managed memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SelfManagedConfigurationInput": { + "type": "structure", + "members": { + "triggerConditions": { + "target": "com.amazonaws.bedrockagentcorecontrol#TriggerConditionInputList", + "traits": { + "smithy.api#documentation": "A list of conditions that trigger memory processing.
" + } + }, + "invocationConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#InvocationConfigurationInput", + "traits": { + "smithy.api#documentation": "Configuration to invoke a self-managed memory processing pipeline with.
", + "smithy.api#required": {} + } + }, + "historicalContextWindowSize": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 4, + "smithy.api#documentation": "Number of historical messages to include in processing context.
", + "smithy.api#range": { + "min": 0, + "max": 50 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Input configuration for a self-managed memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SelfManagedLatticeResource": { + "type": "union", + "members": { + "resourceConfigurationIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceConfigurationIdentifier", + "traits": { + "smithy.api#documentation": "The ARN or ID of the VPC Lattice resource configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a self-managed VPC Lattice resource. You create and manage the VPC Lattice resource gateway and resource configuration, then provide the resource configuration identifier.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SemanticConsolidationOverride": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for semantic consolidation.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for semantic consolidation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains semantic consolidation override configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SemanticExtractionOverride": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for semantic extraction.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for semantic extraction.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains semantic extraction override configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SemanticMemoryStrategyInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#Name", + "traits": { + "smithy.api#documentation": "The name of the semantic memory strategy.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the semantic memory strategy.
" + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#deprecated": { + "message": "Use namespaceTemplates instead", + "since": "2026-03-02" + }, + "smithy.api#documentation": "This is a legacy parameter, use namespaceTemplates. The namespaces associated with the semantic memory strategy.
The namespaceTemplates associated with the semantic memory strategy.
" + } + }, + "memoryRecordSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryRecordSchema" + } + }, + "traits": { + "smithy.api#documentation": "Input for creating a semantic memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SemanticOverrideConfigurationInput": { + "type": "structure", + "members": { + "extraction": { + "target": "com.amazonaws.bedrockagentcorecontrol#SemanticOverrideExtractionConfigurationInput", + "traits": { + "smithy.api#documentation": "The extraction configuration for a semantic override.
" + } + }, + "consolidation": { + "target": "com.amazonaws.bedrockagentcorecontrol#SemanticOverrideConsolidationConfigurationInput", + "traits": { + "smithy.api#documentation": "The consolidation configuration for a semantic override.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for semantic override configuration in a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SemanticOverrideConsolidationConfigurationInput": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for semantic consolidation.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for semantic consolidation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for semantic override consolidation configuration in a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SemanticOverrideExtractionConfigurationInput": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for semantic extraction.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for semantic extraction.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for semantic override extraction configuration in a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SensitiveJson": { + "type": "document", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#SensitiveText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ServerDefinition": { + "type": "structure", + "members": { + "schemaVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#SchemaVersion", + "traits": { + "smithy.api#documentation": "The schema version of the server definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.
" + } + }, + "inlineContent": { + "target": "com.amazonaws.bedrockagentcorecontrol#InlineContent", + "traits": { + "smithy.api#documentation": "The JSON content containing the MCP server definition, conforming to the MCP protocol specification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The server definition for an MCP descriptor. Contains the schema version and inline content for the MCP server configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ServerProtocol": { + "type": "enum", + "members": { + "MCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MCP" + } + }, + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + }, + "A2A": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A2A" + } + }, + "AGUI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGUI" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ServiceException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "An internal error occurred.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ServiceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ServiceNamesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceName" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcorecontrol#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a request is made beyond the service quota
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.bedrockagentcorecontrol#SessionConfig": { + "type": "structure", + "members": { + "sessionTimeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of minutes of inactivity after which an agent session is considered complete and ready for evaluation. Default is 15 minutes.
", + "smithy.api#range": { + "min": 1, + "max": 1440 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that defines how agent sessions are detected and when they are considered complete for evaluation.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SessionConfiguration": { + "type": "structure", + "members": { + "sessionTimeoutInSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The session timeout in seconds. After this timeout, the session expires and subsequent requests to this session will receive an error. The minimum value is 900 seconds (15 minutes), the maximum value is 28800 seconds (8 hours), and the default value is 3600 seconds (1 hour).
", + "smithy.api#range": { + "min": 900, + "max": 28800 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The session configuration for an MCP gateway. This structure defines settings that control session behavior.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SessionStorageConfiguration": { + "type": "structure", + "members": { + "mountPath": { + "target": "com.amazonaws.bedrockagentcorecontrol#MountPath", + "traits": { + "smithy.api#documentation": "The mount path for the session storage filesystem inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data).
Configuration for a session storage filesystem mounted into the AgentCore Runtime. Session storage provides persistent storage that is preserved across AgentCore Runtime session invocations.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SetTokenVaultCMK": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#SetTokenVaultCMKRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#SetTokenVaultCMKResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Sets the customer master key (CMK) for a token vault.
", + "smithy.api#http": { + "uri": "/identities/set-token-vault-cmk", + "method": "POST" + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#SetTokenVaultCMKRequest": { + "type": "structure", + "members": { + "tokenVaultId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TokenVaultIdType", + "traits": { + "smithy.api#documentation": "The unique identifier of the token vault to update.
" + } + }, + "kmsConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsConfiguration", + "traits": { + "smithy.api#documentation": "The KMS configuration for the token vault, including the key type and KMS key ARN.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#SetTokenVaultCMKResponse": { + "type": "structure", + "members": { + "tokenVaultId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TokenVaultIdType", + "traits": { + "smithy.api#documentation": "The ID of the token vault.
", + "smithy.api#required": {} + } + }, + "kmsConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsConfiguration", + "traits": { + "smithy.api#documentation": "The KMS configuration for the token vault.
", + "smithy.api#required": {} + } + }, + "lastModifiedDate": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the token vault was last modified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#SigningAlgorithm": { + "type": "enum", + "members": { + "RS256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RS256" + } + }, + "PS256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PS256" + } + }, + "ES256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES256" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#SkillDefinition": { + "type": "structure", + "members": { + "schemaVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#SchemaVersion", + "traits": { + "smithy.api#documentation": "The version of the skill definition schema.
" + } + }, + "inlineContent": { + "target": "com.amazonaws.bedrockagentcorecontrol#InlineContent", + "traits": { + "smithy.api#documentation": "The JSON content containing the structured skill definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structured skill definition with schema version and content.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SkillMdDefinition": { + "type": "structure", + "members": { + "inlineContent": { + "target": "com.amazonaws.bedrockagentcorecontrol#InlineContent", + "traits": { + "smithy.api#documentation": "The markdown content describing the agent's skills in a human-readable format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The skill markdown definition for an agent skills descriptor.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SlackOauth2ProviderConfigInput": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the Slack OAuth2 provider.
", + "smithy.api#required": {} + } + }, + "clientSecret": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultClientSecretType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The client secret for the Slack OAuth2 provider.
" + } + }, + "clientSecretConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretReference", + "traits": { + "smithy.api#documentation": "A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.
The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
Input configuration for a Slack OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SlackOauth2ProviderConfigOutput": { + "type": "structure", + "members": { + "oauthDiscovery": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2Discovery", + "traits": { + "smithy.api#documentation": "The OAuth2 discovery information for the Slack provider.
", + "smithy.api#required": {} + } + }, + "clientId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientIdType", + "traits": { + "smithy.api#documentation": "The client ID for the Slack OAuth2 provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Output configuration for a Slack OAuth2 provider.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#StartPolicyGeneration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#StartPolicyGenerationRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#StartPolicyGenerationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Initiates the AI-powered generation of Cedar policies from natural language descriptions within the AgentCore Policy system. This feature enables both technical and non-technical users to create policies by describing their authorization requirements in plain English, which is then automatically translated into formal Cedar policy statements. The generation process analyzes the natural language input along with the Gateway's tool context to produce validated policy options. Generated policy assets are automatically deleted after 7 days, so you should review and create policies from the generated assets within this timeframe. Once created, policies are permanent and not subject to this expiration. Generated policies should be reviewed and tested in log-only mode before deploying to production. Use this when you want to describe policy intent naturally rather than learning Cedar syntax, though generated policies may require refinement for complex scenarios.
", + "smithy.api#http": { + "method": "POST", + "uri": "/policy-engines/{policyEngineId}/policy-generations", + "code": 202 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#StartPolicyGenerationRequest": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine that provides the context for policy generation. This engine's schema and tool context are used to ensure generated policies are valid and applicable.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resource": { + "target": "com.amazonaws.bedrockagentcorecontrol#Resource", + "traits": { + "smithy.api#documentation": "The resource information that provides context for policy generation. This helps the AI understand the target resources and generate appropriate access control rules.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentcorecontrol#Content", + "traits": { + "smithy.api#documentation": "The natural language description of the desired policy behavior. This content is processed by AI to generate corresponding Cedar policy statements that match the described intent.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationName", + "traits": { + "smithy.api#documentation": "A customer-assigned name for the policy generation request. This helps track and identify generation operations, especially when running multiple generations simultaneously.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without starting a duplicate generation.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#StartPolicyGenerationResponse": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine associated with the started policy generation.
", + "smithy.api#required": {} + } + }, + "policyGenerationId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier assigned to the policy generation request for tracking progress.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationName", + "traits": { + "smithy.api#documentation": "The customer-assigned name for the policy generation request.
", + "smithy.api#required": {} + } + }, + "policyGenerationArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationArn", + "traits": { + "smithy.api#documentation": "The ARN of the created policy generation request.
", + "smithy.api#required": {} + } + }, + "resource": { + "target": "com.amazonaws.bedrockagentcorecontrol#Resource", + "traits": { + "smithy.api#documentation": "The resource information associated with the policy generation request.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy generation request was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy generation was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyGenerationStatus", + "traits": { + "smithy.api#documentation": "The initial status of the policy generation request.
", + "smithy.api#required": {} + } + }, + "findings": { + "target": "com.amazonaws.bedrockagentcorecontrol#String", + "traits": { + "smithy.api#documentation": "Initial findings from the policy generation process.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the generation status.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#Statement": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 35, + "max": 10000 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#StaticOverride": { + "type": "structure", + "members": { + "bundleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayConfigurationBundleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration bundle to apply.
", + "smithy.api#required": {} + } + }, + "bundleVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the configuration bundle to apply.
", + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A static configuration bundle override.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#StaticRoute": { + "type": "structure", + "members": { + "targetName": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetName", + "traits": { + "smithy.api#documentation": "The name of the target to route requests to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A static route to a single gateway target.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Status": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#StatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#StatusReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#StatusReason" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#StickinessConfiguration": { + "type": "structure", + "members": { + "identifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The expression that identifies where to extract the session identifier from the request (for example, $context.header.x-session-id).
The session stickiness timeout, in seconds. After this duration of inactivity, the session affinity expires. Valid values range from 1 to 86400.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for session-sticky routing to a target. Session stickiness routes requests that share a session identifier to the same target.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#StickinessTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 86400 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#StrategyConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#OverrideType", + "traits": { + "smithy.api#documentation": "The type of override for the strategy configuration.
" + } + }, + "extraction": { + "target": "com.amazonaws.bedrockagentcorecontrol#ExtractionConfiguration", + "traits": { + "smithy.api#documentation": "The extraction configuration for the memory strategy.
" + } + }, + "consolidation": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConsolidationConfiguration", + "traits": { + "smithy.api#documentation": "The consolidation configuration for the memory strategy.
" + } + }, + "reflection": { + "target": "com.amazonaws.bedrockagentcorecontrol#ReflectionConfiguration", + "traits": { + "smithy.api#documentation": "The reflection configuration for the memory strategy.
" + } + }, + "selfManagedConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#SelfManagedConfiguration", + "traits": { + "smithy.api#documentation": "Self-managed configuration settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configuration information for a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#StreamDeliveryResource": { + "type": "union", + "members": { + "kinesis": { + "target": "com.amazonaws.bedrockagentcorecontrol#KinesisResource", + "traits": { + "smithy.api#documentation": "Kinesis Data Stream configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Supported stream delivery resource types.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#StreamDeliveryResources": { + "type": "structure", + "members": { + "resources": { + "target": "com.amazonaws.bedrockagentcorecontrol#StreamDeliveryResourcesList", + "traits": { + "smithy.api#documentation": "List of stream delivery resource configurations.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for streaming memory record data to external resources.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#StreamDeliveryResourcesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#StreamDeliveryResource" + }, + "traits": { + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#StreamingConfiguration": { + "type": "structure", + "members": { + "enableResponseStreaming": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether response streaming is enabled for the gateway. When set to true, the gateway streams responses from targets back to the client.
The streaming configuration for an MCP gateway. This structure defines settings that control response streaming behavior.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#String": { + "type": "string" + }, + "com.amazonaws.bedrockagentcorecontrol#StringListValidation": { + "type": "structure", + "members": { + "allowedValues": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedStringListValuesList", + "traits": { + "smithy.api#documentation": "Allowed values for items in this STRINGLIST field.
" + } + }, + "maxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Maximum number of items in the string list.
", + "smithy.api#range": { + "min": 1, + "max": 5 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Validation for STRINGLIST fields.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#StringValidation": { + "type": "structure", + "members": { + "allowedValues": { + "target": "com.amazonaws.bedrockagentcorecontrol#AllowedStringValuesList", + "traits": { + "smithy.api#documentation": "Allowed values for this STRING field.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Validation for STRING fields.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#StripePrivyAppIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-_]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#StripePrivyAuthorizationIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-_]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#StripePrivyConfigurationInput": { + "type": "structure", + "members": { + "appId": { + "target": "com.amazonaws.bedrockagentcorecontrol#StripePrivyAppIdType", + "traits": { + "smithy.api#documentation": "The app ID provided by Privy.
", + "smithy.api#required": {} + } + }, + "appSecret": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultStripePrivyAppSecretType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The app secret provided by Privy.
" + } + }, + "appSecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the app secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
A reference to the Amazon Web Services Secrets Manager secret that stores the app secret. This includes the secret ID and the JSON key used to extract the app secret value from the secret. Required when appSecretSource is set to EXTERNAL.
The authorization private key for the Stripe Privy integration.
" + } + }, + "authorizationPrivateKeySource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the authorization private key. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
A reference to the Amazon Web Services Secrets Manager secret that stores the authorization private key. This includes the secret ID and the JSON key used to extract the authorization private key value from the secret. Required when authorizationPrivateKeySource is set to EXTERNAL.
The authorization ID for the Stripe Privy integration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stripe Privy configuration — credentials provided by Stripe and Privy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#StripePrivyConfigurationOutput": { + "type": "structure", + "members": { + "appId": { + "target": "com.amazonaws.bedrockagentcorecontrol#StripePrivyAppIdType", + "traits": { + "smithy.api#documentation": "The app ID provided by Privy.
", + "smithy.api#required": {} + } + }, + "appSecretArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Secret", + "traits": { + "smithy.api#required": {} + } + }, + "appSecretJsonKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretJsonKeyType", + "traits": { + "smithy.api#documentation": "The JSON key used to extract the app secret value from the Amazon Web Services Secrets Manager secret.
" + } + }, + "appSecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the app secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.
The JSON key used to extract the authorization private key value from the Amazon Web Services Secrets Manager secret.
" + } + }, + "authorizationPrivateKeySource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the authorization private key. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.
The authorization ID for the Stripe Privy integration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stripe Privy configuration output with secret ARNs.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SubmitRegistryRecordForApproval": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#SubmitRegistryRecordForApprovalRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#SubmitRegistryRecordForApprovalResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Submits a registry record for approval. This transitions the record from DRAFT status to PENDING_APPROVAL status. If the registry has auto-approval enabled, the record is automatically approved.
The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "recordId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RecordIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the registry record to submit for approval. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#SubmitRegistryRecordForApprovalResponse": { + "type": "structure", + "members": { + "registryArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the registry that contains the record.
", + "smithy.api#required": {} + } + }, + "recordArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the registry record.
", + "smithy.api#required": {} + } + }, + "recordId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordId", + "traits": { + "smithy.api#documentation": "The unique identifier of the registry record.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordStatus", + "traits": { + "smithy.api#documentation": "The resulting status of the registry record after submission.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the record was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#SubnetId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^subnet-[0-9a-zA-Z]{8,17}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#SubnetId" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Subnets": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#SummaryConsolidationOverride": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for summary consolidation.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for summary consolidation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary consolidation override configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SummaryMemoryStrategyInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#Name", + "traits": { + "smithy.api#documentation": "The name of the summary memory strategy.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the summary memory strategy.
" + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#deprecated": { + "message": "Use namespaceTemplates instead", + "since": "2026-03-02" + }, + "smithy.api#documentation": "This is a legacy parameter, use namespaceTemplates. The namespaces associated with the summary memory strategy.
The namespaceTemplates associated with the summary memory strategy.
" + } + }, + "memoryRecordSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryRecordSchema", + "traits": { + "smithy.api#documentation": "Schema for metadata fields on records generated by this strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for creating a summary memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SummaryOverrideConfigurationInput": { + "type": "structure", + "members": { + "consolidation": { + "target": "com.amazonaws.bedrockagentcorecontrol#SummaryOverrideConsolidationConfigurationInput", + "traits": { + "smithy.api#documentation": "The consolidation configuration for a summary override.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for summary override configuration in a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SummaryOverrideConsolidationConfigurationInput": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for summary consolidation.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for summary consolidation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for summary override consolidation configuration in a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SynchronizationConfiguration": { + "type": "structure", + "members": { + "fromUrl": { + "target": "com.amazonaws.bedrockagentcorecontrol#FromUrlSynchronizationConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for synchronizing from a URL-based source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for synchronizing registry record metadata from an external source.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SynchronizationType": { + "type": "enum", + "members": { + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#SynchronizeGatewayTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#SynchronizeGatewayTargetsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#SynchronizeGatewayTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Synchronizes the gateway targets by fetching the latest tool definitions from the target endpoints.
You cannot synchronize a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before synchronizing.
You cannot synchronize a target that has a static tool schema (mcpToolSchema) configured. Remove the static schema through an UpdateGatewayTarget call to enable dynamic tool synchronization.
The gateway Identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "targetIdList": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetIdList", + "traits": { + "smithy.api#documentation": "The target ID list.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#SynchronizeGatewayTargetsResponse": { + "type": "structure", + "members": { + "targets": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayTargetList", + "traits": { + "smithy.api#documentation": "The gateway targets for synchronization.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#SystemManagedBlock": { + "type": "structure", + "members": { + "managedBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the system or process that manages this rule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "System-managed metadata for rules created by automated processes such as A/B tests.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.
This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.
The Amazon Resource Name (ARN) of the resource that you want to tag.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "The tags to add to the resource. A tag is a key-value pair.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TaggableResourcesArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:(?:[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:([a-z-]+/[^/]+)(?:/[a-z-]+/[^/]+)*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TagsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagKey" + }, + "value": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetConfiguration": { + "type": "union", + "members": { + "mcp": { + "target": "com.amazonaws.bedrockagentcorecontrol#McpTargetConfiguration", + "traits": { + "smithy.api#documentation": "The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.
" + } + }, + "http": { + "target": "com.amazonaws.bedrockagentcorecontrol#HttpTargetConfiguration", + "traits": { + "smithy.api#documentation": "The HTTP target configuration. Use this to route gateway requests to an HTTP-based endpoint such as an AgentCore Runtime.
" + } + }, + "inference": { + "target": "com.amazonaws.bedrockagentcorecontrol#InferenceTargetConfiguration", + "traits": { + "smithy.api#documentation": "The inference configuration for the target. This configuration routes requests to a large language model (LLM) provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][-]?){1,100}$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetProtocolType": { + "type": "enum", + "members": { + "MCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MCP" + } + }, + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetResourcePriority": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_UNSUCCESSFUL" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SYNCHRONIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNCHRONIZING" + } + }, + "SYNCHRONIZE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNCHRONIZE_UNSUCCESSFUL" + } + }, + "CREATE_PENDING_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_PENDING_AUTH" + } + }, + "UPDATE_PENDING_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_PENDING_AUTH" + } + }, + "SYNCHRONIZE_PENDING_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNCHRONIZE_PENDING_AUTH" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetSummary" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetSummary": { + "type": "structure", + "members": { + "targetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the target.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetName", + "traits": { + "smithy.api#documentation": "The name of the target.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetStatus", + "traits": { + "smithy.api#documentation": "The current status of the target.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetDescription", + "traits": { + "smithy.api#documentation": "The description of the target.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the target was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the target was last updated.
", + "smithy.api#required": {} + } + }, + "resourcePriority": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetResourcePriority", + "traits": { + "smithy.api#documentation": "Priority for resolving resource URI conflicts across targets. Lower values take precedence. Defaults to 1000 when not set.
" + } + }, + "lastSynchronizedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the target was last synchronized.
" + } + }, + "authorizationData": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizationData" + }, + "targetType": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetType", + "traits": { + "smithy.api#documentation": "The type of the target.
" + } + }, + "listingMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListingMode", + "traits": { + "smithy.api#documentation": "The listing mode for the target. MCP resources for DEFAULT targets are cached at the control plane for faster access. MCP resources for DYNAMIC targets are retrieved dynamically when listing tools.
Contains summary information about a gateway target. A target represents an endpoint that the gateway can connect to.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetTrafficSplitEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetTrafficSplitEntry" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetTrafficSplitEntry": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of this traffic split variant.
", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9-]{0,62}[a-zA-Z0-9])?$", + "smithy.api#required": {} + } + }, + "weight": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The percentage of traffic to route to this variant.
", + "smithy.api#range": { + "min": 1, + "max": 99 + }, + "smithy.api#required": {} + } + }, + "targetName": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetName", + "traits": { + "smithy.api#documentation": "The name of the target to route traffic to.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of this traffic split variant.
", + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentcorecontrol#TrafficSplitMetadataMap", + "traits": { + "smithy.api#documentation": "Key-value metadata associated with this traffic split variant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An entry in a target traffic split configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TargetType": { + "type": "enum", + "members": { + "OPEN_API_SCHEMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPEN_API_SCHEMA" + } + }, + "SMITHY_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMITHY_MODEL" + } + }, + "MCP_SERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MCP_SERVER" + } + }, + "LAMBDA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA" + } + }, + "API_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_GATEWAY" + } + }, + "CONNECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTOR" + } + }, + "AGENTCORE_RUNTIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENTCORE_RUNTIME" + } + }, + "PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSTHROUGH" + } + }, + "PROVIDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVIDER" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#Temperature": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0.0, + "max": 2.0 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TenantIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#ThrottledException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "API rate limit has been exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcorecontrol#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when the number of requests exceeds the limit
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bedrockagentcorecontrol#TimeBasedTrigger": { + "type": "structure", + "members": { + "idleSessionTimeout": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Idle session timeout (seconds) that triggers memory processing.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Trigger configuration based on time.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TimeBasedTriggerInput": { + "type": "structure", + "members": { + "idleSessionTimeout": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 20, + "smithy.api#documentation": "Idle session timeout (seconds) that triggers memory processing.
", + "smithy.api#range": { + "min": 10, + "max": 3000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Trigger configuration based on time.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TokenAuthMethod": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(client_secret_post|client_secret_basic)$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TokenBasedTrigger": { + "type": "structure", + "members": { + "tokenCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Number of tokens that trigger memory processing.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Trigger configuration based on tokens.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TokenBasedTriggerInput": { + "type": "structure", + "members": { + "tokenCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 5000, + "smithy.api#documentation": "Number of tokens that trigger memory processing.
", + "smithy.api#range": { + "min": 100, + "max": 500000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Trigger configuration based on tokens.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TokenEndpointAuthMethodsType": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#TokenAuthMethod" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TokenEndpointType": { + "type": "string" + }, + "com.amazonaws.bedrockagentcorecontrol#TokenExchangeGrantTypeConfigType": { + "type": "structure", + "members": { + "actorTokenContent": { + "target": "com.amazonaws.bedrockagentcorecontrol#ActorTokenContentType", + "traits": { + "smithy.api#documentation": "The content type for the actor token in the token exchange.
", + "smithy.api#required": {} + } + }, + "actorTokenScopes": { + "target": "com.amazonaws.bedrockagentcorecontrol#ScopesListType", + "traits": { + "smithy.api#documentation": "The scopes for the actor token. Only valid when actorTokenContent is M2M.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for RFC 8693 token exchange.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TokenVaultIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-_]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ToolDefinition": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the tool. This name identifies the tool in the Model Context Protocol.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the tool. This description provides information about the purpose and usage of the tool.
", + "smithy.api#required": {} + } + }, + "inputSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#SchemaDefinition", + "traits": { + "smithy.api#documentation": "The input schema for the tool. This schema defines the structure of the input that the tool accepts.
", + "smithy.api#required": {} + } + }, + "outputSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#SchemaDefinition", + "traits": { + "smithy.api#documentation": "The output schema for the tool. This schema defines the structure of the output that the tool produces.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ToolDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ToolDefinition" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ToolSchema": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3Configuration", + "traits": { + "smithy.api#documentation": "The Amazon S3 location of the tool schema. This location contains the schema definition file.
" + } + }, + "inlinePayload": { + "target": "com.amazonaws.bedrockagentcorecontrol#ToolDefinitions", + "traits": { + "smithy.api#documentation": "The inline payload of the tool schema. This payload contains the schema definition directly in the request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A tool schema for a gateway target. This structure defines the schema for a tool that the target exposes through the Model Context Protocol.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ToolSecretArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[a-z-]+)?:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ToolsDefinition": { + "type": "structure", + "members": { + "protocolVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#SchemaVersion", + "traits": { + "smithy.api#documentation": "The protocol version of the tools definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.
" + } + }, + "inlineContent": { + "target": "com.amazonaws.bedrockagentcorecontrol#InlineContent", + "traits": { + "smithy.api#documentation": "The JSON content containing the MCP tools definition, conforming to the MCP protocol specification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The tools definition for an MCP descriptor. Contains the protocol version and inline content describing the available tools.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ToolsFileSystemConfiguration": { + "type": "union", + "members": { + "s3FilesConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#S3FilesConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for mounting your own Amazon Simple Storage Service (Amazon S3) Files access point into the session.
" + } + }, + "efsConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#EfsConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for mounting your own Amazon Elastic File System (Amazon EFS) access point into the session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a file system to mount into the session by providing exactly one of the following:
s3FilesConfiguration - Mounts an Amazon Simple Storage Service (Amazon S3) Files access point.
efsConfiguration - Mounts an Amazon Elastic File System (Amazon EFS) access point.
The file system configurations to mount into the session. Each configuration maps an access point to a path inside the session. You can specify up to 4 configurations. The maximum is 2 Amazon Simple Storage Service (Amazon S3) Files access points and 2 Amazon Elastic File System (Amazon EFS) access points.
", + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TopK": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TopP": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0.0, + "max": 1.0 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TrafficSplitEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#TrafficSplitEntry" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TrafficSplitEntry": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of this traffic split variant.
", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9-]{0,62}[a-zA-Z0-9])?$", + "smithy.api#required": {} + } + }, + "weight": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The percentage of traffic to route to this variant. Weights across all entries must sum to 100.
", + "smithy.api#range": { + "min": 1, + "max": 99 + }, + "smithy.api#required": {} + } + }, + "configurationBundle": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleReference", + "traits": { + "smithy.api#documentation": "The configuration bundle reference for this variant.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of this traffic split variant.
", + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentcorecontrol#TrafficSplitMetadataMap", + "traits": { + "smithy.api#documentation": "Key-value metadata associated with this traffic split variant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An entry in a traffic split configuration, defining a named variant with a weight and configuration bundle reference.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TrafficSplitMetadataKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TrafficSplitMetadataMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcorecontrol#TrafficSplitMetadataKey" + }, + "value": { + "target": "com.amazonaws.bedrockagentcorecontrol#TrafficSplitMetadataValue" + }, + "traits": { + "smithy.api#length": { + "max": 25 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TrafficSplitMetadataValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TriggerCondition": { + "type": "union", + "members": { + "messageBasedTrigger": { + "target": "com.amazonaws.bedrockagentcorecontrol#MessageBasedTrigger", + "traits": { + "smithy.api#documentation": "Message based trigger configuration.
" + } + }, + "tokenBasedTrigger": { + "target": "com.amazonaws.bedrockagentcorecontrol#TokenBasedTrigger", + "traits": { + "smithy.api#documentation": "Token based trigger configuration.
" + } + }, + "timeBasedTrigger": { + "target": "com.amazonaws.bedrockagentcorecontrol#TimeBasedTrigger", + "traits": { + "smithy.api#documentation": "Time based trigger configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Condition that triggers memory processing.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TriggerConditionInput": { + "type": "union", + "members": { + "messageBasedTrigger": { + "target": "com.amazonaws.bedrockagentcorecontrol#MessageBasedTriggerInput", + "traits": { + "smithy.api#documentation": "Message based trigger configuration.
" + } + }, + "tokenBasedTrigger": { + "target": "com.amazonaws.bedrockagentcorecontrol#TokenBasedTriggerInput", + "traits": { + "smithy.api#documentation": "Token based trigger configuration.
" + } + }, + "timeBasedTrigger": { + "target": "com.amazonaws.bedrockagentcorecontrol#TimeBasedTriggerInput", + "traits": { + "smithy.api#documentation": "Time based trigger configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Condition that triggers memory processing.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TriggerConditionInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#TriggerConditionInput" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TriggerConditionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#TriggerCondition" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcorecontrol#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access
", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.bedrockagentcorecontrol#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the specified tags from the specified resource.
This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.
The Amazon Resource Name (ARN) of the resource that you want to untag.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagKeyList", + "traits": { + "smithy.api#documentation": "The tag keys of the tags to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntime": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntimeRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntimeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Amazon Secure Agent.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/runtimes/{agentRuntimeId}/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntimeEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntimeEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntimeEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Amazon Bedrock AgentCore Runtime endpoint.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/runtimes/{agentRuntimeId}/runtime-endpoints/{endpointName}/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntimeEndpointRequest": { + "type": "structure", + "members": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime associated with the endpoint.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "endpointName": { + "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the AgentCore Runtime endpoint to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentRuntimeVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The updated version of the AgentCore Runtime for the endpoint.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointDescription", + "traits": { + "smithy.api#documentation": "The updated description of the AgentCore Runtime endpoint.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntimeEndpointResponse": { + "type": "structure", + "members": { + "liveVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The currently deployed version of the AgentCore Runtime on the endpoint.
" + } + }, + "targetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The target version of the AgentCore Runtime for the endpoint.
" + } + }, + "agentRuntimeEndpointArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.
", + "smithy.api#required": {} + } + }, + "agentRuntimeArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointStatus", + "traits": { + "smithy.api#documentation": "The current status of the updated AgentCore Runtime endpoint.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the AgentCore Runtime endpoint was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the AgentCore Runtime endpoint was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntimeRequest": { + "type": "structure", + "members": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AgentCore Runtime to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentRuntimeArtifact": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArtifact", + "traits": { + "smithy.api#documentation": "The updated artifact of the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The updated IAM role ARN that provides permissions for the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "networkConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "The updated network configuration for the AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The updated description of the AgentCore Runtime.
" + } + }, + "authorizerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", + "traits": { + "smithy.api#documentation": "The updated authorizer configuration for the AgentCore Runtime.
" + } + }, + "requestHeaderConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#RequestHeaderConfiguration", + "traits": { + "smithy.api#documentation": "The updated configuration for HTTP request headers that will be passed through to the runtime.
" + } + }, + "protocolConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#ProtocolConfiguration" + }, + "lifecycleConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#LifecycleConfiguration", + "traits": { + "smithy.api#documentation": "The updated life cycle configuration for the AgentCore Runtime.
" + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#RuntimeMetadataConfiguration", + "traits": { + "smithy.api#documentation": "The updated configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.
" + } + }, + "environmentVariables": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnvironmentVariablesMap", + "traits": { + "smithy.api#documentation": "Updated environment variables to set in the AgentCore Runtime environment.
" + } + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#FilesystemConfigurations", + "traits": { + "smithy.api#documentation": "The updated filesystem configurations to mount into the AgentCore Runtime.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntimeResponse": { + "type": "structure", + "members": { + "agentRuntimeArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "workloadIdentityDetails": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails", + "traits": { + "smithy.api#documentation": "The workload identity details for the updated AgentCore Runtime.
" + } + }, + "agentRuntimeVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", + "traits": { + "smithy.api#documentation": "The version of the updated AgentCore Runtime.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the AgentCore Runtime was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the AgentCore Runtime was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeStatus", + "traits": { + "smithy.api#documentation": "The current status of the updated AgentCore Runtime.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateApiKeyCredentialProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateApiKeyCredentialProviderRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateApiKeyCredentialProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#DecryptionFailure" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#EncryptionFailure" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Updates an existing API key credential provider.
", + "smithy.api#http": { + "uri": "/identities/UpdateApiKeyCredentialProvider", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateApiKeyCredentialProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the API key credential provider to update.
", + "smithy.api#required": {} + } + }, + "apiKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#DefaultApiKeyType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "The new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.
" + } + }, + "apiKeySecretConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretReference", + "traits": { + "smithy.api#documentation": "A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.
The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
The Amazon Resource Name (ARN) of the API key secret in Amazon Web Services Secrets Manager.
", + "smithy.api#property": {}, + "smithy.api#required": {} + } + }, + "apiKeySecretJsonKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretJsonKeyType", + "traits": { + "smithy.api#documentation": "The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.
", + "smithy.api#property": {} + } + }, + "apiKeySecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.
The name of the API key credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApiKeyCredentialProviderArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the API key credential provider.
", + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the API key credential provider was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the API key credential provider was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateConfigurationBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateConfigurationBundleRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateConfigurationBundleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a configuration bundle by creating a new version with the specified changes. Each update creates a new version in the version history.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/configuration-bundles/{bundleId}" + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateConfigurationBundleRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "bundleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the configuration bundle to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "bundleName": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleName", + "traits": { + "smithy.api#documentation": "The updated name for the configuration bundle.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleDescription", + "traits": { + "smithy.api#documentation": "The updated description for the configuration bundle.
" + } + }, + "components": { + "target": "com.amazonaws.bedrockagentcorecontrol#ComponentConfigurationMap", + "traits": { + "smithy.api#documentation": "The updated component configurations. Creates a new version of the bundle.
" + } + }, + "parentVersionIds": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersionList", + "traits": { + "smithy.api#documentation": "A list of parent version identifiers for lineage tracking. Regular commits have a single parent. Merge commits have two parents: the target branch parent and the source branch parent. If the branch already exists, the first parent must be the latest version on that branch.
" + } + }, + "branchName": { + "target": "com.amazonaws.bedrockagentcorecontrol#BranchName", + "traits": { + "smithy.api#documentation": "The branch name for this version. If not specified, inherits the parent's branch or defaults to mainline.
A commit message describing the changes in this version.
", + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "createdBy": { + "target": "com.amazonaws.bedrockagentcorecontrol#VersionCreatedBySource", + "traits": { + "smithy.api#documentation": "The source that created this version, including the source name and optional ARN.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "Optional KMS key ARN for encrypting component configurations. If provided, components will be encrypted with this key. If the bundle already has a KMS key, this rotates to the new key.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateConfigurationBundleResponse": { + "type": "structure", + "members": { + "bundleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated configuration bundle.
", + "smithy.api#required": {} + } + }, + "bundleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated configuration bundle.
", + "smithy.api#required": {} + } + }, + "versionId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersion", + "traits": { + "smithy.api#documentation": "The new version identifier created by this update.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the configuration bundle was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateDatasetRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": " Updates a dataset's metadata. Synchronous operation. Only provided fields are updated; omitted fields remain unchanged. To modify dataset content, use AddDatasetExamples, UpdateDatasetExamples, or DeleteDatasetExamples.
Updates multiple existing examples in-place on DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics).
", + "smithy.api#http": { + "method": "POST", + "uri": "/datasets/{datasetId}/examples/update", + "code": 202 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateDatasetExamplesRequest": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "examples": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetExampleList", + "traits": { + "smithy.api#documentation": " Examples to update. Each element is a JSON object containing a required exampleId field identifying the existing example, plus the replacement fields. Maximum 1000 examples per call.
The Amazon Resource Name (ARN) of the dataset.
", + "smithy.api#required": {} + } + }, + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetStatus", + "traits": { + "smithy.api#documentation": "The current status of the dataset.
", + "smithy.api#required": {} + } + }, + "updatedCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of examples updated.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the examples were updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateDatasetRequest": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the dataset to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The updated description for the dataset.
", + "smithy.api#length": { + "max": 200 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateDatasetResponse": { + "type": "structure", + "members": { + "datasetArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated dataset.
", + "smithy.api#required": {} + } + }, + "datasetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated dataset.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the dataset was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateEvaluator": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateEvaluatorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateEvaluatorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a custom evaluator's configuration, description, or evaluation level. Built-in evaluators cannot be updated. The evaluator must not be locked for modification.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/evaluators/{evaluatorId}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateEvaluatorRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "evaluatorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the evaluator to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorDescription", + "traits": { + "smithy.api#documentation": "The updated description of the evaluator.
" + } + }, + "evaluatorConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorConfig", + "traits": { + "smithy.api#documentation": "The updated configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.
" + } + }, + "level": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorLevel", + "traits": { + "smithy.api#documentation": " The updated evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.
The Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data. Specify a new key ARN to rotate the encryption key, or specify a key ARN to add encryption to an evaluator that was previously created without one. When you rotate to a new key, the service decrypts the existing data with the old key and re-encrypts it with the new key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateEvaluatorResponse": { + "type": "structure", + "members": { + "evaluatorArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated evaluator.
", + "smithy.api#required": {} + } + }, + "evaluatorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated evaluator.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the evaluator was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorStatus", + "traits": { + "smithy.api#documentation": "The status of the evaluator update operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing gateway.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/gateways/{gatewayIdentifier}/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayRequest": { + "type": "structure", + "members": { + "gatewayIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the gateway to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayName", + "traits": { + "smithy.api#documentation": "The name of the gateway. This name must be the same as the one when the gateway was created.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayDescription", + "traits": { + "smithy.api#documentation": "The updated description for the gateway.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The updated IAM role ARN that provides permissions for the gateway.
", + "smithy.api#required": {} + } + }, + "protocolType": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "MCP", + "smithy.api#documentation": "The updated protocol type for the gateway.
" + } + }, + "protocolConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolConfiguration" + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerType", + "traits": { + "smithy.api#documentation": "The updated authorizer type for the gateway.
", + "smithy.api#required": {} + } + }, + "authorizerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", + "traits": { + "smithy.api#documentation": "The updated authorizer configuration for the gateway.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The updated ARN of the KMS key used to encrypt the gateway.
" + } + }, + "customTransformConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomTransformConfiguration", + "traits": { + "smithy.api#documentation": "The updated custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.
" + } + }, + "interceptorConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayInterceptorConfigurations", + "traits": { + "smithy.api#documentation": "The updated interceptor configurations for the gateway.
" + } + }, + "policyEngineConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayPolicyEngineConfiguration", + "traits": { + "smithy.api#documentation": "The updated policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.
" + } + }, + "exceptionLevel": { + "target": "com.amazonaws.bedrockagentcorecontrol#ExceptionLevel", + "traits": { + "smithy.api#documentation": "The level of detail in error messages returned when invoking the gateway.
If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.
If the value is omitted, a generic error message is returned to the end user.
The updated Amazon Web Services WAF configuration for the gateway.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayResponse": { + "type": "structure", + "members": { + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated gateway.
", + "smithy.api#required": {} + } + }, + "gatewayId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated gateway.
", + "smithy.api#required": {} + } + }, + "gatewayUrl": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayUrl", + "traits": { + "smithy.api#documentation": "An endpoint for invoking the updated gateway.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the gateway was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the gateway was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayStatus", + "traits": { + "smithy.api#documentation": "The current status of the updated gateway.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", + "traits": { + "smithy.api#documentation": "The reasons for the current status of the updated gateway.
" + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayName", + "traits": { + "smithy.api#documentation": "The name of the gateway.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayDescription", + "traits": { + "smithy.api#documentation": "The updated description of the gateway.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The updated IAM role ARN that provides permissions for the gateway.
" + } + }, + "protocolType": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolType", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "MCP", + "smithy.api#documentation": "The updated protocol type for the gateway.
" + } + }, + "protocolConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolConfiguration" + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerType", + "traits": { + "smithy.api#documentation": "The updated authorizer type for the gateway.
", + "smithy.api#required": {} + } + }, + "authorizerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", + "traits": { + "smithy.api#documentation": "The updated authorizer configuration for the gateway.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The updated ARN of the KMS key used to encrypt the gateway.
" + } + }, + "customTransformConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomTransformConfiguration", + "traits": { + "smithy.api#documentation": "The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.
" + } + }, + "interceptorConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayInterceptorConfigurations", + "traits": { + "smithy.api#documentation": "The updated interceptor configurations for the gateway.
" + } + }, + "policyEngineConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayPolicyEngineConfiguration", + "traits": { + "smithy.api#documentation": "The updated policy engine configuration for the gateway.
" + } + }, + "workloadIdentityDetails": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails", + "traits": { + "smithy.api#documentation": "The workload identity details for the updated gateway.
" + } + }, + "exceptionLevel": { + "target": "com.amazonaws.bedrockagentcorecontrol#ExceptionLevel", + "traits": { + "smithy.api#documentation": "The level of detail in error messages returned when invoking the gateway.
If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.
If the value is omitted, a generic error message is returned to the end user.
The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway.
" + } + }, + "wafConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#WafConfiguration", + "traits": { + "smithy.api#documentation": "The Amazon Web Services WAF configuration for the gateway.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayRuleRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a gateway rule's priority, conditions, actions, or description.
", + "smithy.api#http": { + "code": 202, + "method": "PATCH", + "uri": "/gateways/{gatewayIdentifier}/rules/{ruleId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayRuleRequest": { + "type": "structure", + "members": { + "gatewayIdentifier": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the gateway containing the rule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ruleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the rule to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "priority": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRulePriority", + "traits": { + "smithy.api#documentation": "The updated priority of the rule.
" + } + }, + "conditions": { + "target": "com.amazonaws.bedrockagentcorecontrol#Conditions", + "traits": { + "smithy.api#documentation": "The updated conditions for the rule.
" + } + }, + "actions": { + "target": "com.amazonaws.bedrockagentcorecontrol#Actions", + "traits": { + "smithy.api#documentation": "The updated actions for the rule.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleDescription", + "traits": { + "smithy.api#documentation": "The updated description of the rule.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayRuleResponse": { + "type": "structure", + "members": { + "ruleId": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the gateway rule.
", + "smithy.api#required": {} + } + }, + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway that the rule belongs to.
", + "smithy.api#required": {} + } + }, + "priority": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRulePriority", + "traits": { + "smithy.api#documentation": "The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.
", + "smithy.api#required": {} + } + }, + "conditions": { + "target": "com.amazonaws.bedrockagentcorecontrol#Conditions", + "traits": { + "smithy.api#documentation": "The conditions that must be met for the rule to apply.
" + } + }, + "actions": { + "target": "com.amazonaws.bedrockagentcorecontrol#Actions", + "traits": { + "smithy.api#documentation": "The actions to take when the rule conditions are met.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleDescription", + "traits": { + "smithy.api#documentation": "The description of the gateway rule.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the rule was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayRuleStatus", + "traits": { + "smithy.api#documentation": "The current status of the rule.
", + "smithy.api#required": {} + } + }, + "system": { + "target": "com.amazonaws.bedrockagentcorecontrol#SystemManagedBlock", + "traits": { + "smithy.api#documentation": "System-managed metadata for rules created by automated processes.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the rule was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Create response excludes updatedAt (redundant on create).\nGet/Update responses include it via their own output structures.", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayTargetRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing gateway target.
You cannot update a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before updating the target.
The unique identifier of the gateway associated with the target.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "targetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the gateway target to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetName", + "traits": { + "smithy.api#documentation": "The updated name for the gateway target.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetDescription", + "traits": { + "smithy.api#documentation": "The updated description for the gateway target.
" + } + }, + "targetConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "credentialProviderConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderConfigurations", + "traits": { + "smithy.api#documentation": "The updated credential provider configurations for the gateway target.
" + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#MetadataConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for HTTP header and query parameter propagation to the gateway target.
" + } + }, + "privateEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpoint", + "traits": { + "smithy.api#documentation": "The private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateGatewayTargetResponse": { + "type": "structure", + "members": { + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway.
", + "smithy.api#required": {} + } + }, + "targetId": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated gateway target.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the gateway target was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the gateway target was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetStatus", + "traits": { + "smithy.api#documentation": "The current status of the updated gateway target.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", + "traits": { + "smithy.api#documentation": "The reasons for the current status of the updated gateway target.
" + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetName", + "traits": { + "smithy.api#documentation": "The updated name of the gateway target.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetDescription", + "traits": { + "smithy.api#documentation": "The updated description of the gateway target.
" + } + }, + "targetConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "credentialProviderConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderConfigurations", + "traits": { + "smithy.api#documentation": "The updated credential provider configurations for the gateway target.
", + "smithy.api#required": {} + } + }, + "lastSynchronizedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the targets were last synchronized.
" + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#MetadataConfiguration", + "traits": { + "smithy.api#documentation": "The metadata configuration that was applied to the gateway target.
" + } + }, + "privateEndpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpoint", + "traits": { + "smithy.api#documentation": "The private endpoint configuration for the gateway target.
" + } + }, + "privateEndpointManagedResources": { + "target": "com.amazonaws.bedrockagentcorecontrol#PrivateEndpointManagedResources", + "traits": { + "smithy.api#documentation": "The managed resources created by the gateway for private endpoint connectivity.
" + } + }, + "authorizationData": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizationData", + "traits": { + "smithy.api#documentation": "OAuth2 authorization data for the updated gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.
" + } + }, + "protocolType": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetProtocolType", + "traits": { + "smithy.api#documentation": "The protocol type of the updated gateway target.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateHarness": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateHarnessRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateHarnessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Operation to update a harness.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/harnesses/{harnessId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateHarnessEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateHarnessEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateHarnessEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Operation to update a harness endpoint.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/harnesses/{harnessId}/endpoints/{endpointName}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateHarnessEndpointRequest": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness that the endpoint belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "endpointName": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointName", + "traits": { + "smithy.api#documentation": "The name of the endpoint to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "targetVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessVersion", + "traits": { + "smithy.api#documentation": "The harness version that the endpoint points to. If not specified, the existing value is retained.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpointDescription", + "traits": { + "smithy.api#documentation": "A description of the endpoint. If not specified, the existing value is retained.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateHarnessEndpointResponse": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEndpoint", + "traits": { + "smithy.api#documentation": "The updated endpoint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateHarnessRequest": { + "type": "structure", + "members": { + "harnessId": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessId", + "traits": { + "smithy.api#documentation": "The ID of the harness to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that the harness assumes when running. If not specified, the existing value is retained.
" + } + }, + "environment": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEnvironmentProviderRequest", + "traits": { + "smithy.api#documentation": "The compute environment configuration for the harness. If not specified, the existing value is retained.
" + } + }, + "environmentArtifact": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedHarnessEnvironmentArtifact", + "traits": { + "smithy.api#documentation": "The environment artifact for the harness. Use the optionalValue wrapper to set a new value, or set it to null to clear the existing configuration.
" + } + }, + "environmentVariables": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnvironmentVariablesMap", + "traits": { + "smithy.api#documentation": "Environment variables to set in the harness runtime environment. If specified, this replaces all existing environment variables. If not specified, the existing value is retained.
" + } + }, + "authorizerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedAuthorizerConfiguration" + }, + "model": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessModelConfiguration", + "traits": { + "smithy.api#documentation": "The model configuration for the harness. If not specified, the existing value is retained.
" + } + }, + "systemPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSystemPrompt", + "traits": { + "smithy.api#documentation": "The system prompt that defines the agent's behavior. If not specified, the existing value is retained.
" + } + }, + "tools": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessTools", + "traits": { + "smithy.api#documentation": "The tools available to the agent. If specified, this replaces all existing tools. If not specified, the existing value is retained.
" + } + }, + "skills": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessSkills", + "traits": { + "smithy.api#documentation": "The skills available to the agent. If specified, this replaces all existing skills. If not specified, the existing value is retained.
" + } + }, + "allowedTools": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessAllowedTools", + "traits": { + "smithy.api#documentation": "The tools that the agent is allowed to use. If specified, this replaces all existing allowed tools. If not specified, the existing value is retained.
" + } + }, + "memory": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedHarnessMemoryConfiguration", + "traits": { + "smithy.api#documentation": "The AgentCore Memory configuration. Use the optionalValue wrapper to set a new value, or set it to null to clear the existing configuration.
" + } + }, + "truncation": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessTruncationConfiguration", + "traits": { + "smithy.api#documentation": "The truncation configuration for managing conversation context. If not specified, the existing value is retained.
" + } + }, + "maxIterations": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of iterations the agent loop can execute per invocation. If not specified, the existing value is retained.
" + } + }, + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum total number of output tokens the agent can generate across all model calls within a single invocation. If not specified, the existing value is retained.
" + } + }, + "timeoutSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum duration in seconds for the agent loop execution per invocation. If not specified, the existing value is retained.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateHarnessResponse": { + "type": "structure", + "members": { + "harness": { + "target": "com.amazonaws.bedrockagentcorecontrol#Harness", + "traits": { + "smithy.api#documentation": "The updated harness.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateMemory": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateMemoryInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateMemoryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update an Amazon Bedrock AgentCore Memory resource memory.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/memories/{memoryId}/update" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateMemoryInput": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#NonEmptyString", + "traits": { + "smithy.api#documentation": "A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique AWS identifier.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#length": { + "max": 500 + } + } + }, + "memoryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the memory to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The updated description of the AgentCore Memory resource.
" + } + }, + "eventExpiryDuration": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of days after which memory events will expire, between 7 and 365 days.
", + "smithy.api#range": { + "min": 3, + "max": 365 + } + } + }, + "memoryExecutionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that provides permissions for the AgentCore Memory resource.
" + } + }, + "memoryStrategies": { + "target": "com.amazonaws.bedrockagentcorecontrol#ModifyMemoryStrategies", + "traits": { + "smithy.api#documentation": "The memory strategies to add, modify, or delete.
" + } + }, + "addIndexedKeys": { + "target": "com.amazonaws.bedrockagentcorecontrol#IndexedKeysList", + "traits": { + "smithy.api#documentation": "Additional metadata keys to index. Previously indexed keys cannot be removed.
" + } + }, + "streamDeliveryResources": { + "target": "com.amazonaws.bedrockagentcorecontrol#StreamDeliveryResources", + "traits": { + "smithy.api#documentation": "Configuration for streaming memory record data to external resources.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateMemoryOutput": { + "type": "structure", + "members": { + "memory": { + "target": "com.amazonaws.bedrockagentcorecontrol#Memory", + "traits": { + "smithy.api#documentation": "The updated AgentCore Memory resource details.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateOauth2CredentialProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateOauth2CredentialProviderRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateOauth2CredentialProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#DecryptionFailure" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#EncryptionFailure" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Updates an existing OAuth2 credential provider.
", + "smithy.api#http": { + "uri": "/identities/UpdateOauth2CredentialProvider", + "method": "POST" + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateOauth2CredentialProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the OAuth2 credential provider to update.
", + "smithy.api#required": {} + } + }, + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderVendorType", + "traits": { + "smithy.api#documentation": "The vendor of the OAuth2 credential provider.
", + "smithy.api#required": {} + } + }, + "oauth2ProviderConfigInput": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2ProviderConfigInput", + "traits": { + "smithy.api#documentation": "The configuration input for the OAuth2 provider.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateOauth2CredentialProviderResponse": { + "type": "structure", + "members": { + "clientSecretArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#Secret", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.
", + "smithy.api#property": {}, + "smithy.api#required": {} + } + }, + "clientSecretJsonKey": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretJsonKeyType", + "traits": { + "smithy.api#documentation": "The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.
", + "smithy.api#property": {} + } + }, + "clientSecretSource": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecretSourceType", + "traits": { + "smithy.api#documentation": "The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.
The name of the OAuth2 credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderVendorType", + "traits": { + "smithy.api#documentation": "The vendor of the OAuth2 credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OAuth2 credential provider.
", + "smithy.api#required": {} + } + }, + "callbackUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.
" + } + }, + "oauth2ProviderConfigOutput": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2ProviderConfigOutput", + "traits": { + "smithy.api#documentation": "The configuration output for the OAuth2 provider.
", + "smithy.api#notProperty": {}, + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the OAuth2 credential provider was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the OAuth2 credential provider was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#Status", + "traits": { + "smithy.api#documentation": "The current status of the updated OAuth2 credential provider.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateOnlineEvaluationConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateOnlineEvaluationConfigRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateOnlineEvaluationConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status. Changes take effect immediately for ongoing evaluations.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/online-evaluation-configs/{onlineEvaluationConfigId}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateOnlineEvaluationConfigRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "onlineEvaluationConfigId": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigId", + "traits": { + "smithy.api#documentation": "The unique identifier of the online evaluation configuration to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluationConfigDescription", + "traits": { + "smithy.api#documentation": "The updated description of the online evaluation configuration.
" + } + }, + "rule": { + "target": "com.amazonaws.bedrockagentcorecontrol#Rule", + "traits": { + "smithy.api#documentation": "The updated evaluation rule containing sampling configuration, filters, and session settings.
" + } + }, + "dataSourceConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#DataSourceConfig", + "traits": { + "smithy.api#documentation": "The updated data source configuration specifying CloudWatch log groups and service names to monitor.
" + } + }, + "evaluators": { + "target": "com.amazonaws.bedrockagentcorecontrol#EvaluatorList", + "traits": { + "smithy.api#documentation": "The updated list of evaluators to apply during online evaluation.
" + } + }, + "insights": { + "target": "com.amazonaws.bedrockagentcorecontrol#InsightList", + "traits": { + "smithy.api#documentation": "The updated list of insight types to run against agent sessions.
" + } + }, + "clusteringConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClusteringConfig", + "traits": { + "smithy.api#documentation": "The updated clustering configuration for periodic batch evaluation.
" + } + }, + "evaluationExecutionRoleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The updated Amazon Resource Name (ARN) of the IAM role used for evaluation execution.
" + } + }, + "executionStatus": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationExecutionStatus", + "traits": { + "smithy.api#documentation": "The updated execution status to enable or disable the online evaluation.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateOnlineEvaluationConfigResponse": { + "type": "structure", + "members": { + "onlineEvaluationConfigArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "onlineEvaluationConfigId": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the online evaluation configuration was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationConfigStatus", + "traits": { + "smithy.api#documentation": "The status of the online evaluation configuration.
", + "smithy.api#required": {} + } + }, + "executionStatus": { + "target": "com.amazonaws.bedrockagentcorecontrol#OnlineEvaluationExecutionStatus", + "traits": { + "smithy.api#documentation": "The execution status indicating whether the online evaluation is currently running.
", + "smithy.api#required": {} + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for failure if the online evaluation configuration update or execution failed.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentConnectorRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing payment connector. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
", + "smithy.api#http": { + "code": 202, + "method": "PATCH", + "uri": "/payments/managers/{paymentManagerId}/connectors/{paymentConnectorId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentConnectorRequest": { + "type": "structure", + "members": { + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the parent payment manager.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment connector to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsDescription", + "traits": { + "smithy.api#documentation": "The updated description of the payment connector.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorType", + "traits": { + "smithy.api#documentation": "The updated type of the payment connector.
" + } + }, + "credentialProviderConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialsProviderConfigurations", + "traits": { + "smithy.api#documentation": "The updated credential provider configurations for the payment connector.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentConnectorResponse": { + "type": "structure", + "members": { + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated payment connector.
", + "smithy.api#required": {} + } + }, + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the parent payment manager.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorName", + "traits": { + "smithy.api#documentation": "The name of the updated payment connector.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorType", + "traits": { + "smithy.api#documentation": "The type of the updated payment connector.
", + "smithy.api#required": {} + } + }, + "credentialProviderConfigurations": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialsProviderConfigurations", + "traits": { + "smithy.api#documentation": "The credential provider configurations for the updated payment connector.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment connector was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentConnectorStatus", + "traits": { + "smithy.api#documentation": "The current status of the updated payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
Updates an existing payment credential provider with new authentication credentials.
", + "smithy.api#http": { + "uri": "/identities/UpdatePaymentCredentialProvider", + "method": "POST" + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentCredentialProviderRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the payment credential provider to update.
", + "smithy.api#required": {} + } + }, + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderVendorType", + "traits": { + "smithy.api#documentation": "The vendor type for the payment credential provider (e.g., CoinbaseCDP, StripePrivy).
", + "smithy.api#required": {} + } + }, + "providerConfigurationInput": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentProviderConfigurationInput", + "traits": { + "smithy.api#documentation": "Configuration specific to the vendor, including API credentials.
", + "smithy.api#notProperty": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentCredentialProviderResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the updated payment credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderVendor": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderVendorType", + "traits": { + "smithy.api#documentation": "The vendor type for the updated payment credential provider.
", + "smithy.api#required": {} + } + }, + "credentialProviderArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentCredentialProviderArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated payment credential provider.
", + "smithy.api#required": {} + } + }, + "providerConfigurationOutput": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentProviderConfigurationOutput", + "traits": { + "smithy.api#documentation": "Output configuration (contains secret ARNs, excludes actual secret values).
", + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment credential provider was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment credential provider was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentManager": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentManagerRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentManagerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing payment manager. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
", + "smithy.api#http": { + "code": 202, + "method": "PATCH", + "uri": "/payments/managers/{paymentManagerId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentManagerRequest": { + "type": "structure", + "members": { + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment manager to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsDescription", + "traits": { + "smithy.api#documentation": "The updated description of the payment manager.
" + } + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsAuthorizerType", + "traits": { + "smithy.api#documentation": "The updated authorizer type for the payment manager.
" + } + }, + "authorizerConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", + "traits": { + "smithy.api#documentation": "The updated authorizer configuration for the payment manager.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The updated Amazon Resource Name (ARN) of the IAM role for the payment manager.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatePaymentManagerResponse": { + "type": "structure", + "members": { + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated payment manager.
", + "smithy.api#required": {} + } + }, + "paymentManagerId": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated payment manager.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerName", + "traits": { + "smithy.api#documentation": "The name of the updated payment manager.
", + "smithy.api#required": {} + } + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentsAuthorizerType", + "traits": { + "smithy.api#documentation": "The type of authorizer for the updated payment manager.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with the updated payment manager.
", + "smithy.api#required": {} + } + }, + "workloadIdentityDetails": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails" + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment manager was last updated.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PaymentManagerStatus", + "traits": { + "smithy.api#documentation": "The current status of the updated payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
Updates an existing policy within the AgentCore Policy system. This operation allows modification of the policy description and definition while maintaining the policy's identity. The updated policy is validated against the Cedar schema before being applied. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.
Updates an existing policy engine within the AgentCore Policy system. This operation allows modification of the policy engine description while maintaining its identity. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.
The unique identifier of the policy engine to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedDescription", + "traits": { + "smithy.api#documentation": "The new description for the policy engine.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatePolicyEngineResponse": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated policy engine.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineName", + "traits": { + "smithy.api#documentation": "The name of the updated policy engine.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The original creation timestamp of the policy engine.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy engine was last updated.
", + "smithy.api#required": {} + } + }, + "policyEngineArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineArn", + "traits": { + "smithy.api#documentation": "The ARN of the updated policy engine.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineStatus", + "traits": { + "smithy.api#documentation": "The current status of the updated policy engine.
", + "smithy.api#required": {} + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The updated description of the policy engine.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the update status.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatePolicyRequest": { + "type": "structure", + "members": { + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine that manages the policy to be updated. This ensures the policy is updated within the correct policy engine context.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy to be updated. This must be a valid policy ID that exists within the specified policy engine.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedDescription", + "traits": { + "smithy.api#documentation": "The new human-readable description for the policy. This optional field allows updating the policy's documentation while keeping the same policy logic.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyDefinition", + "traits": { + "smithy.api#documentation": "The new Cedar policy statement that defines the access control rules. This replaces the existing policy definition with new logic while maintaining the policy's identity.
" + } + }, + "validationMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyValidationMode", + "traits": { + "smithy.api#default": "FAIL_ON_ANY_FINDINGS", + "smithy.api#documentation": "The validation mode for the policy update. Determines how Cedar analyzer validation results are handled during policy updates. FAIL_ON_ANY_FINDINGS runs the Cedar analyzer and fails the update if validation issues are detected, ensuring the policy conforms to the Cedar schema and tool context. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows updates despite validation warnings. Use FAIL_ON_ANY_FINDINGS to ensure policy correctness during updates, especially when modifying policy logic or conditions.
" + } + }, + "enforcementMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnforcementMode", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The enforcement mode for the policy. Run this policy in LOG_ONLY mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to ACTIVE. If you omit this field, the policy's existing enforcement mode is unchanged.
The unique identifier of the updated policy.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyName", + "traits": { + "smithy.api#documentation": "The name of the updated policy.
", + "smithy.api#required": {} + } + }, + "policyEngineId": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the policy engine managing the updated policy.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The original creation timestamp of the policy.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was last updated.
", + "smithy.api#required": {} + } + }, + "policyArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyArn", + "traits": { + "smithy.api#documentation": "The ARN of the updated policy.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatus", + "traits": { + "smithy.api#documentation": "The current status of the updated policy.
", + "smithy.api#required": {} + } + }, + "enforcementMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#EnforcementMode", + "traits": { + "smithy.api#default": "ACTIVE", + "smithy.api#documentation": "The current enforcement mode of the updated policy.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyDefinition", + "traits": { + "smithy.api#documentation": "The updated Cedar policy statement.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The updated description of the policy.
" + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrockagentcorecontrol#PolicyStatusReasons", + "traits": { + "smithy.api#documentation": "Additional information about the update status.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockagentcorecontrol#PolicyEngineResource" + } + ] + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateRegistry": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing registry. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
", + "smithy.api#http": { + "code": 202, + "method": "PATCH", + "uri": "/registries/{registryId}" + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRecord": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRecordRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRecordResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing registry record. This operation uses PATCH semantics, so you only need to specify the fields you want to change. The update is processed asynchronously and returns HTTP 202 Accepted.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/registries/{registryId}/records/{recordId}", + "code": 202 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRecordRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "recordId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RecordIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the registry record to update. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordName", + "traits": { + "smithy.api#documentation": "The updated name for the registry record.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedDescription", + "traits": { + "smithy.api#documentation": "The updated description for the registry record. To clear the description, include the UpdatedDescription wrapper with optionalValue not specified.
The updated descriptor type for the registry record. Changing the descriptor type may require updating the descriptors field to match the new type's schema requirements.
The updated descriptor-type-specific configuration containing the resource schema and metadata. Uses PATCH semantics where individual descriptor fields can be updated independently.
" + } + }, + "recordVersion": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordVersion", + "traits": { + "smithy.api#documentation": "The version of the registry record for optimistic locking. If provided, it must match the current version of the record. The service automatically increments the version after a successful update.
" + } + }, + "synchronizationType": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedSynchronizationType", + "traits": { + "smithy.api#documentation": "The updated synchronization type for the registry record.
" + } + }, + "synchronizationConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedSynchronizationConfiguration", + "traits": { + "smithy.api#documentation": "The updated synchronization configuration for the registry record.
" + } + }, + "triggerSynchronization": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to trigger synchronization using the stored or provided configuration. When set to true, the service will synchronize the record metadata from the configured external source.
The Amazon Resource Name (ARN) of the registry that contains the updated record.
", + "smithy.api#required": {} + } + }, + "recordArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated registry record.
", + "smithy.api#required": {} + } + }, + "recordId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated registry record.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordName", + "traits": { + "smithy.api#documentation": "The name of the updated registry record.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the updated registry record.
" + } + }, + "descriptorType": { + "target": "com.amazonaws.bedrockagentcorecontrol#DescriptorType", + "traits": { + "smithy.api#documentation": "The descriptor type of the updated registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.
The descriptor-type-specific configuration of the updated registry record. For details, see the Descriptors data type.
The version of the updated registry record.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordStatus", + "traits": { + "smithy.api#documentation": "The current status of the updated registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.
The timestamp when the registry record was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the registry record was last updated.
", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for the current status of the updated registry record.
" + } + }, + "synchronizationType": { + "target": "com.amazonaws.bedrockagentcorecontrol#SynchronizationType", + "traits": { + "smithy.api#documentation": "The synchronization type of the updated registry record.
" + } + }, + "synchronizationConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#SynchronizationConfiguration", + "traits": { + "smithy.api#documentation": "The synchronization configuration of the updated registry record.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRecordStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRecordStatusRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRecordStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the status of a registry record. Use this operation to approve, reject, or deprecate a registry record.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/registries/{registryId}/records/{recordId}/status", + "code": 202 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRecordStatusRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "recordId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RecordIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the registry record to update the status for. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordStatus", + "traits": { + "smithy.api#documentation": "The target status for the registry record.
", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for the status change, such as why the record was approved or rejected.
", + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRecordStatusResponse": { + "type": "structure", + "members": { + "registryArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the registry that contains the record.
", + "smithy.api#required": {} + } + }, + "recordArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the registry record.
", + "smithy.api#required": {} + } + }, + "recordId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordId", + "traits": { + "smithy.api#documentation": "The unique identifier of the registry record.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryRecordStatus", + "traits": { + "smithy.api#documentation": "The resulting status of the registry record.
", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason for the status change.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the record was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateRegistryRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the registry to update. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryName", + "traits": { + "smithy.api#documentation": "The updated name of the registry.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedDescription", + "traits": { + "smithy.api#documentation": "The updated description of the registry. To clear the description, include the UpdatedDescription wrapper with optionalValue not specified.
The updated authorizer configuration for the registry. Changing the authorizer configuration can break existing consumers of the registry who are using the authorization type prior to the update.
" + } + }, + "approvalConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedApprovalConfiguration", + "traits": { + "smithy.api#documentation": "The updated approval configuration for registry records. The updated configuration only affects new records that move to PENDING_APPROVAL status after the change. Existing records already in PENDING_APPROVAL status are not affected.
The name of the updated registry.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the updated registry.
" + } + }, + "registryId": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated registry.
", + "smithy.api#required": {} + } + }, + "registryArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated registry.
", + "smithy.api#required": {} + } + }, + "authorizerType": { + "target": "com.amazonaws.bedrockagentcorecontrol#RegistryAuthorizerType", + "traits": { + "smithy.api#documentation": "The type of authorizer used by the updated registry. This controls the authorization method for the Search and Invoke APIs used by consumers.
CUSTOM_JWT - Authorize with a bearer token.
AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
The authorizer configuration for the updated registry. For details, see the AuthorizerConfiguration data type.
The approval configuration for the updated registry. For details, see the ApprovalConfiguration data type.
The current status of the updated registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.
The reason for the current status of the updated registry.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the registry was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the registry was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateWorkloadIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateWorkloadIdentityRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateWorkloadIdentityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Updates an existing workload identity.
", + "smithy.api#http": { + "uri": "/identities/UpdateWorkloadIdentity", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateWorkloadIdentityRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameType", + "traits": { + "smithy.api#documentation": "The name of the workload identity to update.
", + "smithy.api#required": {} + } + }, + "allowedResourceOauth2ReturnUrls": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceOauth2ReturnUrlListType", + "traits": { + "smithy.api#documentation": "The new list of allowed OAuth2 return URLs for resources associated with this workload identity. This list replaces the existing list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdateWorkloadIdentityResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameType", + "traits": { + "smithy.api#documentation": "The name of the workload identity.
", + "smithy.api#required": {} + } + }, + "workloadIdentityArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the workload identity.
", + "smithy.api#required": {} + } + }, + "allowedResourceOauth2ReturnUrls": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceOauth2ReturnUrlListType", + "traits": { + "smithy.api#documentation": "The list of allowed OAuth2 return URLs for resources associated with this workload identity.
" + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the workload identity was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the workload identity was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedA2aDescriptor": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#A2aDescriptor", + "traits": { + "smithy.api#documentation": "The updated A2A descriptor value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating an A2A descriptor with PATCH semantics. When present, the A2A descriptor is replaced with the provided value. When absent, the A2A descriptor is left unchanged. To unset, include the wrapper with the value set to null.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedAgentSkillsDescriptor": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedAgentSkillsDescriptorFields", + "traits": { + "smithy.api#documentation": "The updated agent skills descriptor fields.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating an agent skills descriptor with PATCH semantics. When present with a value, individual fields can be updated independently. When present with a null value, the entire agent skills descriptor is unset. When absent, the agent skills descriptor is left unchanged.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedAgentSkillsDescriptorFields": { + "type": "structure", + "members": { + "skillMd": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedSkillMdDefinition", + "traits": { + "smithy.api#documentation": "The updated skill markdown definition.
" + } + }, + "skillDefinition": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedSkillDefinition", + "traits": { + "smithy.api#documentation": "The updated skill definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Individual agent skills descriptor fields that can be updated independently.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedApprovalConfiguration": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#ApprovalConfiguration", + "traits": { + "smithy.api#documentation": "The updated approval configuration value. Set to null to unset the approval configuration.
Wrapper for updating an optional approval configuration field with PATCH semantics. When present in an update request, the approval configuration is replaced with the provided value. When absent, the approval configuration is left unchanged.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedAuthorizerConfiguration": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", + "traits": { + "smithy.api#documentation": "The updated authorizer configuration value. If not specified, it will clear the current authorizer configuration of the resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating an optional AuthorizerConfiguration field with PATCH semantics. When present in an update request, the authorizer configuration is replaced with optionalValue. When absent, the authorizer configuration is left unchanged. To unset, include the wrapper with optionalValue not specified.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedCustomDescriptor": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#CustomDescriptor", + "traits": { + "smithy.api#documentation": "The updated custom descriptor value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating a custom descriptor with PATCH semantics. When present, the custom descriptor is replaced with the provided value. When absent, the custom descriptor is left unchanged. To unset, include the wrapper with the value set to null.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedDescription": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "Represents an optional value that is used to update the human-readable description of the resource. If not specified, it will clear the current description of the resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating an optional Description field with PATCH semantics. When present in an update request, the description is replaced with optionalValue. When absent, the description is left unchanged. To unset the description, include the wrapper with optionalValue not specified.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedDescriptors": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedDescriptorsUnion", + "traits": { + "smithy.api#documentation": "The updated descriptors value. Contains per-descriptor-type wrappers that are each independently updatable.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating an optional descriptors field with PATCH semantics. When present with a value, individual descriptors can be updated. When present with a null value, all descriptors are unset. When absent, descriptors are left unchanged.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedDescriptorsUnion": { + "type": "structure", + "members": { + "mcp": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedMcpDescriptor", + "traits": { + "smithy.api#documentation": "The updated MCP descriptor.
" + } + }, + "a2a": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedA2aDescriptor", + "traits": { + "smithy.api#documentation": "The updated A2A descriptor.
" + } + }, + "custom": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedCustomDescriptor", + "traits": { + "smithy.api#documentation": "The updated custom descriptor.
" + } + }, + "agentSkills": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedAgentSkillsDescriptor", + "traits": { + "smithy.api#documentation": "The updated agent skills descriptor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains per-descriptor-type wrappers for updating descriptors. Each descriptor type can be updated independently.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedHarnessEnvironmentArtifact": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessEnvironmentArtifact", + "traits": { + "smithy.api#documentation": "The updated environment artifact value, or null to clear the existing configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating the environment artifact configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedHarnessMemoryConfiguration": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#HarnessMemoryConfiguration", + "traits": { + "smithy.api#documentation": "The updated memory configuration value, or null to clear the existing configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating the memory configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedMcpDescriptor": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedMcpDescriptorFields", + "traits": { + "smithy.api#documentation": "The updated MCP descriptor fields.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating an MCP descriptor with PATCH semantics. When present with a value, individual MCP fields can be updated independently. When present with a null value, the entire MCP descriptor is unset. When absent, the MCP descriptor is left unchanged.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedMcpDescriptorFields": { + "type": "structure", + "members": { + "server": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedServerDefinition", + "traits": { + "smithy.api#documentation": "The updated server definition for the MCP descriptor.
" + } + }, + "tools": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdatedToolsDefinition", + "traits": { + "smithy.api#documentation": "The updated tools definition for the MCP descriptor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Individual MCP descriptor fields that can be updated independently.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedServerDefinition": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#ServerDefinition", + "traits": { + "smithy.api#documentation": "The updated server definition value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating a server definition with PATCH semantics. When present, the server definition is replaced with the provided value. When absent, the server definition is left unchanged. To unset, include the wrapper with the value set to null.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedSkillDefinition": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#SkillDefinition", + "traits": { + "smithy.api#documentation": "The updated skill definition value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating a skill definition with PATCH semantics.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedSkillMdDefinition": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#SkillMdDefinition", + "traits": { + "smithy.api#documentation": "The updated skill markdown definition value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating a skill markdown definition with PATCH semantics.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UpdatedSynchronizationConfiguration": { + "type": "structure", + "members": { + "optionalValue": { + "target": "com.amazonaws.bedrockagentcorecontrol#SynchronizationConfiguration", + "traits": { + "smithy.api#documentation": "The updated synchronization configuration value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating the synchronization configuration with PATCH semantics. Must be matched with UpdatedSynchronizationType.
The updated synchronization type value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating the synchronization type with PATCH semantics. Must be matched with UpdatedSynchronizationConfiguration.
The updated tools definition value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Wrapper for updating a tools definition with PATCH semantics. When present, the tools definition is replaced with the provided value. When absent, the tools definition is left unchanged. To unset, include the wrapper with the value set to null.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UserPreferenceConsolidationOverride": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for user preference consolidation.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for user preference consolidation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains user preference consolidation override configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UserPreferenceExtractionOverride": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for user preference extraction.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for user preference extraction.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains user preference extraction override configuration.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UserPreferenceMemoryStrategyInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#Name", + "traits": { + "smithy.api#documentation": "The name of the user preference memory strategy.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcorecontrol#Description", + "traits": { + "smithy.api#documentation": "The description of the user preference memory strategy.
" + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcorecontrol#NamespacesList", + "traits": { + "smithy.api#deprecated": { + "message": "Use namespaceTemplates instead", + "since": "2026-03-02" + }, + "smithy.api#documentation": "This is a legacy parameter, use namespaceTemplates. The namespaces associated with the user preference memory strategy.
The namespaceTemplates associated with the user preference memory strategy.
" + } + }, + "memoryRecordSchema": { + "target": "com.amazonaws.bedrockagentcorecontrol#MemoryRecordSchema", + "traits": { + "smithy.api#documentation": "Schema for metadata fields on records generated by this strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for creating a user preference memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UserPreferenceOverrideConfigurationInput": { + "type": "structure", + "members": { + "extraction": { + "target": "com.amazonaws.bedrockagentcorecontrol#UserPreferenceOverrideExtractionConfigurationInput", + "traits": { + "smithy.api#documentation": "The extraction configuration for a user preference override.
" + } + }, + "consolidation": { + "target": "com.amazonaws.bedrockagentcorecontrol#UserPreferenceOverrideConsolidationConfigurationInput", + "traits": { + "smithy.api#documentation": "The consolidation configuration for a user preference override.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for user preference override configuration in a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UserPreferenceOverrideConsolidationConfigurationInput": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for user preference consolidation.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for user preference consolidation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for user preference override consolidation configuration in a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#UserPreferenceOverrideExtractionConfigurationInput": { + "type": "structure", + "members": { + "appendToPrompt": { + "target": "com.amazonaws.bedrockagentcorecontrol#Prompt", + "traits": { + "smithy.api#documentation": "The text to append to the prompt for user preference extraction.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The model ID to use for user preference extraction.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for user preference override extraction configuration in a memory strategy.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Validation": { + "type": "union", + "members": { + "stringValidation": { + "target": "com.amazonaws.bedrockagentcorecontrol#StringValidation" + }, + "stringListValidation": { + "target": "com.amazonaws.bedrockagentcorecontrol#StringListValidation" + }, + "numberValidation": { + "target": "com.amazonaws.bedrockagentcorecontrol#NumberValidation" + } + }, + "traits": { + "smithy.api#documentation": "Validation rules for extracted metadata values. Only one type can be specified, matching the field's data type.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationExceptionReason", + "traits": { + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationExceptionFieldList" + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by the service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagentcorecontrol#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the field.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A message describing why this field failed validation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stores information about a field passed inside a request that resulted in an exception.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationExceptionField" + } + }, + "com.amazonaws.bedrockagentcorecontrol#ValidationExceptionReason": { + "type": "enum", + "members": { + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FieldValidationFailed" + } + }, + "IDEMPOTENT_PARAMETER_MISMATCH_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IdempotentParameterMismatchException" + } + }, + "ROOT_EVENT_IN_OTHER_SESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventInOtherSession" + } + }, + "RESOURCE_CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceConflict" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#VersionCreatedBySource": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the source (for example, user, optimization-job, or system).
The Amazon Resource Name (ARN) of the source, if applicable (for example, a user ARN or optimization job ARN).
" + } + } + }, + "traits": { + "smithy.api#documentation": "The source that created a configuration bundle version.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#VersionFilter": { + "type": "structure", + "members": { + "branchName": { + "target": "com.amazonaws.bedrockagentcorecontrol#BranchName", + "traits": { + "smithy.api#documentation": "Filter by branch name.
" + } + }, + "createdByName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Filter by creation source name.
" + } + }, + "latestPerBranch": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "When true, returns only the latest version for each branch. When false or not specified, returns all versions. Can be combined with branchName to get the latest version for a specific branch.
A filter for listing configuration bundle versions.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#VersionLineageMetadata": { + "type": "structure", + "members": { + "parentVersionIds": { + "target": "com.amazonaws.bedrockagentcorecontrol#ConfigurationBundleVersionList", + "traits": { + "smithy.api#documentation": "A list of parent version identifiers. Regular commits have 0-1 parents. Merge commits have 2 parents: the target branch parent and the source branch parent. The first parent represents the primary lineage.
" + } + }, + "branchName": { + "target": "com.amazonaws.bedrockagentcorecontrol#BranchName", + "traits": { + "smithy.api#documentation": "The branch name for this version. If not specified, inherits the parent's branch or defaults to mainline.
The source that created this version.
" + } + }, + "commitMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A commit message describing the changes in this version.
", + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The version lineage metadata that tracks parent versions and creation source. Supports git-like two-parent merges for branch management.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#VpcConfig": { + "type": "structure", + "members": { + "securityGroups": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecurityGroups", + "traits": { + "smithy.api#documentation": "The security groups associated with the VPC configuration.
", + "smithy.api#required": {} + } + }, + "subnets": { + "target": "com.amazonaws.bedrockagentcorecontrol#Subnets", + "traits": { + "smithy.api#documentation": "The subnets associated with the VPC configuration.
", + "smithy.api#required": {} + } + }, + "requireServiceS3Endpoint": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "This field applies only to Agent Runtimes. It is not applicable to Browsers or Code Interpreters.
Controls whether a service-managed Amazon S3 gateway endpoint is provisioned in the VPC network topology for the agent runtime. This gateway is used by Amazon Bedrock AgentCore Runtime to download code and container images during agent startup.
Starting May 5, 2026, Amazon Bedrock AgentCore Runtime is gradually rolling out a change to how network isolation is configured for VPC mode agents. Agent runtimes created on or after this rollout will no longer include the service-managed Amazon S3 gateway. Instead, all network access, including to Amazon S3, is governed exclusively by your VPC configuration. This field cannot be set on agent runtimes created after the rollout. Passing this field in an UpdateAgentRuntime request for these agent runtimes returns a ValidationException.
Agent runtimes created before the rollout are not affected and continue to operate with the service-managed Amazon S3 gateway. To enforce full VPC network isolation on these existing agent runtimes, set this field to false via the UpdateAgentRuntime API. Before opting out, ensure your VPC provides the Amazon S3 access required for agent startup. If this field is not specified or is set to true, the service-managed Amazon S3 gateway remains provisioned.
This field is only supported in the UpdateAgentRuntime API for pre-rollout agent runtimes. Passing this field in a CreateAgentRuntime request returns a ValidationException.
VpcConfig for the Agent.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#VpcIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#WafConfiguration": { + "type": "structure", + "members": { + "failureMode": { + "target": "com.amazonaws.bedrockagentcorecontrol#WafFailureMode", + "traits": { + "smithy.api#documentation": "The failure mode that determines how the gateway handles requests when Amazon Web Services WAF is unreachable or times out. Valid values include:
FAIL_CLOSE - The gateway blocks requests when Amazon Web Services WAF cannot be evaluated.
FAIL_OPEN - The gateway allows requests when Amazon Web Services WAF cannot be evaluated.
The Amazon Web Services WAF configuration for the gateway. This configuration controls how the gateway behaves when the associated web ACL cannot be evaluated.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#WafFailureMode": { + "type": "enum", + "members": { + "FAIL_CLOSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAIL_CLOSE" + } + }, + "FAIL_OPEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAIL_OPEN" + } + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#WebAclArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z0-9\\-]+:wafv2:[a-z0-9\\-]+:[0-9]{12}:regional/webacl/.+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#WeightedOverride": { + "type": "structure", + "members": { + "trafficSplit": { + "target": "com.amazonaws.bedrockagentcorecontrol#TrafficSplitEntries", + "traits": { + "smithy.api#documentation": "The traffic split entries defining how traffic is distributed between configuration bundle versions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A weighted configuration bundle override that splits traffic between multiple bundle versions.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#WeightedRoute": { + "type": "structure", + "members": { + "trafficSplit": { + "target": "com.amazonaws.bedrockagentcorecontrol#TargetTrafficSplitEntries", + "traits": { + "smithy.api#documentation": "The traffic split entries defining how traffic is distributed between targets.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A weighted route that splits traffic between multiple gateway targets.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentity": { + "type": "resource", + "identifiers": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameType" + } + }, + "properties": { + "workloadIdentityArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityArnType" + }, + "allowedResourceOauth2ReturnUrls": { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceOauth2ReturnUrlListType" + }, + "createdTime": { + "target": "smithy.api#Timestamp" + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp" + } + }, + "put": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateWorkloadIdentity" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetWorkloadIdentity" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateWorkloadIdentity" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteWorkloadIdentity" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListWorkloadIdentities" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityArnType": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::WorkloadIdentity" + }, + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails": { + "type": "structure", + "members": { + "workloadIdentityArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityArn", + "traits": { + "smithy.api#documentation": "The ARN associated with the workload identity.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information about the workload identity.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityType" + } + }, + "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameListType": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z0-9_.-]+$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityType": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityNameType", + "traits": { + "smithy.api#documentation": "The name of the workload identity.
", + "smithy.api#required": {} + } + }, + "workloadIdentityArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityArnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the workload identity.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a workload identity.
" + } + }, + "com.amazonaws.bedrockagentcorecontrol#entryPoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + } + } +} \ No newline at end of file diff --git a/codegen/aws-models/bedrock-agentcore.json b/codegen/aws-models/bedrock-agentcore.json new file mode 100644 index 0000000..7cd5a2b --- /dev/null +++ b/codegen/aws-models/bedrock-agentcore.json @@ -0,0 +1,19558 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.bedrockagentcore#A2aDescriptor": { + "type": "structure", + "members": { + "agentCard": { + "target": "com.amazonaws.bedrockagentcore#AgentCardDefinition", + "traits": { + "smithy.api#documentation": "The agent card definition that describes the agent's capabilities and interface.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The A2A (Agent-to-Agent) descriptor configuration for a registry record.
" + } + }, + "com.amazonaws.bedrockagentcore#ABTestArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::ABTest" + }, + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:ab-test/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#ABTestDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagentcore#ABTestEvaluationConfig": { + "type": "union", + "members": { + "onlineEvaluationConfigArn": { + "target": "com.amazonaws.bedrockagentcore#OnlineEvaluationConfigArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a single online evaluation configuration to use for both variants.
" + } + }, + "perVariantOnlineEvaluationConfig": { + "target": "com.amazonaws.bedrockagentcore#PerVariantOnlineEvaluationConfigList", + "traits": { + "smithy.api#documentation": "Per-variant online evaluation configurations, allowing different evaluation settings for each variant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The evaluation configuration for an A/B test, specifying which online evaluation configurations to use for measuring variant performance.
" + } + }, + "com.amazonaws.bedrockagentcore#ABTestExecutionStatus": { + "type": "enum", + "members": { + "PAUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAUSED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_STARTED" + } + } + } + }, + "com.amazonaws.bedrockagentcore#ABTestId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#ABTestName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcore#ABTestResults": { + "type": "structure", + "members": { + "analysisTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the analysis was performed.
" + } + }, + "evaluatorMetrics": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorMetricList", + "traits": { + "smithy.api#documentation": "The per-evaluator metrics comparing control and treatment variants.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The statistical results of an A/B test.
" + } + }, + "com.amazonaws.bedrockagentcore#ABTestStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcore#ABTestSummary": { + "type": "structure", + "members": { + "abTestId": { + "target": "com.amazonaws.bedrockagentcore#ABTestId", + "traits": { + "smithy.api#documentation": "The unique identifier of the A/B test.
", + "smithy.api#required": {} + } + }, + "abTestArn": { + "target": "com.amazonaws.bedrockagentcore#ABTestArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the A/B test.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#ABTestName", + "traits": { + "smithy.api#documentation": "The name of the A/B test.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#ABTestStatus", + "traits": { + "smithy.api#documentation": "The current status of the A/B test.
", + "smithy.api#required": {} + } + }, + "executionStatus": { + "target": "com.amazonaws.bedrockagentcore#ABTestExecutionStatus", + "traits": { + "smithy.api#documentation": "The execution status of the A/B test.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#ABTestDescription", + "traits": { + "smithy.api#documentation": "The description of the A/B test.
" + } + }, + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcore#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway used for traffic splitting.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the A/B test was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the A/B test was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about an A/B test.
" + } + }, + "com.amazonaws.bedrockagentcore#ABTestSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ABTestSummary" + } + }, + "com.amazonaws.bedrockagentcore#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcore#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bedrockagentcore#AccessTokenType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 131072 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#ActorId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_/]*(?::[a-zA-Z0-9-_/]+)*[a-zA-Z0-9-_/]*$" + } + }, + "com.amazonaws.bedrockagentcore#ActorSummary": { + "type": "structure", + "members": { + "actorId": { + "target": "com.amazonaws.bedrockagentcore#ActorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the actor.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about an actor in an AgentCore Memory resource.
" + } + }, + "com.amazonaws.bedrockagentcore#ActorSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ActorSummary" + } + }, + "com.amazonaws.bedrockagentcore#AffectedSession": { + "type": "structure", + "members": { + "sessionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the affected session.
", + "smithy.api#required": {} + } + }, + "explanation": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "An explanation of how the failure manifested in this session.
", + "smithy.api#required": {} + } + }, + "fixType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of fix recommended for this failure.
", + "smithy.api#required": {} + } + }, + "recommendation": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The specific fix recommendation for this session.
", + "smithy.api#required": {} + } + }, + "failureSpans": { + "target": "com.amazonaws.bedrockagentcore#FailureSpanDetailList", + "traits": { + "smithy.api#documentation": "The list of spans where failures were detected in this session.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A session affected by a detected failure pattern, including root cause details.
" + } + }, + "com.amazonaws.bedrockagentcore#AffectedSessionList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#AffectedSession" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.bedrockagentcore#AgentCard": { + "type": "document" + }, + "com.amazonaws.bedrockagentcore#AgentCardDefinition": { + "type": "structure", + "members": { + "schemaVersion": { + "target": "com.amazonaws.bedrockagentcore#SchemaVersion", + "traits": { + "smithy.api#documentation": "The schema version of the agent card definition.
" + } + }, + "inlineContent": { + "target": "com.amazonaws.bedrockagentcore#InlineContent", + "traits": { + "smithy.api#documentation": "The inline content of the agent card definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The agent card definition for A2A descriptors, including the schema version and inline content that describes the agent's capabilities.
" + } + }, + "com.amazonaws.bedrockagentcore#AgentSkillsDescriptor": { + "type": "structure", + "members": { + "skillMd": { + "target": "com.amazonaws.bedrockagentcore#SkillMdDefinition", + "traits": { + "smithy.api#documentation": "The skill description in markdown format.
", + "smithy.api#required": {} + } + }, + "skillDefinition": { + "target": "com.amazonaws.bedrockagentcore#SkillDefinition", + "traits": { + "smithy.api#documentation": "The structured skill definition with a schema version and content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The agent skills descriptor configuration for a registry record.
" + } + }, + "com.amazonaws.bedrockagentcore#AgentTracesConfig": { + "type": "union", + "members": { + "sessionSpans": { + "target": "com.amazonaws.bedrockagentcore#Spans", + "traits": { + "smithy.api#documentation": "Agent traces provided as inline session spans in OpenTelemetry format.
" + } + }, + "cloudwatchLogs": { + "target": "com.amazonaws.bedrockagentcore#CloudWatchLogsTraceConfig", + "traits": { + "smithy.api#documentation": "Agent traces read from CloudWatch Logs.
" + } + }, + "batchEvaluation": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationTraceConfig", + "traits": { + "smithy.api#documentation": "Use a completed batch evaluation as the source of agent traces.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration specifying where to read agent traces from for recommendation analysis.
" + } + }, + "com.amazonaws.bedrockagentcore#AgenticResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentcore#GetAgentCard" + }, + { + "target": "com.amazonaws.bedrockagentcore#InvokeAgentRuntime" + }, + { + "target": "com.amazonaws.bedrockagentcore#InvokeAgentRuntimeCommand" + }, + { + "target": "com.amazonaws.bedrockagentcore#StopRuntimeSession" + } + ] + }, + "com.amazonaws.bedrockagentcore#AmazonBedrockAgentCore": { + "type": "service", + "version": "2024-02-28", + "operations": [ + { + "target": "com.amazonaws.bedrockagentcore#CompleteResourceTokenAuth" + }, + { + "target": "com.amazonaws.bedrockagentcore#GetResourceApiKey" + }, + { + "target": "com.amazonaws.bedrockagentcore#GetResourceOauth2Token" + }, + { + "target": "com.amazonaws.bedrockagentcore#GetResourcePaymentToken" + }, + { + "target": "com.amazonaws.bedrockagentcore#GetWorkloadAccessToken" + }, + { + "target": "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenForJWT" + }, + { + "target": "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenForUserId" + }, + { + "target": "com.amazonaws.bedrockagentcore#InvokeCodeInterpreter" + }, + { + "target": "com.amazonaws.bedrockagentcore#InvokeHarness" + } + ], + "resources": [ + { + "target": "com.amazonaws.bedrockagentcore#AgenticResource" + }, + { + "target": "com.amazonaws.bedrockagentcore#BrowserProfileResource" + }, + { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionResource" + }, + { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionResource" + }, + { + "target": "com.amazonaws.bedrockagentcore#EvaluationResource" + }, + { + "target": "com.amazonaws.bedrockagentcore#MemoryResource" + }, + { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentResource" + }, + { + "target": "com.amazonaws.bedrockagentcore#PaymentSessionResource" + }, + { + "target": "com.amazonaws.bedrockagentcore#ProcessPaymentResource" + }, + { + "target": "com.amazonaws.bedrockagentcore#RegistryRecordResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Bedrock AgentCore", + "arnNamespace": "bedrock-agentcore", + "endpointPrefix": "bedrock-agentcore" + }, + "aws.auth#sigv4": { + "name": "bedrock-agentcore" + }, + "aws.protocols#restJson1": { + "http": [ + "http/1.1" + ], + "eventStreamHttp": [ + "http/1.1" + ] + }, + "smithy.api#documentation": "Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.
", + "smithy.api#title": "Amazon Bedrock AgentCore", + "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 + ] + } + ], + "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://bedrock-agentcore-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://bedrock-agentcore-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://bedrock-agentcore.{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://bedrock-agentcore.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 13, + "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" + }, + "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": [], + "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" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agentcore-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agentcore-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agentcore.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agentcore.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-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://bedrock-agentcore-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://bedrock-agentcore.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-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://bedrock-agentcore-fips.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://bedrock-agentcore.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://bedrock-agentcore.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 enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agentcore-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://bedrock-agentcore.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.bedrockagentcore#Amount": { + "type": "structure", + "members": { + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The numeric value of the amount.
", + "smithy.api#required": {} + } + }, + "currency": { + "target": "com.amazonaws.bedrockagentcore#Currency", + "traits": { + "smithy.api#documentation": "The currency code for the amount.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a monetary amount with a currency.
" + } + }, + "com.amazonaws.bedrockagentcore#ApiKeyArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+$" + } + }, + "com.amazonaws.bedrockagentcore#ApiKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#AudienceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagentcore#AudiencesListType": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#AudienceType" + } + }, + "com.amazonaws.bedrockagentcore#AuthorizationUrlType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#AutomationStream": { + "type": "structure", + "members": { + "streamEndpoint": { + "target": "com.amazonaws.bedrockagentcore#BrowserStreamEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL for the automation stream. This URL is used to establish a WebSocket connection to the stream for sending commands and receiving responses.
", + "smithy.api#required": {} + } + }, + "streamStatus": { + "target": "com.amazonaws.bedrockagentcore#AutomationStreamStatus", + "traits": { + "smithy.api#documentation": "The current status of the automation stream. This indicates whether the stream is available for use. Possible values include ACTIVE, CONNECTING, and DISCONNECTED.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a stream that enables programmatic control of a browser session in Amazon Bedrock AgentCore. This stream provides a bidirectional communication channel for sending commands to the browser and receiving responses, allowing agents to automate web interactions such as navigation, form filling, and element clicking.
" + } + }, + "com.amazonaws.bedrockagentcore#AutomationStreamStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagentcore#AutomationStreamUpdate": { + "type": "structure", + "members": { + "streamStatus": { + "target": "com.amazonaws.bedrockagentcore#AutomationStreamStatus", + "traits": { + "smithy.api#documentation": "The status of the automation stream.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an update to an automation stream.
" + } + }, + "com.amazonaws.bedrockagentcore#AvailableLimits": { + "type": "structure", + "members": { + "availableSpendAmount": { + "target": "com.amazonaws.bedrockagentcore#Amount", + "traits": { + "smithy.api#documentation": "The remaining available amount that can be spent.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the available limits were last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The available spending limits for a payment session.
" + } + }, + "com.amazonaws.bedrockagentcore#BasicAuth": { + "type": "structure", + "members": { + "secretArn": { + "target": "com.amazonaws.bedrockagentcore#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing proxy credentials. The secret must be a JSON object with username and password string fields that meet validation requirements. The caller must have secretsmanager:GetSecretValue permission for this ARN. Example secret format: {\"username\": \"proxy_user\", \"password\": \"secure_password\"}
Configuration for HTTP Basic Authentication using credentials stored in Amazon Web Services Secrets Manager. The secret must contain a JSON object with username and password string fields. Username allows alphanumeric characters and @._+=- symbols (pattern: ^[a-zA-Z0-9@._+=\\-]+$). Password allows alphanumeric characters and @._+=-!#$%&* symbols (pattern: ^[a-zA-Z0-9@._+=\\-!#$%&*]+$). Both fields have a maximum length of 256 characters.
Creates multiple memory records in a single batch operation for the specified memory with custom content.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/memories/{memoryId}/memoryRecords/batchCreate" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#BatchCreateMemoryRecordsInput": { + "type": "structure", + "members": { + "memoryId": { + "target": "com.amazonaws.bedrockagentcore#MemoryId", + "traits": { + "smithy.api#documentation": "The unique ID of the memory resource where records will be created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "records": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordsCreateInputList", + "traits": { + "smithy.api#documentation": "A list of memory record creation inputs to be processed in the batch operation.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotent processing of the batch request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#BatchCreateMemoryRecordsOutput": { + "type": "structure", + "members": { + "successfulRecords": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordsOutputList", + "traits": { + "smithy.api#documentation": "A list of memory records that were successfully created during the batch operation.
", + "smithy.api#required": {} + } + }, + "failedRecords": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordsOutputList", + "traits": { + "smithy.api#documentation": "A list of memory records that failed to be created, including error details for each failure.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#BatchDeleteMemoryRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#BatchDeleteMemoryRecordsInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#BatchDeleteMemoryRecordsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes multiple memory records in a single batch operation from the specified memory.
", + "smithy.api#http": { + "method": "POST", + "uri": "/memories/{memoryId}/memoryRecords/batchDelete" + } + } + }, + "com.amazonaws.bedrockagentcore#BatchDeleteMemoryRecordsInput": { + "type": "structure", + "members": { + "memoryId": { + "target": "com.amazonaws.bedrockagentcore#MemoryId", + "traits": { + "smithy.api#documentation": "The unique ID of the memory resource where records will be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "records": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordsDeleteInputList", + "traits": { + "smithy.api#documentation": "A list of memory record deletion inputs to be processed in the batch operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#BatchDeleteMemoryRecordsOutput": { + "type": "structure", + "members": { + "successfulRecords": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordsOutputList", + "traits": { + "smithy.api#documentation": "A list of memory records that were successfully deleted during the batch operation.
", + "smithy.api#required": {} + } + }, + "failedRecords": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordsOutputList", + "traits": { + "smithy.api#documentation": "A list of memory records that failed to be deleted, including error details for each failure.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#BatchEvaluationArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::BatchEvaluate" + }, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a batch evaluation.
" + } + }, + "com.amazonaws.bedrockagentcore#BatchEvaluationDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 200 + } + } + }, + "com.amazonaws.bedrockagentcore#BatchEvaluationId": { + "type": "string", + "traits": { + "smithy.api#documentation": "The unique identifier for a batch evaluation.
", + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#BatchEvaluationName": { + "type": "string", + "traits": { + "smithy.api#documentation": "A human-readable name for a batch evaluation.
", + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcore#BatchEvaluationStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "COMPLETED_WITH_ERRORS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED_WITH_ERRORS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + }, + "traits": { + "smithy.api#documentation": "The lifecycle status of a batch evaluation job.
" + } + }, + "com.amazonaws.bedrockagentcore#BatchEvaluationSummary": { + "type": "structure", + "members": { + "batchEvaluationId": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the batch evaluation.
", + "smithy.api#required": {} + } + }, + "batchEvaluationArn": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the batch evaluation.
", + "smithy.api#required": {} + } + }, + "batchEvaluationName": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationName", + "traits": { + "smithy.api#documentation": "The name of the batch evaluation.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationStatus", + "traits": { + "smithy.api#documentation": "The current status of the batch evaluation.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the batch evaluation was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationDescription", + "traits": { + "smithy.api#documentation": "The description of the batch evaluation.
" + } + }, + "evaluators": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorList", + "traits": { + "smithy.api#documentation": "The list of evaluators applied during the batch evaluation.
" + } + }, + "insights": { + "target": "com.amazonaws.bedrockagentcore#InsightList", + "traits": { + "smithy.api#documentation": "The list of insight analyses applied during the batch evaluation.
" + } + }, + "evaluationResults": { + "target": "com.amazonaws.bedrockagentcore#EvaluationJobResults", + "traits": { + "smithy.api#documentation": "The aggregated evaluation results.
" + } + }, + "errorDetails": { + "target": "com.amazonaws.bedrockagentcore#ErrorDetailsList", + "traits": { + "smithy.api#documentation": "The error details if the batch evaluation encountered failures.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcore#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key used to encrypt evaluation data.
" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the batch evaluation was last updated.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary representation for list responses.
" + } + }, + "com.amazonaws.bedrockagentcore#BatchEvaluationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationSummary" + } + }, + "com.amazonaws.bedrockagentcore#BatchEvaluationTraceConfig": { + "type": "structure", + "members": { + "batchEvaluationArn": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationArn", + "traits": { + "smithy.api#documentation": "The ARN of the completed batch evaluation to use as the trace source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for using a batch evaluation as the source of agent traces for recommendations.
" + } + }, + "com.amazonaws.bedrockagentcore#BatchUpdateMemoryRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#BatchUpdateMemoryRecordsInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#BatchUpdateMemoryRecordsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates multiple memory records with custom content in a single batch operation within the specified memory.
", + "smithy.api#http": { + "method": "POST", + "uri": "/memories/{memoryId}/memoryRecords/batchUpdate" + } + } + }, + "com.amazonaws.bedrockagentcore#BatchUpdateMemoryRecordsInput": { + "type": "structure", + "members": { + "memoryId": { + "target": "com.amazonaws.bedrockagentcore#MemoryId", + "traits": { + "smithy.api#documentation": "The unique ID of the memory resource where records will be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "records": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordsUpdateInputList", + "traits": { + "smithy.api#documentation": "A list of memory record update inputs to be processed in the batch operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#BatchUpdateMemoryRecordsOutput": { + "type": "structure", + "members": { + "successfulRecords": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordsOutputList", + "traits": { + "smithy.api#documentation": "A list of memory records that were successfully updated during the batch operation.
", + "smithy.api#required": {} + } + }, + "failedRecords": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordsOutputList", + "traits": { + "smithy.api#documentation": "A list of memory records that failed to be updated, including error details for each failure.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#BlockchainChainId": { + "type": "enum", + "members": { + "BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Base Mainnet (EVM L2)
", + "smithy.api#enumValue": "BASE" + } + }, + "BASE_SEPOLIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Base Sepolia testnet (EVM L2)
", + "smithy.api#enumValue": "BASE_SEPOLIA" + } + }, + "ETHEREUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Ethereum Mainnet (EVM L1)
", + "smithy.api#enumValue": "ETHEREUM" + } + }, + "SOLANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Solana Mainnet
", + "smithy.api#enumValue": "SOLANA" + } + }, + "SOLANA_DEVNET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Solana Devnet testnet
", + "smithy.api#enumValue": "SOLANA_DEVNET" + } + } + }, + "traits": { + "smithy.api#documentation": "Supported blockchain chain identifiers for balance queries. Each value maps to a specific chain supported by the underlying providers (Privy, Coinbase).
" + } + }, + "com.amazonaws.bedrockagentcore#Body": { + "type": "blob", + "traits": { + "smithy.api#length": { + "max": 100000000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#Branch": { + "type": "structure", + "members": { + "rootEventId": { + "target": "com.amazonaws.bedrockagentcore#EventId", + "traits": { + "smithy.api#documentation": "The identifier of the root event for this branch.
" + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#BranchName", + "traits": { + "smithy.api#documentation": "The name of the branch.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a branch in an AgentCore Memory resource. Branches allow for organizing events into different conversation threads or paths.
" + } + }, + "com.amazonaws.bedrockagentcore#BranchFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcore#BranchName", + "traits": { + "smithy.api#documentation": "The name of the branch to filter by.
", + "smithy.api#required": {} + } + }, + "includeParentBranches": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": true, + "smithy.api#documentation": "Specifies whether to include parent branches in the results. Set to true to include parent branches, or false to exclude them.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains filter criteria for branches when listing events.
" + } + }, + "com.amazonaws.bedrockagentcore#BranchName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + } + }, + "com.amazonaws.bedrockagentcore#BrowserAction": { + "type": "union", + "members": { + "mouseClick": { + "target": "com.amazonaws.bedrockagentcore#MouseClickArguments", + "traits": { + "smithy.api#documentation": "Click at the specified coordinates.
" + } + }, + "mouseMove": { + "target": "com.amazonaws.bedrockagentcore#MouseMoveArguments", + "traits": { + "smithy.api#documentation": "Move the cursor to the specified coordinates.
" + } + }, + "mouseDrag": { + "target": "com.amazonaws.bedrockagentcore#MouseDragArguments", + "traits": { + "smithy.api#documentation": "Drag from a start position to an end position.
" + } + }, + "mouseScroll": { + "target": "com.amazonaws.bedrockagentcore#MouseScrollArguments", + "traits": { + "smithy.api#documentation": "Scroll at the specified position.
" + } + }, + "keyType": { + "target": "com.amazonaws.bedrockagentcore#KeyTypeArguments", + "traits": { + "smithy.api#documentation": "Type a string of text.
" + } + }, + "keyPress": { + "target": "com.amazonaws.bedrockagentcore#KeyPressArguments", + "traits": { + "smithy.api#documentation": "Press a key one or more times.
" + } + }, + "keyShortcut": { + "target": "com.amazonaws.bedrockagentcore#KeyShortcutArguments", + "traits": { + "smithy.api#documentation": "Press a key combination.
" + } + }, + "screenshot": { + "target": "com.amazonaws.bedrockagentcore#ScreenshotArguments", + "traits": { + "smithy.api#documentation": "Capture a full-screen screenshot.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The browser action to perform. Exactly one member must be set per request.
" + } + }, + "com.amazonaws.bedrockagentcore#BrowserActionResult": { + "type": "union", + "members": { + "mouseClick": { + "target": "com.amazonaws.bedrockagentcore#MouseClickResult", + "traits": { + "smithy.api#documentation": "The result of a mouse click action.
" + } + }, + "mouseMove": { + "target": "com.amazonaws.bedrockagentcore#MouseMoveResult", + "traits": { + "smithy.api#documentation": "The result of a mouse move action.
" + } + }, + "mouseDrag": { + "target": "com.amazonaws.bedrockagentcore#MouseDragResult", + "traits": { + "smithy.api#documentation": "The result of a mouse drag action.
" + } + }, + "mouseScroll": { + "target": "com.amazonaws.bedrockagentcore#MouseScrollResult", + "traits": { + "smithy.api#documentation": "The result of a mouse scroll action.
" + } + }, + "keyType": { + "target": "com.amazonaws.bedrockagentcore#KeyTypeResult", + "traits": { + "smithy.api#documentation": "The result of a key type action.
" + } + }, + "keyPress": { + "target": "com.amazonaws.bedrockagentcore#KeyPressResult", + "traits": { + "smithy.api#documentation": "The result of a key press action.
" + } + }, + "keyShortcut": { + "target": "com.amazonaws.bedrockagentcore#KeyShortcutResult", + "traits": { + "smithy.api#documentation": "The result of a key shortcut action.
" + } + }, + "screenshot": { + "target": "com.amazonaws.bedrockagentcore#ScreenshotResult", + "traits": { + "smithy.api#documentation": "The result of a screenshot action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a browser action execution. Exactly one member is set, matching the action that was performed.
" + } + }, + "com.amazonaws.bedrockagentcore#BrowserActionStatus": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of a browser action execution.
" + } + }, + "com.amazonaws.bedrockagentcore#BrowserEnterprisePolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#BrowserEnterprisePolicy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcore#BrowserEnterprisePolicy": { + "type": "structure", + "members": { + "location": { + "target": "com.amazonaws.bedrockagentcore#ResourceLocation", + "traits": { + "smithy.api#documentation": "The location of the enterprise policy file.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcore#BrowserEnterprisePolicyType", + "traits": { + "smithy.api#documentation": "The enterprise policy type. See BrowserEnterprisePolicyType.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Browser enterprise policy configuration.
" + } + }, + "com.amazonaws.bedrockagentcore#BrowserEnterprisePolicyType": { + "type": "enum", + "members": { + "MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED" + } + }, + "RECOMMENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECOMMENDED" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of browser enterprise policy. Available values are MANAGED and RECOMMENDED.
The location where the browser extension files are stored. This specifies the source from which the extension will be loaded and installed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Browser extension configuration.
" + } + }, + "com.amazonaws.bedrockagentcore#BrowserExtensions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#BrowserExtension" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcore#BrowserProfileConfiguration": { + "type": "structure", + "members": { + "profileIdentifier": { + "target": "com.amazonaws.bedrockagentcore#BrowserProfileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser profile. This identifier is used to reference the profile when starting new browser sessions or saving session data to the profile.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a browser profile in Amazon Bedrock AgentCore. A browser profile contains persistent browser data such as cookies and local storage that can be saved from one browser session and reused in subsequent sessions. Browser profiles enable continuity for tasks that require authentication, maintain user preferences, or depend on previously stored browser state.
" + } + }, + "com.amazonaws.bedrockagentcore#BrowserProfileId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#BrowserProfileResource": { + "type": "resource", + "identifiers": { + "profileIdentifier": { + "target": "com.amazonaws.bedrockagentcore#BrowserProfileId" + } + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentcore#SaveBrowserSessionProfile" + } + ] + }, + "com.amazonaws.bedrockagentcore#BrowserSessionId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{1,40}$" + } + }, + "com.amazonaws.bedrockagentcore#BrowserSessionResource": { + "type": "resource", + "identifiers": { + "browserIdentifier": { + "target": "smithy.api#String" + } + }, + "read": { + "target": "com.amazonaws.bedrockagentcore#GetBrowserSession" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentcore#InvokeBrowser" + }, + { + "target": "com.amazonaws.bedrockagentcore#ListBrowserSessions" + }, + { + "target": "com.amazonaws.bedrockagentcore#StartBrowserSession" + }, + { + "target": "com.amazonaws.bedrockagentcore#StopBrowserSession" + }, + { + "target": "com.amazonaws.bedrockagentcore#UpdateBrowserStream" + } + ] + }, + "com.amazonaws.bedrockagentcore#BrowserSessionStatus": { + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATED" + } + } + } + }, + "com.amazonaws.bedrockagentcore#BrowserSessionStream": { + "type": "structure", + "members": { + "automationStream": { + "target": "com.amazonaws.bedrockagentcore#AutomationStream", + "traits": { + "smithy.api#documentation": "The stream that enables programmatic control of the browser. This stream allows agents to perform actions such as navigating to URLs, clicking elements, and filling forms.
", + "smithy.api#required": {} + } + }, + "liveViewStream": { + "target": "com.amazonaws.bedrockagentcore#LiveViewStream", + "traits": { + "smithy.api#documentation": "The stream that provides a visual representation of the browser content. This stream allows agents to observe the current state of the browser, including rendered web pages and visual elements.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of streams associated with a browser session in Amazon Bedrock AgentCore. These streams provide different ways to interact with and observe the browser session, including programmatic control and visual representation of the browser content.
" + } + }, + "com.amazonaws.bedrockagentcore#BrowserSessionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionSummary" + } + }, + "com.amazonaws.bedrockagentcore#BrowserSessionSummary": { + "type": "structure", + "members": { + "browserIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser associated with the session. This identifier specifies which browser environment is used for the session.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser session. This identifier is used in operations that interact with the session.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#Name", + "traits": { + "smithy.api#documentation": "The name of the browser session. This name helps identify and manage the session.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionStatus", + "traits": { + "smithy.api#documentation": "The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser session was created. This value is in ISO 8601 format.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser session was last updated. This value is in ISO 8601 format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A condensed representation of a browser session in Amazon Bedrock AgentCore. This structure contains key information about a browser session, including identifiers, status, and timestamps, without the full details of the session configuration and streams.
" + } + }, + "com.amazonaws.bedrockagentcore#BrowserSessionTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 28800 + } + } + }, + "com.amazonaws.bedrockagentcore#BrowserStreamEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 512 + } + } + }, + "com.amazonaws.bedrockagentcore#Certificate": { + "type": "structure", + "members": { + "location": { + "target": "com.amazonaws.bedrockagentcore#CertificateLocation", + "traits": { + "smithy.api#documentation": "The location of the certificate.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A certificate to install in the browser or code interpreter session.
" + } + }, + "com.amazonaws.bedrockagentcore#CertificateLocation": { + "type": "union", + "members": { + "secretsManager": { + "target": "com.amazonaws.bedrockagentcore#SecretsManagerLocation", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Secrets Manager location of the certificate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location from which to retrieve a certificate.
" + } + }, + "com.amazonaws.bedrockagentcore#Certificates": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#Certificate" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagentcore#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 33, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}$" + } + }, + "com.amazonaws.bedrockagentcore#CloudWatchFilterConfig": { + "type": "structure", + "members": { + "sessionIds": { + "target": "com.amazonaws.bedrockagentcore#EvaluationStringList", + "traits": { + "smithy.api#documentation": "A list of specific session IDs to evaluate. If specified, only these sessions are included in the evaluation.
", + "smithy.api#length": { + "max": 500 + } + } + }, + "timeRange": { + "target": "com.amazonaws.bedrockagentcore#SessionFilterConfig", + "traits": { + "smithy.api#documentation": "The time range filter for selecting sessions to evaluate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Filter configuration for narrowing down CloudWatch Logs sessions for evaluation.
" + } + }, + "com.amazonaws.bedrockagentcore#CloudWatchLogsFilter": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The key or field name to filter on within the agent trace data.
", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$", + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.bedrockagentcore#CloudWatchLogsFilterOperator", + "traits": { + "smithy.api#documentation": "The comparison operator to use for filtering.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrockagentcore#FilterValue", + "traits": { + "smithy.api#documentation": "The value to compare against using the specified operator.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A filter for narrowing down agent traces from CloudWatch Logs based on key-value comparisons.
" + } + }, + "com.amazonaws.bedrockagentcore#CloudWatchLogsFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#CloudWatchLogsFilter" + } + }, + "com.amazonaws.bedrockagentcore#CloudWatchLogsFilterOperator": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Equals" + } + }, + "NOT_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotEquals" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThan" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThan" + } + }, + "GREATER_THAN_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEqual" + } + }, + "LESS_THAN_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEqual" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Contains" + } + }, + "NOT_CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotContains" + } + } + }, + "traits": { + "smithy.api#documentation": "The comparison operator used to filter CloudWatch Logs entries.
" + } + }, + "com.amazonaws.bedrockagentcore#CloudWatchLogsRule": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrockagentcore#CloudWatchLogsFilterList", + "traits": { + "smithy.api#documentation": "The list of filters to apply when reading agent traces.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A rule configuration for filtering agent traces from CloudWatch Logs.
" + } + }, + "com.amazonaws.bedrockagentcore#CloudWatchLogsSource": { + "type": "structure", + "members": { + "serviceNames": { + "target": "com.amazonaws.bedrockagentcore#EvaluationStringList", + "traits": { + "smithy.api#documentation": "The list of agent service names to filter traces within the specified log groups.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "logGroupNames": { + "target": "com.amazonaws.bedrockagentcore#EvaluationStringList", + "traits": { + "smithy.api#documentation": "The list of CloudWatch log group names to read agent traces from. Maximum of 5 log groups.
", + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#required": {} + } + }, + "filterConfig": { + "target": "com.amazonaws.bedrockagentcore#CloudWatchFilterConfig", + "traits": { + "smithy.api#documentation": "Optional filter configuration to narrow down which sessions to evaluate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for reading agent traces from CloudWatch Logs.
" + } + }, + "com.amazonaws.bedrockagentcore#CloudWatchLogsTraceConfig": { + "type": "structure", + "members": { + "logGroupArns": { + "target": "com.amazonaws.bedrockagentcore#LogGroupArnList", + "traits": { + "smithy.api#documentation": "The list of CloudWatch log group ARNs to read agent traces from.
", + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#required": {} + } + }, + "serviceNames": { + "target": "com.amazonaws.bedrockagentcore#ServiceNameList", + "traits": { + "smithy.api#documentation": "The list of service names to filter traces within the specified log groups.
", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the time range to read traces from.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the time range to read traces from.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "rule": { + "target": "com.amazonaws.bedrockagentcore#CloudWatchLogsRule", + "traits": { + "smithy.api#documentation": "Optional rule configuration for filtering traces.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for reading agent traces from CloudWatch Logs for recommendation analysis.
" + } + }, + "com.amazonaws.bedrockagentcore#CloudWatchOutputConfig": { + "type": "structure", + "members": { + "logGroupName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the CloudWatch log group where evaluation results will be written.
", + "smithy.api#required": {} + } + }, + "logStreamName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the CloudWatch log stream where evaluation results will be written.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "CloudWatch Logs destination for batch evaluation results.
" + } + }, + "com.amazonaws.bedrockagentcore#CodeInterpreterResult": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.bedrockagentcore#ContentBlockList", + "traits": { + "smithy.api#documentation": "The textual content of the execution result. This includes standard output from the code execution, such as print statements, console output, and text representations of results.
", + "smithy.api#required": {} + } + }, + "structuredContent": { + "target": "com.amazonaws.bedrockagentcore#ToolResultStructuredContent", + "traits": { + "smithy.api#documentation": "The structured content of the execution result. This includes additional metadata about the execution, such as execution time, memory usage, and structured representations of output data. The format depends on the specific code interpreter and execution context.
" + } + }, + "isError": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the result represents an error. If true, the content contains error messages or exception information. If false, the content contains successful execution results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output produced by executing code in a code interpreter session in Amazon Bedrock AgentCore. This structure contains the results of code execution, including textual output, structured data, and error information. Agents use these results to generate responses that incorporate computation, data analysis, and visualization.
" + } + }, + "com.amazonaws.bedrockagentcore#CodeInterpreterSessionId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{1,40}$" + } + }, + "com.amazonaws.bedrockagentcore#CodeInterpreterSessionResource": { + "type": "resource", + "identifiers": { + "codeInterpreterIdentifier": { + "target": "smithy.api#String" + } + }, + "read": { + "target": "com.amazonaws.bedrockagentcore#GetCodeInterpreterSession" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentcore#ListCodeInterpreterSessions" + }, + { + "target": "com.amazonaws.bedrockagentcore#StartCodeInterpreterSession" + }, + { + "target": "com.amazonaws.bedrockagentcore#StopCodeInterpreterSession" + } + ] + }, + "com.amazonaws.bedrockagentcore#CodeInterpreterSessionStatus": { + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATED" + } + } + } + }, + "com.amazonaws.bedrockagentcore#CodeInterpreterSessionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionSummary" + } + }, + "com.amazonaws.bedrockagentcore#CodeInterpreterSessionSummary": { + "type": "structure", + "members": { + "codeInterpreterIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the code interpreter associated with the session. This identifier specifies which code interpreter environment is used for the session.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the code interpreter session. This identifier is used in operations that interact with the session.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#Name", + "traits": { + "smithy.api#documentation": "The name of the code interpreter session. This name helps identify and manage the session.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionStatus", + "traits": { + "smithy.api#documentation": "The current status of the code interpreter session. Possible values include ACTIVE, STOPPING, and STOPPED.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the code interpreter session was created. This value is in ISO 8601 format.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the code interpreter session was last updated. This value is in ISO 8601 format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A condensed representation of a code interpreter session in Amazon Bedrock AgentCore. This structure contains key information about a code interpreter session, including identifiers, status, and timestamps, without the full details of the session configuration.
" + } + }, + "com.amazonaws.bedrockagentcore#CodeInterpreterSessionTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 28800 + } + } + }, + "com.amazonaws.bedrockagentcore#CodeInterpreterStreamOutput": { + "type": "union", + "members": { + "result": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterResult" + }, + "accessDeniedException": { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + "conflictException": { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + "internalServerException": { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + "resourceNotFoundException": { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + "serviceQuotaExceededException": { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + "throttlingException": { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + "validationException": { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + }, + "traits": { + "smithy.api#documentation": "Contains output from a code interpreter stream.
", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockagentcore#CoinbaseCdpPaymentJwtTokenType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#CoinbaseCdpPaymentRequestBodyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E]+$" + } + }, + "com.amazonaws.bedrockagentcore#CoinbaseCdpTokenRequestInput": { + "type": "structure", + "members": { + "requestMethod": { + "target": "com.amazonaws.bedrockagentcore#PaymentHttpMethodType", + "traits": { + "smithy.api#documentation": "The HTTP method for the payment API request.
", + "smithy.api#required": {} + } + }, + "requestHost": { + "target": "com.amazonaws.bedrockagentcore#PaymentRequestHostType", + "traits": { + "smithy.api#documentation": "The host for the payment API request. Defaults to \"api.cdp.coinbase.com\".
" + } + }, + "requestPath": { + "target": "com.amazonaws.bedrockagentcore#PaymentRequestPathType", + "traits": { + "smithy.api#documentation": "The path of the payment API request.
", + "smithy.api#required": {} + } + }, + "includeWalletAuthToken": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Set to true for wallet write operations (requires walletSecret configured).
" + } + }, + "requestBody": { + "target": "com.amazonaws.bedrockagentcore#CoinbaseCdpPaymentRequestBodyType", + "traits": { + "smithy.api#documentation": "Request body JSON — used to generate wallet auth JWT.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Coinbase CDP token request parameters.
" + } + }, + "com.amazonaws.bedrockagentcore#CoinbaseCdpTokenResponseOutput": { + "type": "structure", + "members": { + "bearerToken": { + "target": "com.amazonaws.bedrockagentcore#CoinbaseCdpPaymentJwtTokenType", + "traits": { + "smithy.api#documentation": "Bearer Token for Authorization header.
", + "smithy.api#required": {} + } + }, + "walletAuthToken": { + "target": "com.amazonaws.bedrockagentcore#CoinbaseCdpPaymentJwtTokenType", + "traits": { + "smithy.api#documentation": "Wallet Auth Token for X-Wallet-Auth header.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Coinbase CDP token response.
" + } + }, + "com.amazonaws.bedrockagentcore#CommandExecutionStatus": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMED_OUT" + } + } + } + }, + "com.amazonaws.bedrockagentcore#CompleteResourceTokenAuth": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#CompleteResourceTokenAuthRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#CompleteResourceTokenAuthResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.
", + "smithy.api#http": { + "uri": "/identities/CompleteResourceTokenAuth", + "method": "POST" + } + } + }, + "com.amazonaws.bedrockagentcore#CompleteResourceTokenAuthRequest": { + "type": "structure", + "members": { + "userIdentifier": { + "target": "com.amazonaws.bedrockagentcore#UserIdentifier", + "traits": { + "smithy.api#documentation": "The OAuth2.0 token or user ID that was used to generate the workload access token used for initiating the user authorization flow to retrieve OAuth2.0 tokens.
", + "smithy.api#required": {} + } + }, + "sessionUri": { + "target": "com.amazonaws.bedrockagentcore#RequestUri", + "traits": { + "smithy.api#documentation": "Unique identifier for the user's authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#CompleteResourceTokenAuthResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#ConfidenceInterval": { + "type": "structure", + "members": { + "lower": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The lower bound of the confidence interval.
" + } + }, + "upper": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The upper bound of the confidence interval.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A confidence interval for a statistical measurement.
" + } + }, + "com.amazonaws.bedrockagentcore#ConfigurationBundleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:configuration-bundle/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#ConfigurationBundleRef": { + "type": "structure", + "members": { + "bundleArn": { + "target": "com.amazonaws.bedrockagentcore#ConfigurationBundleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "bundleVersion": { + "target": "com.amazonaws.bedrockagentcore#ConfigurationBundleVersion", + "traits": { + "smithy.api#documentation": "The version of the configuration bundle.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to a specific version of a configuration bundle.
" + } + }, + "com.amazonaws.bedrockagentcore#ConfigurationBundleToolEntry": { + "type": "structure", + "members": { + "toolName": { + "target": "com.amazonaws.bedrockagentcore#RecommendationToolName", + "traits": { + "smithy.api#documentation": "The name of the tool.
", + "smithy.api#required": {} + } + }, + "toolDescriptionJsonPath": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The JSON path within the configuration bundle's components that contains the tool description.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Maps a tool name to its JSON path within a configuration bundle.
" + } + }, + "com.amazonaws.bedrockagentcore#ConfigurationBundleToolEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ConfigurationBundleToolEntry" + } + }, + "com.amazonaws.bedrockagentcore#ConfigurationBundleVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.bedrockagentcore#ConfigurationBundleVersionId": { + "type": "string" + }, + "com.amazonaws.bedrockagentcore#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcore#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.bedrockagentcore#Content": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentcore#SensitiveString", + "traits": { + "smithy.api#documentation": "The text content of the memory item.
", + "smithy.api#length": { + "min": 1, + "max": 100000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the content of a memory item.
" + } + }, + "com.amazonaws.bedrockagentcore#ContentBlock": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentcore#ContentBlockType", + "traits": { + "smithy.api#documentation": "The type of content in the block.
", + "smithy.api#required": {} + } + }, + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text content of the block.
" + } + }, + "data": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "The binary data content of the block.
" + } + }, + "mimeType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The MIME type of the content.
" + } + }, + "uri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The URI of the content.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the content block.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the content block.
" + } + }, + "size": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The size of the content in bytes.
" + } + }, + "resource": { + "target": "com.amazonaws.bedrockagentcore#ResourceContent", + "traits": { + "smithy.api#documentation": "The resource associated with the content block.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A block of content in a response.
" + } + }, + "com.amazonaws.bedrockagentcore#ContentBlockList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ContentBlock" + } + }, + "com.amazonaws.bedrockagentcore#ContentBlockType": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "text" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "image" + } + }, + "EMBEDDED_RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resource" + } + }, + "RESOURCE_LINK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resource_link" + } + } + } + }, + "com.amazonaws.bedrockagentcore#ContentDeltaEvent": { + "type": "structure", + "members": { + "stdout": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The standard output content from the command execution. This field contains the incremental output written to stdout by the executing command.
" + } + }, + "stderr": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The standard error content from the command execution. This field contains the incremental output written to stderr by the executing command.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An event that contains incremental output from a command execution. This event streams standard output and standard error content as it becomes available during command execution.
" + } + }, + "com.amazonaws.bedrockagentcore#ContentStartEvent": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "An event that signals the start of content streaming from a command execution. This event is sent when the command begins producing output.
" + } + }, + "com.amazonaws.bedrockagentcore#ContentStopEvent": { + "type": "structure", + "members": { + "exitCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The exit code returned by the executed command. An exit code of 0 indicates successful execution, -1 indicates a platform error, and values greater than 0 indicate command-specific errors.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#CommandExecutionStatus", + "traits": { + "smithy.api#documentation": "The final status of the command execution. Valid values are COMPLETED for successful completion or TIMED_OUT if the command exceeded the specified timeout.
An event that signals the completion of a command execution. This event contains the final status and exit code of the executed command.
" + } + }, + "com.amazonaws.bedrockagentcore#Context": { + "type": "union", + "members": { + "spanContext": { + "target": "com.amazonaws.bedrockagentcore#SpanContext", + "traits": { + "smithy.api#documentation": "The span context information that uniquely identifies the trace and span being evaluated, including session ID, trace ID, and span ID for precise targeting within the agent's execution flow.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The contextual information associated with an evaluation, including span context details that identify the specific traces and sessions being evaluated within the agent's execution flow.
" + } + }, + "com.amazonaws.bedrockagentcore#ControlStats": { + "type": "structure", + "members": { + "variantName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the control variant.
", + "smithy.api#required": {} + } + }, + "sampleSize": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of sessions evaluated for the control variant.
", + "smithy.api#required": {} + } + }, + "mean": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The mean evaluation score for the control variant.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Statistics for the control variant in an A/B test.
" + } + }, + "com.amazonaws.bedrockagentcore#Conversational": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.bedrockagentcore#Content", + "traits": { + "smithy.api#documentation": "The content of the conversation message.
", + "smithy.api#required": {} + } + }, + "role": { + "target": "com.amazonaws.bedrockagentcore#Role", + "traits": { + "smithy.api#documentation": "The role of the participant in the conversation (for example, \"user\" or \"assistant\").
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains conversational content for an event payload.
" + } + }, + "com.amazonaws.bedrockagentcore#CreateABTest": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#CreateABTestRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#CreateABTestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an A/B test for comparing agent configurations. A/B tests split traffic between a control variant and a treatment variant through a gateway, then evaluate performance using online evaluation configurations to determine which variant performs better.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ab-tests", + "code": 202 + } + } + }, + "com.amazonaws.bedrockagentcore#CreateABTestRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcore#ABTestName", + "traits": { + "smithy.api#documentation": "The name of the A/B test. Must be unique within your account.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#ABTestDescription", + "traits": { + "smithy.api#documentation": "The description of the A/B test.
" + } + }, + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcore#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway to use for traffic splitting.
", + "smithy.api#required": {} + } + }, + "variants": { + "target": "com.amazonaws.bedrockagentcore#VariantList", + "traits": { + "smithy.api#documentation": "The list of variants for the A/B test. Must contain exactly two variants: a control (C) and a treatment (T1), each with a configuration bundle or target reference and a traffic weight.
", + "smithy.api#required": {} + } + }, + "gatewayFilter": { + "target": "com.amazonaws.bedrockagentcore#GatewayFilter", + "traits": { + "smithy.api#documentation": "Optional filter to restrict which gateway target paths are included in the A/B test.
" + } + }, + "evaluationConfig": { + "target": "com.amazonaws.bedrockagentcore#ABTestEvaluationConfig", + "traits": { + "smithy.api#documentation": "The evaluation configuration specifying which online evaluation configurations to use for measuring variant performance.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcore#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN that grants permissions for the A/B test to access gateway and evaluation resources.
", + "smithy.api#required": {} + } + }, + "enableOnCreate": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to enable the A/B test immediately upon creation. If true, traffic splitting begins automatically.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcore#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to associate with the A/B test.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#CreateABTestResponse": { + "type": "structure", + "members": { + "abTestId": { + "target": "com.amazonaws.bedrockagentcore#ABTestId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created A/B test.
", + "smithy.api#required": {} + } + }, + "abTestArn": { + "target": "com.amazonaws.bedrockagentcore#ABTestArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created A/B test.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#ABTestName", + "traits": { + "smithy.api#documentation": "The name of the A/B test.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#ABTestStatus", + "traits": { + "smithy.api#documentation": "The status of the A/B test.
", + "smithy.api#required": {} + } + }, + "executionStatus": { + "target": "com.amazonaws.bedrockagentcore#ABTestExecutionStatus", + "traits": { + "smithy.api#documentation": "The execution status indicating whether the A/B test is currently running.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the A/B test was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#CreateEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#CreateEventInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#CreateEventOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InvalidInputException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#RetryableConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an event in an AgentCore Memory resource. Events represent interactions or activities that occur within a session and are associated with specific actors.
To use this operation, you must have the bedrock-agentcore:CreateEvent permission.
This operation is subject to request rate limiting.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/memories/{memoryId}/events" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#CreateEventInput": { + "type": "structure", + "members": { + "memoryId": { + "target": "com.amazonaws.bedrockagentcore#MemoryId", + "traits": { + "smithy.api#documentation": "The identifier of the AgentCore Memory resource in which to create the event.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actorId": { + "target": "com.amazonaws.bedrockagentcore#ActorId", + "traits": { + "smithy.api#documentation": "The identifier of the actor associated with this event. An actor represents an entity that participates in sessions and generates events.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionId", + "traits": { + "smithy.api#documentation": "The identifier of the session in which this event occurs. A session represents a sequence of related events.
" + } + }, + "eventTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the event occurred. If not specified, the current time is used.
", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.bedrockagentcore#PayloadTypeList", + "traits": { + "smithy.api#documentation": "The content payload of the event. This can include conversational data or binary content.
", + "smithy.api#required": {} + } + }, + "branch": { + "target": "com.amazonaws.bedrockagentcore#Branch", + "traits": { + "smithy.api#documentation": "The branch information for this event. Branches allow for organizing events into different conversation threads or paths.
" + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, AgentCore ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentcore#MetadataMap", + "traits": { + "smithy.api#documentation": "The key-value metadata to attach to the event.
" + } + }, + "extractionMode": { + "target": "com.amazonaws.bedrockagentcore#ExtractionMode", + "traits": { + "smithy.api#documentation": "Controls long-term memory extraction for this event. When set to SKIP, the event is stored in short-term memory but is excluded from long-term memory extraction. If not specified, the event is processed for extraction as usual.
The event that was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#CreatePaymentInstrument": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#CreatePaymentInstrumentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#CreatePaymentInstrumentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create a new payment instrument for a connector.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/payments/createPaymentInstrument" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#CreatePaymentInstrumentRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID associated with this payment instrument.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-User-Id" + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagentcore#PaymentAgentName", + "traits": { + "smithy.api#documentation": "The agent name associated with this request, used for observability.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-Agent-Name" + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager that owns this payment instrument.
", + "smithy.api#required": {} + } + }, + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcore#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The ID of the payment connector to use for this instrument.
", + "smithy.api#required": {} + } + }, + "paymentInstrumentType": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentType", + "traits": { + "smithy.api#documentation": "The type of payment instrument being created.
", + "smithy.api#required": {} + } + }, + "paymentInstrumentDetails": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentDetails", + "traits": { + "smithy.api#documentation": "The details of the payment instrument.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request structure for creating a payment instrument.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#CreatePaymentInstrumentResponse": { + "type": "structure", + "members": { + "paymentInstrument": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrument", + "traits": { + "smithy.api#documentation": "The created payment instrument.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response structure for creating a payment instrument.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#CreatePaymentSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#CreatePaymentSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#CreatePaymentSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create a new payment session.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/payments/createPaymentSession" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#CreatePaymentSessionRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID associated with this payment session.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-User-Id" + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagentcore#PaymentAgentName", + "traits": { + "smithy.api#documentation": "The agent name associated with this request, used for observability.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-Agent-Name" + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager that owns this session.
", + "smithy.api#required": {} + } + }, + "limits": { + "target": "com.amazonaws.bedrockagentcore#SessionLimits", + "traits": { + "smithy.api#documentation": "The spending limits for this payment session.
" + } + }, + "expiryTimeInMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The session expiry time in minutes. Must be between 15 and 480 minutes.
", + "smithy.api#range": { + "min": 15, + "max": 480 + }, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request structure for creating a payment session.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#CreatePaymentSessionResponse": { + "type": "structure", + "members": { + "paymentSession": { + "target": "com.amazonaws.bedrockagentcore#PaymentSession", + "traits": { + "smithy.api#documentation": "The created payment session.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response structure for creating a payment session.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#CredentialProviderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-_]+$" + } + }, + "com.amazonaws.bedrockagentcore#CryptoWalletNetwork": { + "type": "enum", + "members": { + "ETHEREUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ETHEREUM" + } + }, + "SOLANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOLANA" + } + } + }, + "traits": { + "smithy.api#documentation": "Supported blockchain networks for crypto wallets.
" + } + }, + "com.amazonaws.bedrockagentcore#CryptoX402PaymentInput": { + "type": "structure", + "members": { + "version": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the X402 protocol.
", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.bedrockagentcore#PaymentDocument", + "traits": { + "smithy.api#documentation": "The X402 payment payload.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input for a crypto X402 payment.
" + } + }, + "com.amazonaws.bedrockagentcore#CryptoX402PaymentOutput": { + "type": "structure", + "members": { + "version": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the X402 protocol.
", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.bedrockagentcore#PaymentDocument", + "traits": { + "smithy.api#documentation": "The X402 payment response payload.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The output from a crypto X402 payment.
" + } + }, + "com.amazonaws.bedrockagentcore#Currency": { + "type": "enum", + "members": { + "USD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USD" + } + } + }, + "traits": { + "smithy.api#documentation": "Supported currency codes.
" + } + }, + "com.amazonaws.bedrockagentcore#CustomDescriptor": { + "type": "structure", + "members": { + "inlineContent": { + "target": "com.amazonaws.bedrockagentcore#InlineContent", + "traits": { + "smithy.api#documentation": "The inline content of the custom descriptor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A custom descriptor configuration for a registry record.
" + } + }, + "com.amazonaws.bedrockagentcore#CustomRequestKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-_\\.]+$" + } + }, + "com.amazonaws.bedrockagentcore#CustomRequestParametersType": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcore#CustomRequestKeyType" + }, + "value": { + "target": "com.amazonaws.bedrockagentcore#CustomRequestValueType" + } + }, + "com.amazonaws.bedrockagentcore#CustomRequestValueType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#DataSourceConfig": { + "type": "union", + "members": { + "cloudWatchLogs": { + "target": "com.amazonaws.bedrockagentcore#CloudWatchLogsSource", + "traits": { + "smithy.api#documentation": "Configuration for pulling agent session traces from CloudWatch Logs.
" + } + }, + "onlineEvaluationConfigSource": { + "target": "com.amazonaws.bedrockagentcore#OnlineEvaluationConfigSource", + "traits": { + "smithy.api#documentation": "Reference an existing OnlineEvaluationConfig as session source" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for the data source used in evaluation.
" + } + }, + "com.amazonaws.bedrockagentcore#DateTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.bedrockagentcore#DeleteABTest": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#DeleteABTestRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#DeleteABTestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an A/B test and its associated gateway rules.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/ab-tests/{abTestId}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#DeleteABTestRequest": { + "type": "structure", + "members": { + "abTestId": { + "target": "com.amazonaws.bedrockagentcore#ABTestId", + "traits": { + "smithy.api#documentation": "The unique identifier of the A/B test to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#DeleteABTestResponse": { + "type": "structure", + "members": { + "abTestId": { + "target": "com.amazonaws.bedrockagentcore#ABTestId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted A/B test.
", + "smithy.api#required": {} + } + }, + "abTestArn": { + "target": "com.amazonaws.bedrockagentcore#ABTestArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted A/B test.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#ABTestStatus", + "traits": { + "smithy.api#documentation": "The status of the A/B test deletion operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#DeleteBatchEvaluation": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#DeleteBatchEvaluationRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#DeleteBatchEvaluationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a batch evaluation and its associated results.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/evaluations/batch-evaluate/{batchEvaluationId}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#DeleteBatchEvaluationRequest": { + "type": "structure", + "members": { + "batchEvaluationId": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the batch evaluation to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#DeleteBatchEvaluationResponse": { + "type": "structure", + "members": { + "batchEvaluationId": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted batch evaluation.
", + "smithy.api#required": {} + } + }, + "batchEvaluationArn": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted batch evaluation.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationStatus", + "traits": { + "smithy.api#documentation": "The status of the batch evaluation deletion operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#DeleteEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#DeleteEventInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#DeleteEventOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InvalidInputException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an event from an AgentCore Memory resource. When you delete an event, it is permanently removed.
To use this operation, you must have the bedrock-agentcore:DeleteEvent permission.
The identifier of the AgentCore Memory resource from which to delete the event.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionId", + "traits": { + "smithy.api#documentation": "The identifier of the session containing the event to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "eventId": { + "target": "com.amazonaws.bedrockagentcore#EventId", + "traits": { + "smithy.api#documentation": "The identifier of the event to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actorId": { + "target": "com.amazonaws.bedrockagentcore#ActorId", + "traits": { + "smithy.api#documentation": "The identifier of the actor associated with the event to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#DeleteEventOutput": { + "type": "structure", + "members": { + "eventId": { + "target": "com.amazonaws.bedrockagentcore#EventId", + "traits": { + "smithy.api#documentation": "The identifier of the event that was deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#DeleteMemoryRecord": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#DeleteMemoryRecordInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#DeleteMemoryRecordOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InvalidInputException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a memory record from an AgentCore Memory resource. When you delete a memory record, it is permanently removed.
To use this operation, you must have the bedrock-agentcore:DeleteMemoryRecord permission.
The identifier of the AgentCore Memory resource from which to delete the memory record.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "memoryRecordId": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordId", + "traits": { + "smithy.api#documentation": "The identifier of the memory record to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#DeleteMemoryRecordOutput": { + "type": "structure", + "members": { + "memoryRecordId": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordId", + "traits": { + "smithy.api#documentation": "The identifier of the memory record that was deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#DeletePaymentInstrument": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#DeletePaymentInstrumentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#DeletePaymentInstrumentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a payment instrument. This is a soft delete operation that preserves the record for audit and compliance purposes.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/payments/deletePaymentInstrument" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#DeletePaymentInstrumentRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID making the delete request. Must match the instrument's userId.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-User-Id" + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The payment manager ARN. Must match the instrument's paymentManagerArn.
", + "smithy.api#required": {} + } + }, + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcore#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The payment connector ID. Must match the instrument's paymentConnectorId.
", + "smithy.api#required": {} + } + }, + "paymentInstrumentId": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentId", + "traits": { + "smithy.api#documentation": "The payment instrument ID to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request structure for deleting a payment instrument.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#DeletePaymentInstrumentResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentStatus", + "traits": { + "smithy.api#documentation": "The status of the instrument after deletion. Always DELETED for successful soft delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response structure for deleting a payment instrument.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#DeletePaymentSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#DeletePaymentSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#DeletePaymentSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a payment session. This permanently removes the payment session record.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/payments/deletePaymentSession" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#DeletePaymentSessionRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID making the delete request. Must match the session's userId.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-User-Id" + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The payment manager ARN. Must match the session's paymentManagerArn.
", + "smithy.api#required": {} + } + }, + "paymentSessionId": { + "target": "com.amazonaws.bedrockagentcore#PaymentSessionId", + "traits": { + "smithy.api#documentation": "The payment session ID to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request structure for deleting a payment session.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#DeletePaymentSessionResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcore#PaymentSessionStatus", + "traits": { + "smithy.api#documentation": "The status of the deletion. Always DELETED for successful hard delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response structure for deleting a payment session.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#DeleteRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#DeleteRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#DeleteRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a recommendation and its associated results.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/recommendations/{recommendationId}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#DeleteRecommendationRequest": { + "type": "structure", + "members": { + "recommendationId": { + "target": "com.amazonaws.bedrockagentcore#RecommendationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the recommendation to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#DeleteRecommendationResponse": { + "type": "structure", + "members": { + "recommendationId": { + "target": "com.amazonaws.bedrockagentcore#RecommendationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the deleted recommendation.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#RecommendationStatus", + "traits": { + "smithy.api#documentation": "The status of the recommendation deletion operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#DescriptorType": { + "type": "enum", + "members": { + "MCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MCP" + } + }, + "A2A": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A2A" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "AGENT_SKILLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_SKILLS" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of descriptor associated with a registry record.
" + } + }, + "com.amazonaws.bedrockagentcore#Descriptors": { + "type": "structure", + "members": { + "mcp": { + "target": "com.amazonaws.bedrockagentcore#McpDescriptor", + "traits": { + "smithy.api#documentation": " The MCP (Model Context Protocol) descriptor configuration. Populated when the record's descriptorType is MCP.
The A2A (Agent-to-Agent) descriptor configuration. Populated when the record's descriptorType is A2A.
The custom descriptor configuration. Populated when the record's descriptorType is CUSTOM.
The agent skills descriptor configuration. Populated when the record's descriptorType is AGENT_SKILLS.
Contains the descriptor configuration for a registry record. Only the field that matches the record's descriptorType is populated.
An exception thrown when attempting to create a resource with an identifier that already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.bedrockagentcore#EfsAccessPointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}$" + } + }, + "com.amazonaws.bedrockagentcore#EfsConfiguration": { + "type": "structure", + "members": { + "accessPointArn": { + "target": "com.amazonaws.bedrockagentcore#EfsAccessPointArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Elastic File System (Amazon EFS) access point to mount.
", + "smithy.api#required": {} + } + }, + "mountPath": { + "target": "com.amazonaws.bedrockagentcore#MountPath", + "traits": { + "smithy.api#documentation": "The absolute path within the session at which the access point is mounted, for example /mnt/efs. Each mount path must be unique across all file system configurations in the session.
The Amazon Resource Name (ARN) of the Amazon Elastic File System (Amazon EFS) file system that owns the access point.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for mounting an Amazon Elastic File System (Amazon EFS) access point that you own into a session.
" + } + }, + "com.amazonaws.bedrockagentcore#EfsFileSystemArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Elastic File System (Amazon EFS) file system. The access points you specify must belong to this file system.
", + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:elasticfilesystem:[a-z0-9-]+:[0-9]{12}:file-system/fs-[0-9a-f]{8,40}$" + } + }, + "com.amazonaws.bedrockagentcore#Email": { + "type": "string", + "traits": { + "smithy.api#documentation": "Email address with validation for standard email format.
", + "smithy.api#length": { + "min": 1, + "max": 254 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#EmbeddedCryptoWallet": { + "type": "structure", + "members": { + "network": { + "target": "com.amazonaws.bedrockagentcore#CryptoWalletNetwork", + "traits": { + "smithy.api#documentation": "The blockchain network for this embedded crypto wallet. Supported networks: ETHEREUM, SOLANA.
", + "smithy.api#required": {} + } + }, + "linkedAccounts": { + "target": "com.amazonaws.bedrockagentcore#LinkedAccountList", + "traits": { + "smithy.api#documentation": "List of linked accounts linked to this wallet. Each represents a way the end user can authenticate to this wallet.
", + "smithy.api#required": {} + } + }, + "walletAddress": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The wallet address on the specified blockchain network.
" + } + }, + "redirectUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "URL for the end user to complete a provider-specific action such as wallet linking or onboarding.
", + "smithy.api#length": { + "max": 2048 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Embedded crypto wallet instrument details.
" + } + }, + "com.amazonaws.bedrockagentcore#ErrorDetailsList": { + "type": "list", + "member": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "max": 1000 + } + } + }, + "traits": { + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentcore#Evaluate": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#EvaluateRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#EvaluateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#DuplicateIdException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Performs on-demand evaluation of agent traces using a specified evaluator. This synchronous API accepts traces in OpenTelemetry format and returns immediate scoring results with detailed explanations.
", + "smithy.api#http": { + "method": "POST", + "uri": "/evaluations/evaluate/{evaluatorId}" + } + } + }, + "com.amazonaws.bedrockagentcore#EvaluateRequest": { + "type": "structure", + "members": { + "evaluatorId": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorId", + "traits": { + "smithy.api#documentation": " The unique identifier of the evaluator to use for scoring. Can be a built-in evaluator (e.g., Builtin.Helpfulness, Builtin.Correctness) or a custom evaluator Id created through the control plane API.
The input data containing agent session spans to be evaluated. Includes a list of spans in OpenTelemetry format from supported frameworks like Strands (AgentCore Runtime) or LangGraph with OpenInference instrumentation.
", + "smithy.api#required": {} + } + }, + "evaluationTarget": { + "target": "com.amazonaws.bedrockagentcore#EvaluationTarget", + "traits": { + "smithy.api#documentation": "The specific trace or span IDs to evaluate within the provided input. Allows targeting evaluation at different levels: individual tool calls, single request-response interactions (traces), or entire conversation sessions.
" + } + }, + "evaluationReferenceInputs": { + "target": "com.amazonaws.bedrockagentcore#EvaluationReferenceInputs", + "traits": { + "smithy.api#documentation": "Ground truth data to compare against agent responses during evaluation. Allows to provide expected responses, assertions, and expected tool trajectories at different evaluation levels. Session-level reference inputs apply to the entire conversation, while trace-level reference inputs target specific request-response interactions identified by trace ID.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#EvaluateResponse": { + "type": "structure", + "members": { + "evaluationResults": { + "target": "com.amazonaws.bedrockagentcore#EvaluationResults", + "traits": { + "smithy.api#documentation": "The detailed evaluation results containing scores, explanations, and metadata. Includes the evaluator information, numerical or categorical ratings based on the evaluator's rating scale, and token usage statistics for the evaluation process.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#EvaluationContent": { + "type": "union", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text content of the ground truth data. Used for expected response text and assertion statements.
", + "smithy.api#length": { + "min": 1, + "max": 100000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "A content block for ground truth data in evaluation reference inputs. Supports text content for expected responses and assertions.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluationContentList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#EvaluationContent" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcore#EvaluationErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.bedrockagentcore#EvaluationErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagentcore#EvaluationExpectedTrajectory": { + "type": "structure", + "members": { + "toolNames": { + "target": "com.amazonaws.bedrockagentcore#EvaluationToolNames", + "traits": { + "smithy.api#documentation": "The list of tool names representing the expected tool call sequence.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The expected tool call trajectory for trajectory-based evaluation.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluationExplanation": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#EvaluationInput": { + "type": "union", + "members": { + "sessionSpans": { + "target": "com.amazonaws.bedrockagentcore#Spans", + "traits": { + "smithy.api#documentation": "The collection of spans representing agent execution traces within a session. Each span contains detailed information about tool calls, model interactions, and other agent activities that can be evaluated for quality and performance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input data structure containing agent session spans in OpenTelemetry format. Supports traces from frameworks like Strands (AgentCore Runtime) and LangGraph with OpenInference instrumentation for comprehensive evaluation.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluationJobResults": { + "type": "structure", + "members": { + "numberOfSessionsCompleted": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of sessions that have been successfully evaluated.
" + } + }, + "numberOfSessionsInProgress": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of sessions currently being evaluated.
" + } + }, + "numberOfSessionsFailed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of sessions that failed evaluation.
" + } + }, + "totalNumberOfSessions": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of sessions included in the batch evaluation.
" + } + }, + "numberOfSessionsIgnored": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of sessions that were ignored during evaluation.
" + } + }, + "evaluatorSummaries": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorSummaryList", + "traits": { + "smithy.api#documentation": "A list of per-evaluator summary statistics.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Aggregated results from a batch evaluation, including session completion counts and evaluator score summaries.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluationMetadata": { + "type": "union", + "members": { + "sessionMetadata": { + "target": "com.amazonaws.bedrockagentcore#SessionMetadataList", + "traits": { + "smithy.api#documentation": "A list of session metadata entries containing ground truth data and test scenario identifiers for specific sessions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for the evaluation, including session-specific ground truth data.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluationReferenceInput": { + "type": "structure", + "members": { + "context": { + "target": "com.amazonaws.bedrockagentcore#Context", + "traits": { + "smithy.api#documentation": "The span context that identifies which session or trace this reference input applies to, used for correlating ground truth with agent output.
", + "smithy.api#required": {} + } + }, + "expectedResponse": { + "target": "com.amazonaws.bedrockagentcore#EvaluationContent", + "traits": { + "smithy.api#documentation": " The expected response for trace-level evaluation. Built-in evaluators that support this field compare the agent's actual response against this value for assessment. Custom evaluators can access it through the {expected_response} placeholder in their instructions.
A list of assertion statements for session-level evaluation. Each assertion describes an expected behavior or outcome the agent should demonstrate during the session.
" + } + }, + "expectedTrajectory": { + "target": "com.amazonaws.bedrockagentcore#EvaluationExpectedTrajectory", + "traits": { + "smithy.api#documentation": "The expected tool call sequence for session-level trajectory evaluation. Contains a list of tool names representing the tools the agent is expected to invoke.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A reference input containing ground truth data for evaluation, scoped to a specific context level (session or trace) through its span context.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluationReferenceInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#EvaluationReferenceInput" + }, + "traits": { + "smithy.api#documentation": "A list of reference inputs containing ground truth data for evaluation.
", + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#EvaluationResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentcore#CreateABTest" + }, + { + "target": "com.amazonaws.bedrockagentcore#DeleteABTest" + }, + { + "target": "com.amazonaws.bedrockagentcore#DeleteBatchEvaluation" + }, + { + "target": "com.amazonaws.bedrockagentcore#DeleteRecommendation" + }, + { + "target": "com.amazonaws.bedrockagentcore#Evaluate" + }, + { + "target": "com.amazonaws.bedrockagentcore#GetABTest" + }, + { + "target": "com.amazonaws.bedrockagentcore#GetBatchEvaluation" + }, + { + "target": "com.amazonaws.bedrockagentcore#GetRecommendation" + }, + { + "target": "com.amazonaws.bedrockagentcore#ListABTests" + }, + { + "target": "com.amazonaws.bedrockagentcore#ListBatchEvaluations" + }, + { + "target": "com.amazonaws.bedrockagentcore#ListRecommendations" + }, + { + "target": "com.amazonaws.bedrockagentcore#StartBatchEvaluation" + }, + { + "target": "com.amazonaws.bedrockagentcore#StartRecommendation" + }, + { + "target": "com.amazonaws.bedrockagentcore#StopBatchEvaluation" + }, + { + "target": "com.amazonaws.bedrockagentcore#UpdateABTest" + } + ] + }, + "com.amazonaws.bedrockagentcore#EvaluationResultContent": { + "type": "structure", + "members": { + "evaluatorArn": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorArn", + "traits": { + "smithy.api#documentation": " The Amazon Resource Name (ARN) of the evaluator used to generate this result. For custom evaluators, this is the full ARN; for built-in evaluators, this follows the pattern Builtin.{EvaluatorName}.
The unique identifier of the evaluator that produced this result. This matches the evaluatorId provided in the evaluation request and can be used to identify which evaluator generated specific results.
The human-readable name of the evaluator used for this evaluation. For built-in evaluators, this is the descriptive name (e.g., \"Helpfulness\", \"Correctness\"); for custom evaluators, this is the user-defined name.
", + "smithy.api#required": {} + } + }, + "explanation": { + "target": "com.amazonaws.bedrockagentcore#EvaluationExplanation", + "traits": { + "smithy.api#documentation": "The detailed explanation provided by the evaluator describing the reasoning behind the assigned score. This qualitative feedback helps understand why specific ratings were given and provides actionable insights for improvement.
" + } + }, + "context": { + "target": "com.amazonaws.bedrockagentcore#Context", + "traits": { + "smithy.api#documentation": "The contextual information associated with this evaluation result, including span context details that identify the specific traces and sessions that were evaluated.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The numerical score assigned by the evaluator according to its configured rating scale. For numerical scales, this is a decimal value within the defined range. This field is not allowed for categorical scales.
" + } + }, + "label": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The categorical label assigned by the evaluator when using a categorical rating scale. This provides a human-readable description of the evaluation result (e.g., \"Excellent\", \"Good\", \"Poor\") corresponding to the numerical value. For numerical scales, this field is optional and provides a natural language explanation of what the value means (e.g., value 0.5 = \"Somewhat Helpful\").
" + } + }, + "tokenUsage": { + "target": "com.amazonaws.bedrockagentcore#TokenUsage", + "traits": { + "smithy.api#documentation": "The token consumption statistics for this evaluation, including input tokens, output tokens, and total tokens used by the underlying language model during the evaluation process.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.bedrockagentcore#EvaluationErrorMessage", + "traits": { + "smithy.api#documentation": "The error message describing what went wrong if the evaluation failed. Provides detailed information about evaluation failures to help diagnose and resolve issues with evaluator configuration or input data.
" + } + }, + "errorCode": { + "target": "com.amazonaws.bedrockagentcore#EvaluationErrorCode", + "traits": { + "smithy.api#documentation": "The error code indicating the type of failure that occurred during evaluation. Used to programmatically identify and handle different categories of evaluation errors.
" + } + }, + "ignoredReferenceInputFields": { + "target": "com.amazonaws.bedrockagentcore#IgnoredReferenceInputFields", + "traits": { + "smithy.api#documentation": "The list of reference input field names that were provided but not used by the evaluator. Helps identify which ground truth data was not consumed during evaluation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The comprehensive result of an evaluation containing the score, explanation, evaluator metadata, and execution details. Provides both quantitative ratings and qualitative insights about agent performance.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluationResults": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#EvaluationResultContent" + }, + "traits": { + "smithy.api#documentation": "A list of evaluation results from the evaluators applied to the session.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluationStringList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrockagentcore#EvaluationTarget": { + "type": "union", + "members": { + "spanIds": { + "target": "com.amazonaws.bedrockagentcore#SpanIds", + "traits": { + "smithy.api#documentation": "The list of specific span IDs to evaluate within the provided traces. Used to target evaluation at individual tool calls or specific operations within the agent's execution flow.
" + } + }, + "traceIds": { + "target": "com.amazonaws.bedrockagentcore#TraceIds", + "traits": { + "smithy.api#documentation": "The list of trace IDs to evaluate, representing complete request-response interactions. Used to evaluate entire conversation turns or specific agent interactions within a session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specification of which trace or span IDs to evaluate within the provided input data. Allows precise targeting of evaluation at different levels: tool calls, traces, or sessions.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluationToolName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagentcore#EvaluationToolNames": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#EvaluationToolName" + }, + "traits": { + "smithy.api#length": { + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagentcore#Evaluator": { + "type": "structure", + "members": { + "evaluatorId": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the evaluator. Can reference built-in evaluators (e.g., Builtin.Helpfulness) or custom evaluators.
An evaluator to run against sessions during batch evaluation.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluatorArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::Evaluator" + }, + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$|^arn:aws[a-zA-Z-]*:bedrock-agentcore:::evaluator/Builtin.[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.bedrockagentcore#EvaluatorId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})$" + } + }, + "com.amazonaws.bedrockagentcore#EvaluatorList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#Evaluator" + } + }, + "com.amazonaws.bedrockagentcore#EvaluatorMetric": { + "type": "structure", + "members": { + "evaluatorArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the evaluator.
", + "smithy.api#required": {} + } + }, + "controlStats": { + "target": "com.amazonaws.bedrockagentcore#ControlStats", + "traits": { + "smithy.api#documentation": "The statistics for the control variant.
", + "smithy.api#required": {} + } + }, + "variantResults": { + "target": "com.amazonaws.bedrockagentcore#VariantResultList", + "traits": { + "smithy.api#documentation": "The results for each treatment variant compared against the control.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Statistical metrics for a single evaluator comparing control and treatment variants.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluatorMetricList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorMetric" + } + }, + "com.amazonaws.bedrockagentcore#EvaluatorName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9_]{0,47})$" + } + }, + "com.amazonaws.bedrockagentcore#EvaluatorStatistics": { + "type": "structure", + "members": { + "averageScore": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The average score across all evaluated sessions for this evaluator.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Aggregated statistics for an evaluator.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluatorSummary": { + "type": "structure", + "members": { + "evaluatorId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the evaluator.
" + } + }, + "statistics": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorStatistics", + "traits": { + "smithy.api#documentation": "The aggregated statistics for this evaluator.
" + } + }, + "totalEvaluated": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of sessions evaluated by this evaluator.
" + } + }, + "totalFailed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of sessions that failed evaluation by this evaluator.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary statistics for a single evaluator within a batch evaluation.
" + } + }, + "com.amazonaws.bedrockagentcore#EvaluatorSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorSummary" + } + }, + "com.amazonaws.bedrockagentcore#Event": { + "type": "structure", + "members": { + "memoryId": { + "target": "com.amazonaws.bedrockagentcore#MemoryId", + "traits": { + "smithy.api#documentation": "The identifier of the AgentCore Memory resource containing the event.
", + "smithy.api#required": {} + } + }, + "actorId": { + "target": "com.amazonaws.bedrockagentcore#ActorId", + "traits": { + "smithy.api#documentation": "The identifier of the actor associated with the event.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionId", + "traits": { + "smithy.api#documentation": "The identifier of the session containing the event.
", + "smithy.api#required": {} + } + }, + "eventId": { + "target": "com.amazonaws.bedrockagentcore#EventId", + "traits": { + "smithy.api#documentation": "The unique identifier of the event.
", + "smithy.api#required": {} + } + }, + "eventTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the event occurred.
", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.bedrockagentcore#PayloadTypeList", + "traits": { + "smithy.api#documentation": "The content payload of the event.
", + "smithy.api#required": {} + } + }, + "branch": { + "target": "com.amazonaws.bedrockagentcore#Branch", + "traits": { + "smithy.api#documentation": "The branch information for the event.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentcore#MetadataMap", + "traits": { + "smithy.api#documentation": "Metadata associated with an event.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an event in an AgentCore Memory resource.
" + } + }, + "com.amazonaws.bedrockagentcore#EventFilterCondition": { + "type": "enum", + "members": { + "HAS_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HAS_EVENTS" + } + } + }, + "traits": { + "smithy.api#documentation": "The condition to use for filtering sessions by events.
" + } + }, + "com.amazonaws.bedrockagentcore#EventId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]+#[a-fA-F0-9]+$" + } + }, + "com.amazonaws.bedrockagentcore#EventList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#Event" + } + }, + "com.amazonaws.bedrockagentcore#EventMetadataFilterExpression": { + "type": "structure", + "members": { + "left": { + "target": "com.amazonaws.bedrockagentcore#LeftExpression", + "traits": { + "smithy.api#documentation": "Left operand of the event metadata filter expression.
", + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.bedrockagentcore#OperatorType", + "traits": { + "smithy.api#documentation": "Operator applied to the event metadata filter expression.
", + "smithy.api#required": {} + } + }, + "right": { + "target": "com.amazonaws.bedrockagentcore#RightExpression", + "traits": { + "smithy.api#documentation": "Right operand of the event metadata filter expression.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Filter expression for retrieving events based on metadata associated with an event.
" + } + }, + "com.amazonaws.bedrockagentcore#EventMetadataFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#EventMetadataFilterExpression" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentcore#ExecutionSummaryAffectedSession": { + "type": "structure", + "members": { + "sessionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the session.
", + "smithy.api#required": {} + } + }, + "approachTaken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The approach taken by the agent during this session.
", + "smithy.api#required": {} + } + }, + "finalOutcome": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The final outcome of the session.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A session associated with an execution summary cluster.
" + } + }, + "com.amazonaws.bedrockagentcore#ExecutionSummaryAffectedSessionList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ExecutionSummaryAffectedSession" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.bedrockagentcore#ExecutionSummaryCluster": { + "type": "structure", + "members": { + "clusterId": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The unique identifier of the execution summary cluster.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the execution pattern cluster.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the execution pattern.
", + "smithy.api#required": {} + } + }, + "affectedSessionCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of sessions with this execution pattern.
", + "smithy.api#required": {} + } + }, + "affectedSessions": { + "target": "com.amazonaws.bedrockagentcore#ExecutionSummaryAffectedSessionList", + "traits": { + "smithy.api#documentation": "The list of sessions with this execution pattern.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A cluster of similar execution patterns identified across sessions.
" + } + }, + "com.amazonaws.bedrockagentcore#ExecutionSummaryClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ExecutionSummaryCluster" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.bedrockagentcore#ExecutionSummaryClusteringResultContent": { + "type": "structure", + "members": { + "executionSummaries": { + "target": "com.amazonaws.bedrockagentcore#ExecutionSummaryClusterList", + "traits": { + "smithy.api#documentation": "The list of execution summary clusters identified across analyzed sessions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The execution summary clustering result containing grouped execution patterns identified across evaluated sessions.
" + } + }, + "com.amazonaws.bedrockagentcore#ExternalProxy": { + "type": "structure", + "members": { + "server": { + "target": "com.amazonaws.bedrockagentcore#HostName", + "traits": { + "smithy.api#documentation": "The hostname of the proxy server. Must be a valid DNS hostname (maximum 253 characters).
", + "smithy.api#required": {} + } + }, + "port": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The port number of the proxy server. Valid range: 1-65535.
", + "smithy.api#range": { + "min": 1, + "max": 65535 + }, + "smithy.api#required": {} + } + }, + "domainPatterns": { + "target": "com.amazonaws.bedrockagentcore#DomainPatterns", + "traits": { + "smithy.api#documentation": "Optional array of domain patterns that should route through this specific proxy. Supports .example.com for subdomain matching (matches any subdomain of example.com) or example.com for exact domain matching. If omitted, this proxy acts as a catch-all for domains not matched by other proxies. Maximum 100 patterns per proxy, each up to 253 characters.
Optional authentication credentials for the proxy server. If omitted, the proxy is accessed without authentication (useful for IP-allowlisted proxies).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a customer-managed external proxy server. Includes server location, optional domain-based routing patterns, and authentication credentials.
" + } + }, + "com.amazonaws.bedrockagentcore#ExtractionJob": { + "type": "structure", + "members": { + "jobId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the extraction job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the metadata of a memory extraction job such as the message identifiers that compose this job.
" + } + }, + "com.amazonaws.bedrockagentcore#ExtractionJobFilterInput": { + "type": "structure", + "members": { + "strategyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The memory strategy identifier to filter extraction jobs by. If specified, only extraction jobs with this strategy ID are returned.
" + } + }, + "sessionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the session. If specified, only extraction jobs with this session ID are returned.
" + } + }, + "actorId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the actor. If specified, only extraction jobs with this actor ID are returned.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#ExtractionJobStatus", + "traits": { + "smithy.api#documentation": "The status of the extraction job. If specified, only extraction jobs with this status are returned.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Filters for querying memory extraction jobs based on various criteria.
" + } + }, + "com.amazonaws.bedrockagentcore#ExtractionJobMessages": { + "type": "union", + "members": { + "messagesList": { + "target": "com.amazonaws.bedrockagentcore#MessagesList", + "traits": { + "smithy.api#documentation": "The list of messages that compose this extraction job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The list of messages that compose this extraction job.
" + } + }, + "com.amazonaws.bedrockagentcore#ExtractionJobMetadata": { + "type": "structure", + "members": { + "jobID": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the extraction job.
", + "smithy.api#required": {} + } + }, + "messages": { + "target": "com.amazonaws.bedrockagentcore#ExtractionJobMessages", + "traits": { + "smithy.api#documentation": "The messages associated with the extraction job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#ExtractionJobStatus", + "traits": { + "smithy.api#documentation": "The current status of the extraction job.
" + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The cause of failure, if the job did not complete successfully.
" + } + }, + "strategyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the memory strategy for this extraction job.
" + } + }, + "sessionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the session for this extraction job.
" + } + }, + "actorId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the actor for this extraction job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata information associated with this extraction job.
" + } + }, + "com.amazonaws.bedrockagentcore#ExtractionJobMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ExtractionJobMetadata" + } + }, + "com.amazonaws.bedrockagentcore#ExtractionJobStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcore#ExtractionMode": { + "type": "enum", + "members": { + "SKIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIP" + } + } + } + }, + "com.amazonaws.bedrockagentcore#FailureAnalysisResultContent": { + "type": "structure", + "members": { + "failures": { + "target": "com.amazonaws.bedrockagentcore#FailureCategoryClusterList", + "traits": { + "smithy.api#documentation": "The list of failure category clusters identified across analyzed sessions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The failure analysis clustering result containing categorized failure clusters with root causes and remediation recommendations.
" + } + }, + "com.amazonaws.bedrockagentcore#FailureCategoryCluster": { + "type": "structure", + "members": { + "clusterId": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The unique identifier of the failure category cluster.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the failure category.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the failure category pattern.
", + "smithy.api#required": {} + } + }, + "affectedSessionCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of sessions affected by this failure category.
", + "smithy.api#required": {} + } + }, + "subCategories": { + "target": "com.amazonaws.bedrockagentcore#FailureSubCategoryClusterList", + "traits": { + "smithy.api#documentation": "The list of failure subcategories within this category.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A top-level failure category identified by clustering similar failure patterns across sessions.
" + } + }, + "com.amazonaws.bedrockagentcore#FailureCategoryClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#FailureCategoryCluster" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.bedrockagentcore#FailureSpanDetail": { + "type": "structure", + "members": { + "spanId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the span where the failure occurred.
", + "smithy.api#required": {} + } + }, + "traceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The trace identifier associated with the failure span.
", + "smithy.api#required": {} + } + }, + "signals": { + "target": "com.amazonaws.bedrockagentcore#InsightsFailureSignalList", + "traits": { + "smithy.api#documentation": "The failure signals detected in this span.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a specific span where a failure was detected.
" + } + }, + "com.amazonaws.bedrockagentcore#FailureSpanDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#FailureSpanDetail" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.bedrockagentcore#FailureSubCategoryCluster": { + "type": "structure", + "members": { + "clusterId": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The unique identifier of the failure subcategory cluster.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the failure subcategory.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the failure subcategory pattern.
", + "smithy.api#required": {} + } + }, + "affectedSessionCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of sessions affected by this failure subcategory.
", + "smithy.api#required": {} + } + }, + "rootCauses": { + "target": "com.amazonaws.bedrockagentcore#RootCauseClusterList", + "traits": { + "smithy.api#documentation": "The list of root cause clusters identified within this subcategory.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A subcategory of failures within a top-level failure category.
" + } + }, + "com.amazonaws.bedrockagentcore#FailureSubCategoryClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#FailureSubCategoryCluster" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.bedrockagentcore#FilterInput": { + "type": "structure", + "members": { + "branch": { + "target": "com.amazonaws.bedrockagentcore#BranchFilter", + "traits": { + "smithy.api#documentation": "The branch filter criteria to apply when listing events.
" + } + }, + "eventMetadata": { + "target": "com.amazonaws.bedrockagentcore#EventMetadataFilterList", + "traits": { + "smithy.api#documentation": "Event metadata filter criteria to apply when retrieving events.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains filter criteria for listing events.
" + } + }, + "com.amazonaws.bedrockagentcore#FilterStringValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + } + } + }, + "com.amazonaws.bedrockagentcore#FilterValue": { + "type": "union", + "members": { + "stringValue": { + "target": "com.amazonaws.bedrockagentcore#FilterStringValue", + "traits": { + "smithy.api#documentation": "A string value for text-based filtering.
" + } + }, + "doubleValue": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "A numeric value for numerical filtering and comparisons.
" + } + }, + "booleanValue": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "A boolean value for true/false filtering conditions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A value used in filter comparisons, supporting different data types.
" + } + }, + "com.amazonaws.bedrockagentcore#GatewayArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::Gateway" + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock-agentcore:[a-z0-9-]{1,20}:[0-9]{12}:gateway/([0-9a-z][-]?){1,48}-[a-z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#GatewayFilter": { + "type": "structure", + "members": { + "targetPaths": { + "target": "com.amazonaws.bedrockagentcore#TargetPathList", + "traits": { + "smithy.api#documentation": "A list of target path patterns to include in the A/B test.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A filter to restrict which gateway target paths are included in the A/B test.
" + } + }, + "com.amazonaws.bedrockagentcore#GetABTest": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetABTestRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetABTestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.
", + "smithy.api#http": { + "method": "GET", + "uri": "/ab-tests/{abTestId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#GetABTestRequest": { + "type": "structure", + "members": { + "abTestId": { + "target": "com.amazonaws.bedrockagentcore#ABTestId", + "traits": { + "smithy.api#documentation": "The unique identifier of the A/B test to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetABTestResponse": { + "type": "structure", + "members": { + "abTestId": { + "target": "com.amazonaws.bedrockagentcore#ABTestId", + "traits": { + "smithy.api#documentation": "The unique identifier of the A/B test.
", + "smithy.api#required": {} + } + }, + "abTestArn": { + "target": "com.amazonaws.bedrockagentcore#ABTestArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the A/B test.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#ABTestName", + "traits": { + "smithy.api#documentation": "The name of the A/B test.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#ABTestDescription", + "traits": { + "smithy.api#documentation": "The description of the A/B test.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#ABTestStatus", + "traits": { + "smithy.api#documentation": "The current status of the A/B test.
", + "smithy.api#required": {} + } + }, + "executionStatus": { + "target": "com.amazonaws.bedrockagentcore#ABTestExecutionStatus", + "traits": { + "smithy.api#documentation": "The execution status indicating whether the A/B test is currently running.
", + "smithy.api#required": {} + } + }, + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcore#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway used for traffic splitting.
", + "smithy.api#required": {} + } + }, + "variants": { + "target": "com.amazonaws.bedrockagentcore#VariantList", + "traits": { + "smithy.api#documentation": "The list of variants in the A/B test.
", + "smithy.api#required": {} + } + }, + "gatewayFilter": { + "target": "com.amazonaws.bedrockagentcore#GatewayFilter", + "traits": { + "smithy.api#documentation": "The gateway filter restricting which target paths are included.
" + } + }, + "evaluationConfig": { + "target": "com.amazonaws.bedrockagentcore#ABTestEvaluationConfig", + "traits": { + "smithy.api#documentation": "The evaluation configuration for measuring variant performance.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcore#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN used by the A/B test.
" + } + }, + "currentRunId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the current run of the A/B test.
" + } + }, + "errorDetails": { + "target": "com.amazonaws.bedrockagentcore#ErrorDetailsList", + "traits": { + "smithy.api#documentation": "The error details if the A/B test encountered failures.
" + } + }, + "startedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the A/B test was started.
" + } + }, + "stoppedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the A/B test was stopped.
" + } + }, + "maxDurationExpiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the A/B test will automatically expire.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the A/B test was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the A/B test was last updated.
", + "smithy.api#required": {} + } + }, + "results": { + "target": "com.amazonaws.bedrockagentcore#ABTestResults", + "traits": { + "smithy.api#documentation": "The statistical results of the A/B test, including per-evaluator metrics and significance analysis.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetAgentCard": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetAgentCardRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetAgentCardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#RetryableConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#RuntimeClientError" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the A2A agent card associated with an AgentCore Runtime agent.
", + "smithy.api#http": { + "method": "GET", + "uri": "/runtimes/{agentRuntimeArn}/invocations/.well-known/agent-card.json", + "code": 200 + } + } + }, + "com.amazonaws.bedrockagentcore#GetAgentCardRequest": { + "type": "structure", + "members": { + "runtimeSessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionType", + "traits": { + "smithy.api#documentation": "The session ID that the AgentCore Runtime agent is using.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Runtime-Session-Id", + "smithy.api#idempotencyToken": {} + } + }, + "agentRuntimeArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the AgentCore Runtime agent for which you want to get the A2A agent card.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "qualifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Optional qualifier to specify an agent alias, such as prodcode> or dev. If you don't provide a value, the DEFAULT alias is used.
The ID of the session associated with the AgentCore Runtime agent.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" + } + }, + "agentCard": { + "target": "com.amazonaws.bedrockagentcore#AgentCard", + "traits": { + "smithy.api#documentation": "An agent card document that contains metadata and capabilities for an AgentCore Runtime agent.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "statusCode": { + "target": "com.amazonaws.bedrockagentcore#HttpResponseCode", + "traits": { + "smithy.api#documentation": "The status code of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetBatchEvaluation": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetBatchEvaluationRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetBatchEvaluationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.
", + "smithy.api#http": { + "method": "GET", + "uri": "/evaluations/batch-evaluate/{batchEvaluationId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#GetBatchEvaluationRequest": { + "type": "structure", + "members": { + "batchEvaluationId": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the batch evaluation to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetBatchEvaluationResponse": { + "type": "structure", + "members": { + "batchEvaluationId": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the batch evaluation.
", + "smithy.api#required": {} + } + }, + "batchEvaluationArn": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the batch evaluation.
", + "smithy.api#required": {} + } + }, + "batchEvaluationName": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationName", + "traits": { + "smithy.api#documentation": "The name of the batch evaluation.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationStatus", + "traits": { + "smithy.api#documentation": "The current status of the batch evaluation.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the batch evaluation was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "evaluators": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorList", + "traits": { + "smithy.api#documentation": "The list of evaluators applied during the batch evaluation.
" + } + }, + "insights": { + "target": "com.amazonaws.bedrockagentcore#InsightList", + "traits": { + "smithy.api#documentation": "The list of insight analyses applied during the batch evaluation.
" + } + }, + "dataSourceConfig": { + "target": "com.amazonaws.bedrockagentcore#DataSourceConfig", + "traits": { + "smithy.api#documentation": "The data source configuration specifying where agent traces are pulled from.
" + } + }, + "outputConfig": { + "target": "com.amazonaws.bedrockagentcore#OutputConfig", + "traits": { + "smithy.api#documentation": "The output configuration specifying where evaluation results are written.
" + } + }, + "evaluationResults": { + "target": "com.amazonaws.bedrockagentcore#EvaluationJobResults", + "traits": { + "smithy.api#documentation": "The aggregated evaluation results, including session completion counts and evaluator score summaries.
" + } + }, + "failureAnalysisResult": { + "target": "com.amazonaws.bedrockagentcore#FailureAnalysisResultContent", + "traits": { + "smithy.api#documentation": "The failure analysis results from insights, containing categorized failure clusters with root causes and recommendations.
" + } + }, + "userIntentResult": { + "target": "com.amazonaws.bedrockagentcore#UserIntentClusteringResultContent", + "traits": { + "smithy.api#documentation": "The user intent clustering results from insights, containing grouped user intents across evaluated sessions.
" + } + }, + "executionSummaryResult": { + "target": "com.amazonaws.bedrockagentcore#ExecutionSummaryClusteringResultContent", + "traits": { + "smithy.api#documentation": "The execution summary clustering results from insights, containing grouped execution patterns across evaluated sessions.
" + } + }, + "errorDetails": { + "target": "com.amazonaws.bedrockagentcore#ErrorDetailsList", + "traits": { + "smithy.api#documentation": "The error details if the batch evaluation encountered failures.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationDescription", + "traits": { + "smithy.api#documentation": "The description of the batch evaluation.
" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the batch evaluation was last updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcore#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key used to encrypt evaluation data.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetBrowserSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetBrowserSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetBrowserSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about a specific browser session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, associated streams, and metadata.
To get a browser session, you must specify both the browser identifier and the session ID. The response includes information about the session's viewport configuration, timeout settings, and stream endpoints.
The following operations are related to GetBrowserSession:
The unique identifier of the browser associated with the session.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser session to retrieve.
", + "smithy.api#httpQuery": "sessionId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetBrowserSessionResponse": { + "type": "structure", + "members": { + "browserIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the browser.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The identifier of the browser session.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#Name", + "traits": { + "smithy.api#documentation": "The name of the browser session.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the browser session was created.
", + "smithy.api#required": {} + } + }, + "viewPort": { + "target": "com.amazonaws.bedrockagentcore#ViewPort" + }, + "extensions": { + "target": "com.amazonaws.bedrockagentcore#BrowserExtensions", + "traits": { + "smithy.api#documentation": "The list of browser extensions that are configured in the browser session.
" + } + }, + "enterprisePolicies": { + "target": "com.amazonaws.bedrockagentcore#BrowserEnterprisePolicies", + "traits": { + "smithy.api#documentation": "A list of files containing enterprise policies for the browser session.
" + } + }, + "profileConfiguration": { + "target": "com.amazonaws.bedrockagentcore#BrowserProfileConfiguration", + "traits": { + "smithy.api#documentation": "The browser profile configuration associated with this session. Contains the profile identifier that links to persistent browser data such as cookies and local storage.
" + } + }, + "sessionTimeoutSeconds": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionTimeout", + "traits": { + "smithy.api#documentation": "The timeout period for the browser session in seconds.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionStatus", + "traits": { + "smithy.api#documentation": "The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
" + } + }, + "streams": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionStream", + "traits": { + "smithy.api#documentation": "The streams associated with this browser session. These include the automation stream and live view stream.
" + } + }, + "proxyConfiguration": { + "target": "com.amazonaws.bedrockagentcore#ProxyConfiguration", + "traits": { + "smithy.api#documentation": "The active proxy configuration for this browser session. This field is only present if proxy configuration was provided when the session was started using StartBrowserSession. The configuration includes proxy servers, domain bypass rules and the proxy authentication credentials.
The list of certificates installed in the browser session.
" + } + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcore#ToolsFileSystemConfigurations", + "traits": { + "smithy.api#documentation": "The file system configurations for the browser session. Each entry describes an access point and its mount path.
" + } + }, + "sessionReplayArtifact": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The artifact containing the session replay information.
" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the browser session was last updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetCodeInterpreterSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetCodeInterpreterSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetCodeInterpreterSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about a specific code interpreter session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, and metadata.
To get a code interpreter session, you must specify both the code interpreter identifier and the session ID. The response includes information about the session's timeout settings and current status.
The following operations are related to GetCodeInterpreterSession:
The unique identifier of the code interpreter associated with the session.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the code interpreter session to retrieve.
", + "smithy.api#httpQuery": "sessionId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetCodeInterpreterSessionResponse": { + "type": "structure", + "members": { + "codeInterpreterIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the code interpreter.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionId", + "traits": { + "smithy.api#documentation": "The identifier of the code interpreter session.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#Name", + "traits": { + "smithy.api#documentation": "The name of the code interpreter session.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the code interpreter session was created.
", + "smithy.api#required": {} + } + }, + "sessionTimeoutSeconds": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionTimeout", + "traits": { + "smithy.api#documentation": "The timeout period for the code interpreter session in seconds.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionStatus", + "traits": { + "smithy.api#documentation": "The current status of the code interpreter session. Possible values include ACTIVE, STOPPING, and STOPPED.
" + } + }, + "certificates": { + "target": "com.amazonaws.bedrockagentcore#Certificates", + "traits": { + "smithy.api#documentation": "The list of certificates installed in the code interpreter session.
" + } + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcore#ToolsFileSystemConfigurations", + "traits": { + "smithy.api#documentation": "The file system configurations for the code interpreter session. Each entry describes an access point and its mount path.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetEventInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetEventOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InvalidInputException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a specific event in an AgentCore Memory resource.
To use this operation, you must have the bedrock-agentcore:GetEvent permission.
The identifier of the AgentCore Memory resource containing the event.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionId", + "traits": { + "smithy.api#documentation": "The identifier of the session containing the event.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actorId": { + "target": "com.amazonaws.bedrockagentcore#ActorId", + "traits": { + "smithy.api#documentation": "The identifier of the actor associated with the event.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "eventId": { + "target": "com.amazonaws.bedrockagentcore#EventId", + "traits": { + "smithy.api#documentation": "The identifier of the event to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetEventOutput": { + "type": "structure", + "members": { + "event": { + "target": "com.amazonaws.bedrockagentcore#Event", + "traits": { + "smithy.api#documentation": "The requested event information.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetMemoryRecord": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetMemoryRecordInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetMemoryRecordOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InvalidInputException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a specific memory record from an AgentCore Memory resource.
To use this operation, you must have the bedrock-agentcore:GetMemoryRecord permission.
The identifier of the AgentCore Memory resource containing the memory record.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "memoryRecordId": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordId", + "traits": { + "smithy.api#documentation": "The identifier of the memory record to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetMemoryRecordOutput": { + "type": "structure", + "members": { + "memoryRecord": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecord", + "traits": { + "smithy.api#documentation": "The requested memory record.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetPaymentInstrument": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetPaymentInstrumentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetPaymentInstrumentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get a payment instrument by ID.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/payments/getPaymentInstrument" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#GetPaymentInstrumentBalance": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetPaymentInstrumentBalanceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetPaymentInstrumentBalanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get the balance of a payment instrument.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/payments/getPaymentInstrumentBalance" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#GetPaymentInstrumentBalanceRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID associated with this payment instrument.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-User-Id" + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagentcore#PaymentAgentName", + "traits": { + "smithy.api#documentation": "The agent name associated with this request, used for observability.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-Agent-Name" + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager that owns this payment instrument.
", + "smithy.api#required": {} + } + }, + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcore#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The ID of the payment connector associated with this instrument.
", + "smithy.api#required": {} + } + }, + "paymentInstrumentId": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentId", + "traits": { + "smithy.api#documentation": "The ID of the payment instrument to query balance for.
", + "smithy.api#required": {} + } + }, + "chain": { + "target": "com.amazonaws.bedrockagentcore#BlockchainChainId", + "traits": { + "smithy.api#documentation": "The specific blockchain chain to query balance on. Required because balances are chain-specific.
", + "smithy.api#required": {} + } + }, + "token": { + "target": "com.amazonaws.bedrockagentcore#InstrumentBalanceToken", + "traits": { + "smithy.api#documentation": "The token to query balance for. Only tokens supported for X402 payments are returned.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request structure for getting payment instrument balance.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetPaymentInstrumentBalanceResponse": { + "type": "structure", + "members": { + "paymentInstrumentId": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentId", + "traits": { + "smithy.api#documentation": "The ID of the payment instrument.
", + "smithy.api#required": {} + } + }, + "tokenBalance": { + "target": "com.amazonaws.bedrockagentcore#TokenBalance", + "traits": { + "smithy.api#documentation": "The balance of the supported token on the requested chain.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response structure for getting payment instrument balance.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetPaymentInstrumentRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID associated with this payment instrument.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-User-Id" + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagentcore#PaymentAgentName", + "traits": { + "smithy.api#documentation": "The agent name associated with this request, used for observability.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-Agent-Name" + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager that owns this payment instrument.
", + "smithy.api#required": {} + } + }, + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcore#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The ID of the payment connector.
" + } + }, + "paymentInstrumentId": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentId", + "traits": { + "smithy.api#documentation": "The ID of the payment instrument to retrieve.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request structure for getting a payment instrument.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetPaymentInstrumentResponse": { + "type": "structure", + "members": { + "paymentInstrument": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrument", + "traits": { + "smithy.api#documentation": "The payment instrument details.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response structure for getting a payment instrument.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetPaymentSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetPaymentSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetPaymentSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get a payment session.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/payments/getPaymentSession" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#GetPaymentSessionRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID associated with this payment session.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-User-Id" + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagentcore#PaymentAgentName", + "traits": { + "smithy.api#documentation": "The agent name associated with this request, used for observability.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-Agent-Name" + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager that owns this session.
", + "smithy.api#required": {} + } + }, + "paymentSessionId": { + "target": "com.amazonaws.bedrockagentcore#PaymentSessionId", + "traits": { + "smithy.api#documentation": "The ID of the payment session to retrieve.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request structure for getting a payment session.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetPaymentSessionResponse": { + "type": "structure", + "members": { + "paymentSession": { + "target": "com.amazonaws.bedrockagentcore#PaymentSession", + "traits": { + "smithy.api#documentation": "The payment session details.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response structure for getting a payment session.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about a recommendation, including its configuration, status, and results.
", + "smithy.api#http": { + "method": "GET", + "uri": "/recommendations/{recommendationId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#GetRecommendationRequest": { + "type": "structure", + "members": { + "recommendationId": { + "target": "com.amazonaws.bedrockagentcore#RecommendationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the recommendation to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetRecommendationResponse": { + "type": "structure", + "members": { + "recommendationId": { + "target": "com.amazonaws.bedrockagentcore#RecommendationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the recommendation.
", + "smithy.api#required": {} + } + }, + "recommendationArn": { + "target": "com.amazonaws.bedrockagentcore#RecommendationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommendation.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#RecommendationName", + "traits": { + "smithy.api#documentation": "The name of the recommendation.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#RecommendationDescription", + "traits": { + "smithy.api#documentation": "The description of the recommendation.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcore#RecommendationType", + "traits": { + "smithy.api#documentation": "The type of recommendation.
", + "smithy.api#required": {} + } + }, + "recommendationConfig": { + "target": "com.amazonaws.bedrockagentcore#RecommendationConfig", + "traits": { + "smithy.api#documentation": "The configuration for the recommendation.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#RecommendationStatus", + "traits": { + "smithy.api#documentation": "The current status of the recommendation.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the recommendation was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the recommendation was last updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "recommendationResult": { + "target": "com.amazonaws.bedrockagentcore#RecommendationResult", + "traits": { + "smithy.api#documentation": "The result of the recommendation, containing the optimized system prompt or tool descriptions. Only present when the recommendation status is COMPLETED.
The ARN of the KMS key used to encrypt recommendation data.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetResourceApiKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetResourceApiKeyRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetResourceApiKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "Retrieves the API key associated with an API key credential provider.
", + "smithy.api#http": { + "uri": "/identities/api-key", + "method": "POST" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#GetResourceApiKeyRequest": { + "type": "structure", + "members": { + "workloadIdentityToken": { + "target": "com.amazonaws.bedrockagentcore#WorkloadIdentityTokenType", + "traits": { + "smithy.api#documentation": "The identity token of the workload from which you want to retrieve the API key.
", + "smithy.api#required": {} + } + }, + "resourceCredentialProviderName": { + "target": "com.amazonaws.bedrockagentcore#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The credential provider name for the resource from which you are retrieving the API key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetResourceApiKeyResponse": { + "type": "structure", + "members": { + "apiKey": { + "target": "com.amazonaws.bedrockagentcore#ApiKeyType", + "traits": { + "smithy.api#documentation": "The API key associated with the resource requested.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetResourceOauth2Token": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetResourceOauth2TokenRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetResourceOauth2TokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "Returns the OAuth 2.0 token of the provided resource.
", + "smithy.api#http": { + "uri": "/identities/oauth2/token", + "method": "POST" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#GetResourceOauth2TokenRequest": { + "type": "structure", + "members": { + "workloadIdentityToken": { + "target": "com.amazonaws.bedrockagentcore#WorkloadIdentityTokenType", + "traits": { + "smithy.api#documentation": "The identity token of the workload from which you want to retrieve the OAuth2 token.
", + "smithy.api#required": {} + } + }, + "resourceCredentialProviderName": { + "target": "com.amazonaws.bedrockagentcore#CredentialProviderName", + "traits": { + "smithy.api#documentation": "The name of the resource's credential provider.
", + "smithy.api#required": {} + } + }, + "scopes": { + "target": "com.amazonaws.bedrockagentcore#ScopesListType", + "traits": { + "smithy.api#documentation": "The OAuth scopes being requested.
", + "smithy.api#required": {} + } + }, + "oauth2Flow": { + "target": "com.amazonaws.bedrockagentcore#Oauth2FlowType", + "traits": { + "smithy.api#documentation": "The type of flow to be performed.
", + "smithy.api#required": {} + } + }, + "sessionUri": { + "target": "com.amazonaws.bedrockagentcore#RequestUri", + "traits": { + "smithy.api#documentation": "Unique identifier for the user's authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.
" + } + }, + "resourceOauth2ReturnUrl": { + "target": "com.amazonaws.bedrockagentcore#ResourceOauth2ReturnUrlType", + "traits": { + "smithy.api#documentation": "The callback URL to redirect to after the OAuth 2.0 token retrieval is complete. This URL must be one of the provided URLs configured for the workload identity.
" + } + }, + "forceAuthentication": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.
" + } + }, + "customParameters": { + "target": "com.amazonaws.bedrockagentcore#CustomRequestParametersType", + "traits": { + "smithy.api#documentation": "A map of custom parameters to include in the authorization request to the resource credential provider. These parameters are in addition to the standard OAuth 2.0 flow parameters, and will not override them.
" + } + }, + "customState": { + "target": "com.amazonaws.bedrockagentcore#State", + "traits": { + "smithy.api#documentation": "An opaque string that will be sent back to the callback URL provided in resourceOauth2ReturnUrl. This state should be used to protect the callback URL of your application against CSRF attacks by ensuring the response corresponds to the original request.
" + } + }, + "resources": { + "target": "com.amazonaws.bedrockagentcore#ResourcesListType", + "traits": { + "smithy.api#documentation": "The resources to include in the token request. These are used to specify the target resources for which the OAuth2 token is being requested.
" + } + }, + "audiences": { + "target": "com.amazonaws.bedrockagentcore#AudiencesListType", + "traits": { + "smithy.api#documentation": "The audiences to include in the token request. These are used to specify the intended recipients of the OAuth2 token.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetResourceOauth2TokenResponse": { + "type": "structure", + "members": { + "authorizationUrl": { + "target": "com.amazonaws.bedrockagentcore#AuthorizationUrlType", + "traits": { + "smithy.api#documentation": "The URL to initiate the authorization process, provided when the access token requires user authorization.
" + } + }, + "accessToken": { + "target": "com.amazonaws.bedrockagentcore#AccessTokenType", + "traits": { + "smithy.api#documentation": "The OAuth 2.0 access token to use.
" + } + }, + "sessionUri": { + "target": "com.amazonaws.bedrockagentcore#RequestUri", + "traits": { + "smithy.api#documentation": "Unique identifier for the user's authorization session for retrieving OAuth2 tokens. This matches the sessionId from the request and can be used to track the session state.
" + } + }, + "sessionStatus": { + "target": "com.amazonaws.bedrockagentcore#SessionStatus", + "traits": { + "smithy.api#documentation": "Status indicating whether the user's authorization session is in progress or has failed. This helps determine the next steps in the OAuth2 authentication flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetResourcePaymentToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetResourcePaymentTokenRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetResourcePaymentTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.
", + "smithy.api#http": { + "uri": "/identities/payment/token", + "method": "POST" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#GetResourcePaymentTokenRequest": { + "type": "structure", + "members": { + "workloadIdentityToken": { + "target": "com.amazonaws.bedrockagentcore#WorkloadIdentityTokenType", + "traits": { + "smithy.api#documentation": "Workload access token for authorization.
", + "smithy.api#required": {} + } + }, + "resourceCredentialProviderName": { + "target": "com.amazonaws.bedrockagentcore#CredentialProviderName", + "traits": { + "smithy.api#documentation": "Name of the payment credential provider to use.
", + "smithy.api#required": {} + } + }, + "paymentTokenRequest": { + "target": "com.amazonaws.bedrockagentcore#PaymentTokenRequestInput", + "traits": { + "smithy.api#documentation": "Vendor-specific token request input. Contains all request parameters in a type-safe, vendor-specific structure.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetResourcePaymentTokenResponse": { + "type": "structure", + "members": { + "paymentTokenResponse": { + "target": "com.amazonaws.bedrockagentcore#PaymentTokenResponseOutput", + "traits": { + "smithy.api#documentation": "Vendor-specific token response output. Contains all response data in a type-safe, vendor-specific structure.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetWorkloadAccessToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "Obtains a workload access token for agentic workloads not acting on behalf of a user.
", + "smithy.api#http": { + "uri": "/identities/GetWorkloadAccessToken", + "method": "POST" + } + } + }, + "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenForJWT": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenForJWTRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenForJWTResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.
", + "smithy.api#http": { + "uri": "/identities/GetWorkloadAccessTokenForJWT", + "method": "POST" + } + } + }, + "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenForJWTRequest": { + "type": "structure", + "members": { + "workloadName": { + "target": "com.amazonaws.bedrockagentcore#WorkloadIdentityNameType", + "traits": { + "smithy.api#documentation": "The unique identifier for the registered workload.
", + "smithy.api#required": {} + } + }, + "userToken": { + "target": "com.amazonaws.bedrockagentcore#UserTokenType", + "traits": { + "smithy.api#documentation": "The OAuth 2.0 token issued by the user's identity provider.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenForJWTResponse": { + "type": "structure", + "members": { + "workloadAccessToken": { + "target": "com.amazonaws.bedrockagentcore#WorkloadIdentityTokenType", + "traits": { + "smithy.api#documentation": "An opaque token representing the identity of both the workload and the user.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenForUserId": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenForUserIdRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenForUserIdResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.
", + "smithy.api#http": { + "uri": "/identities/GetWorkloadAccessTokenForUserId", + "method": "POST" + } + } + }, + "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenForUserIdRequest": { + "type": "structure", + "members": { + "workloadName": { + "target": "com.amazonaws.bedrockagentcore#WorkloadIdentityNameType", + "traits": { + "smithy.api#documentation": "The name of the workload from which you want to retrieve the access token.
", + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserIdType", + "traits": { + "smithy.api#documentation": "The ID of the user for whom you are retrieving the access token.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenForUserIdResponse": { + "type": "structure", + "members": { + "workloadAccessToken": { + "target": "com.amazonaws.bedrockagentcore#WorkloadIdentityTokenType", + "traits": { + "smithy.api#documentation": "The access token for the specified workload.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenRequest": { + "type": "structure", + "members": { + "workloadName": { + "target": "com.amazonaws.bedrockagentcore#WorkloadIdentityNameType", + "traits": { + "smithy.api#documentation": "The unique identifier for the registered workload.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#GetWorkloadAccessTokenResponse": { + "type": "structure", + "members": { + "workloadAccessToken": { + "target": "com.amazonaws.bedrockagentcore#WorkloadIdentityTokenType", + "traits": { + "smithy.api#documentation": "An opaque token representing the identity of both the workload and the user.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#GroundTruthSource": { + "type": "union", + "members": { + "inline": { + "target": "com.amazonaws.bedrockagentcore#InlineGroundTruth", + "traits": { + "smithy.api#documentation": "Inline ground truth data provided directly in the request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Where to pull ground truth from.
" + } + }, + "com.amazonaws.bedrockagentcore#GroundTruthTurn": { + "type": "structure", + "members": { + "input": { + "target": "com.amazonaws.bedrockagentcore#GroundTruthTurnInput", + "traits": { + "smithy.api#documentation": "The input for this conversation turn.
" + } + }, + "expectedResponse": { + "target": "com.amazonaws.bedrockagentcore#EvaluationContent", + "traits": { + "smithy.api#documentation": "The expected response for this conversation turn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Ground truth data for a single conversation turn.
" + } + }, + "com.amazonaws.bedrockagentcore#GroundTruthTurnInput": { + "type": "union", + "members": { + "prompt": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text prompt for this conversation turn.
", + "smithy.api#length": { + "max": 4000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The input for a ground truth conversation turn.
" + } + }, + "com.amazonaws.bedrockagentcore#GroundTruthTurnList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#GroundTruthTurn" + } + }, + "com.amazonaws.bedrockagentcore#HarnessAgentCoreBrowserConfig": { + "type": "structure", + "members": { + "browserArn": { + "target": "com.amazonaws.bedrockagentcore#HarnessBrowserArn", + "traits": { + "smithy.api#documentation": "If not populated, the built-in Browser ARN is used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Browser.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessAgentCoreCodeInterpreterConfig": { + "type": "structure", + "members": { + "codeInterpreterArn": { + "target": "com.amazonaws.bedrockagentcore#HarnessCodeInterpreterArn", + "traits": { + "smithy.api#documentation": "If not populated, the built-in Code Interpreter ARN is used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Code Interpreter.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessAgentCoreGatewayConfig": { + "type": "structure", + "members": { + "gatewayArn": { + "target": "com.amazonaws.bedrockagentcore#GatewayArn", + "traits": { + "smithy.api#documentation": "The ARN of the desired AgentCore Gateway.
", + "smithy.api#required": {} + } + }, + "outboundAuth": { + "target": "com.amazonaws.bedrockagentcore#HarnessGatewayOutboundAuth", + "traits": { + "smithy.api#documentation": "How harness authenticates to this Gateway. Defaults to AWS_IAM (SigV4) if omitted.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Gateway.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessAllowedTool": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^(\\*|@?[^/]+(/[^/]+)?)$" + } + }, + "com.amazonaws.bedrockagentcore#HarnessAllowedTools": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#HarnessAllowedTool" + } + }, + "com.amazonaws.bedrockagentcore#HarnessArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:([^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:harness/[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#HarnessAwsSkillPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^([^*?\\[\\]]|\\*)+$" + } + }, + "com.amazonaws.bedrockagentcore#HarnessAwsSkillPaths": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#HarnessAwsSkillPath" + } + }, + "com.amazonaws.bedrockagentcore#HarnessBedrockApiFormat": { + "type": "enum", + "members": { + "CONVERSE_STREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Use the Bedrock Converse Stream API format.
", + "smithy.api#enumValue": "converse_stream" + } + }, + "RESPONSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Use the Responses API format.
", + "smithy.api#enumValue": "responses" + } + }, + "CHAT_COMPLETIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Use the Chat Completions API format.
", + "smithy.api#enumValue": "chat_completions" + } + } + } + }, + "com.amazonaws.bedrockagentcore#HarnessBedrockModelConfig": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockagentcore#ModelId", + "traits": { + "smithy.api#documentation": "The Bedrock model ID.
", + "smithy.api#required": {} + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrockagentcore#MaxTokens", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to allow in the generated response per iteration.
" + } + }, + "temperature": { + "target": "com.amazonaws.bedrockagentcore#Temperature", + "traits": { + "smithy.api#documentation": "The temperature to set when calling the model.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagentcore#TopP", + "traits": { + "smithy.api#documentation": "The topP set when calling the model.
" + } + }, + "apiFormat": { + "target": "com.amazonaws.bedrockagentcore#HarnessBedrockApiFormat", + "traits": { + "smithy.api#documentation": "The API format to use when calling the Bedrock provider.
" + } + }, + "additionalParams": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Provider-specific parameters passed through to the model provider unchanged.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for an Amazon Bedrock model provider.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessBrowserArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Browser ARN for Harness tool configuration. Accepts both managed (aws.browser.v1) and custom browser ARNs.", + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws\\.browser\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})$" + } + }, + "com.amazonaws.bedrockagentcore#HarnessCodeInterpreterArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Code Interpreter ARN for Harness tool configuration. Accepts both managed (aws.codeinterpreter.v1) and custom code interpreter ARNs.", + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):code-interpreter(-custom)?/(aws\\.codeinterpreter\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})$" + } + }, + "com.amazonaws.bedrockagentcore#HarnessContentBlock": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentcore#SensitiveText", + "traits": { + "smithy.api#documentation": "Text content.
" + } + }, + "toolUse": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolUseBlock", + "traits": { + "smithy.api#documentation": "A tool use request from the model.
" + } + }, + "toolResult": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolResultBlock", + "traits": { + "smithy.api#documentation": "A tool execution result.
" + } + }, + "reasoningContent": { + "target": "com.amazonaws.bedrockagentcore#HarnessReasoningContentBlock", + "traits": { + "smithy.api#documentation": "Model reasoning content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A content block within a message.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessContentBlockDelta": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentcore#SensitiveText", + "traits": { + "smithy.api#documentation": "A text delta.
" + } + }, + "toolUse": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolUseBlockDelta", + "traits": { + "smithy.api#documentation": "A tool use input delta.
" + } + }, + "toolResult": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolResultBlocksDelta", + "traits": { + "smithy.api#documentation": "A tool result delta.
" + } + }, + "reasoningContent": { + "target": "com.amazonaws.bedrockagentcore#HarnessReasoningContentBlockDelta", + "traits": { + "smithy.api#documentation": "A reasoning content delta.
" + } + }, + "toolResultMetadata": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolResultMetadataBlockDelta", + "traits": { + "smithy.api#documentation": "A tool result metadata delta.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A delta update to a content block.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessContentBlockDeltaEvent": { + "type": "structure", + "members": { + "contentBlockIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The index of the content block being updated.
", + "smithy.api#required": {} + } + }, + "delta": { + "target": "com.amazonaws.bedrockagentcore#HarnessContentBlockDelta", + "traits": { + "smithy.api#documentation": "The delta payload.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Event containing a delta update to a content block.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessContentBlockStart": { + "type": "union", + "members": { + "toolUse": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolUseBlockStart", + "traits": { + "smithy.api#documentation": "Start of a tool use content block.
" + } + }, + "toolResult": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolResultBlockStart", + "traits": { + "smithy.api#documentation": "Start of a tool result content block.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The start payload for a content block.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessContentBlockStartEvent": { + "type": "structure", + "members": { + "contentBlockIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The index of the content block within the message.
", + "smithy.api#required": {} + } + }, + "start": { + "target": "com.amazonaws.bedrockagentcore#HarnessContentBlockStart", + "traits": { + "smithy.api#documentation": "The content block start payload.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Event indicating the start of a content block.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessContentBlockStopEvent": { + "type": "structure", + "members": { + "contentBlockIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The index of the content block that ended.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Event indicating the end of a content block.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessContentBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#HarnessContentBlock" + } + }, + "com.amazonaws.bedrockagentcore#HarnessConversationRole": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user" + } + }, + "ASSISTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "assistant" + } + } + } + }, + "com.amazonaws.bedrockagentcore#HarnessEndpointName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcore#HarnessGatewayOutboundAuth": { + "type": "union", + "members": { + "awsIam": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "SigV4-sign requests using the agent's execution role.
" + } + }, + "none": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "No authentication.
" + } + }, + "oauth": { + "target": "com.amazonaws.bedrockagentcore#OAuthCredentialProvider", + "traits": { + "smithy.api#documentation": "OAuth 2.0 authentication via AgentCore Identity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Authentication method for calling a Gateway.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessGeminiModelConfig": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockagentcore#ModelId", + "traits": { + "smithy.api#documentation": "The Gemini model ID.
", + "smithy.api#required": {} + } + }, + "apiKeyArn": { + "target": "com.amazonaws.bedrockagentcore#ApiKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of your Gemini API key on AgentCore Identity.
", + "smithy.api#required": {} + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrockagentcore#MaxTokens", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to allow in the generated response per iteration.
" + } + }, + "temperature": { + "target": "com.amazonaws.bedrockagentcore#Temperature", + "traits": { + "smithy.api#documentation": "The temperature to set when calling the model.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagentcore#TopP", + "traits": { + "smithy.api#documentation": "The topP set when calling the model.
" + } + }, + "topK": { + "target": "com.amazonaws.bedrockagentcore#TopK", + "traits": { + "smithy.api#documentation": "The topK set when calling the model.
" + } + }, + "additionalParams": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Provider-specific parameters passed through to the Gemini model provider unchanged.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a Google Gemini model provider. Requires an API key stored in AgentCore Identity.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessInlineFunctionConfig": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.bedrockagentcore#HarnessInlineFunctionDescription", + "traits": { + "smithy.api#documentation": "Description of what the tool does, provided to the model.
", + "smithy.api#required": {} + } + }, + "inputSchema": { + "target": "com.amazonaws.bedrockagentcore#SensitiveJson", + "traits": { + "smithy.api#documentation": "JSON Schema describing the tool's input parameters.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for an inline function tool. When the agent calls this tool, the tool call is returned to the caller for external execution.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessInlineFunctionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#HarnessLiteLlmApiBase": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16383 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#HarnessLiteLlmModelConfig": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockagentcore#ModelId", + "traits": { + "smithy.api#documentation": "The LiteLLM model identifier (e.g., \"anthropic/claude-3-sonnet\").
", + "smithy.api#required": {} + } + }, + "apiKeyArn": { + "target": "com.amazonaws.bedrockagentcore#ApiKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the API key in AgentCore Identity for authenticating with the model provider.
" + } + }, + "apiBase": { + "target": "com.amazonaws.bedrockagentcore#HarnessLiteLlmApiBase", + "traits": { + "smithy.api#documentation": "The base URL for the model provider's API endpoint.
" + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrockagentcore#MaxTokens", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to allow in the generated response per iteration.
" + } + }, + "temperature": { + "target": "com.amazonaws.bedrockagentcore#Temperature", + "traits": { + "smithy.api#documentation": "The temperature to set when calling the model.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagentcore#TopP", + "traits": { + "smithy.api#documentation": "The topP set when calling the model.
" + } + }, + "additionalParams": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Provider-specific parameters passed through to the model provider unchanged.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for a LiteLLM model provider, enabling connection to third-party model providers.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessMessage": { + "type": "structure", + "members": { + "role": { + "target": "com.amazonaws.bedrockagentcore#HarnessConversationRole", + "traits": { + "smithy.api#documentation": "The role of the message sender.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentcore#HarnessContentBlocks", + "traits": { + "smithy.api#documentation": "The content blocks of the message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A message in the conversation.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessMessageStartEvent": { + "type": "structure", + "members": { + "role": { + "target": "com.amazonaws.bedrockagentcore#HarnessConversationRole", + "traits": { + "smithy.api#documentation": "The role of the message sender.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Event indicating the start of a message.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessMessageStopEvent": { + "type": "structure", + "members": { + "stopReason": { + "target": "com.amazonaws.bedrockagentcore#HarnessStopReason", + "traits": { + "smithy.api#documentation": "The reason the agent stopped generating.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Event indicating the end of a message.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#HarnessMessage" + } + }, + "com.amazonaws.bedrockagentcore#HarnessMetadataEvent": { + "type": "structure", + "members": { + "usage": { + "target": "com.amazonaws.bedrockagentcore#HarnessTokenUsage", + "traits": { + "smithy.api#documentation": "Token usage counts.
", + "smithy.api#required": {} + } + }, + "metrics": { + "target": "com.amazonaws.bedrockagentcore#HarnessStreamMetrics", + "traits": { + "smithy.api#documentation": "Latency metrics.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Token usage and latency metrics for the invocation.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessModelConfiguration": { + "type": "union", + "members": { + "bedrockModelConfig": { + "target": "com.amazonaws.bedrockagentcore#HarnessBedrockModelConfig", + "traits": { + "smithy.api#documentation": "Configuration for an Amazon Bedrock model.
" + } + }, + "openAiModelConfig": { + "target": "com.amazonaws.bedrockagentcore#HarnessOpenAiModelConfig", + "traits": { + "smithy.api#documentation": "Configuration for an OpenAI model.
" + } + }, + "geminiModelConfig": { + "target": "com.amazonaws.bedrockagentcore#HarnessGeminiModelConfig", + "traits": { + "smithy.api#documentation": "Configuration for a Google Gemini model.
" + } + }, + "liteLlmModelConfig": { + "target": "com.amazonaws.bedrockagentcore#HarnessLiteLlmModelConfig", + "traits": { + "smithy.api#documentation": "The LiteLLM model configuration for connecting to third-party model providers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specification of which model to use.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessOpenAiApiFormat": { + "type": "enum", + "members": { + "CHAT_COMPLETIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Use the Chat Completions API format.
", + "smithy.api#enumValue": "chat_completions" + } + }, + "RESPONSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Use the Responses API format.
", + "smithy.api#enumValue": "responses" + } + } + } + }, + "com.amazonaws.bedrockagentcore#HarnessOpenAiModelConfig": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockagentcore#ModelId", + "traits": { + "smithy.api#documentation": "The OpenAI model ID.
", + "smithy.api#required": {} + } + }, + "apiKeyArn": { + "target": "com.amazonaws.bedrockagentcore#ApiKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of your OpenAI API key on AgentCore Identity.
", + "smithy.api#required": {} + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrockagentcore#MaxTokens", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to allow in the generated response per iteration.
" + } + }, + "temperature": { + "target": "com.amazonaws.bedrockagentcore#Temperature", + "traits": { + "smithy.api#documentation": "The temperature to set when calling the model.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagentcore#TopP", + "traits": { + "smithy.api#documentation": "The topP set when calling the model.
" + } + }, + "apiFormat": { + "target": "com.amazonaws.bedrockagentcore#HarnessOpenAiApiFormat", + "traits": { + "smithy.api#documentation": "The API format to use when calling the OpenAI provider.
" + } + }, + "additionalParams": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Provider-specific parameters passed through to the model provider unchanged.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for an OpenAI model provider. Requires an API key stored in AgentCore Identity.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessReasoningContentBlock": { + "type": "union", + "members": { + "reasoningText": { + "target": "com.amazonaws.bedrockagentcore#HarnessReasoningTextBlock", + "traits": { + "smithy.api#documentation": "The reasoning text.
" + } + }, + "redactedContent": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "Redacted reasoning content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Reasoning content from the model.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#HarnessReasoningContentBlockDelta": { + "type": "union", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Reasoning text delta.
" + } + }, + "redactedContent": { + "target": "com.amazonaws.bedrockagentcore#Body", + "traits": { + "smithy.api#documentation": "Redacted reasoning content.
" + } + }, + "signature": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Signature for the reasoning content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A delta update to a reasoning content block.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#HarnessReasoningTextBlock": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reasoning text.
", + "smithy.api#required": {} + } + }, + "signature": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Signature for verifying the reasoning content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A block of reasoning text from the model.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#HarnessRemoteMcpConfig": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.bedrockagentcore#HarnessRemoteMcpUrl", + "traits": { + "smithy.api#documentation": "URL of the MCP endpoint.
", + "smithy.api#required": {} + } + }, + "headers": { + "target": "com.amazonaws.bedrockagentcore#HttpHeadersMap", + "traits": { + "smithy.api#documentation": "Custom headers to include when connecting to the remote MCP server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for connecting to a remote MCP server.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessRemoteMcpUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16383 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#HarnessSkill": { + "type": "union", + "members": { + "path": { + "target": "com.amazonaws.bedrockagentcore#HarnessSkillPath", + "traits": { + "smithy.api#documentation": "The filesystem path to the skill definition.
" + } + }, + "s3": { + "target": "com.amazonaws.bedrockagentcore#HarnessSkillS3Source", + "traits": { + "smithy.api#documentation": "An S3 source containing the skill.
" + } + }, + "git": { + "target": "com.amazonaws.bedrockagentcore#HarnessSkillGitSource", + "traits": { + "smithy.api#documentation": "A git repository containing the skill.
" + } + }, + "awsSkills": { + "target": "com.amazonaws.bedrockagentcore#HarnessSkillAwsSkillsSource", + "traits": { + "smithy.api#documentation": "AWS Skills baked into the Harness's underlying Runtime.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A skill available to the agent.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessSkillAwsSkillsSource": { + "type": "structure", + "members": { + "paths": { + "target": "com.amazonaws.bedrockagentcore#HarnessAwsSkillPaths", + "traits": { + "smithy.api#documentation": "Optionally filter allowed skills with glob syntax, e.g., ['core-skills/*'].
" + } + } + }, + "traits": { + "smithy.api#documentation": "Passed to show that AWS Skills should be included.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessSkillGitAuth": { + "type": "structure", + "members": { + "credentialArn": { + "target": "com.amazonaws.bedrockagentcore#ApiKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the credential in AgentCore Identity containing the password or personal access token.
", + "smithy.api#required": {} + } + }, + "username": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Username for authentication. Defaults to 'oauth2' if not specified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Authentication configuration for accessing a private git repository.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessSkillGitSource": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.bedrockagentcore#HarnessSkillGitUrl", + "traits": { + "smithy.api#documentation": "The HTTPS URL of the git repository.
", + "smithy.api#required": {} + } + }, + "path": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Subdirectory within the repository containing the skill.
" + } + }, + "auth": { + "target": "com.amazonaws.bedrockagentcore#HarnessSkillGitAuth", + "traits": { + "smithy.api#documentation": "Authentication configuration for private repositories.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A git repository source for a skill.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessSkillGitUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 16383 + }, + "smithy.api#pattern": "^https://[^#@]+$" + } + }, + "com.amazonaws.bedrockagentcore#HarnessSkillPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.bedrockagentcore#HarnessSkillS3Source": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagentcore#HarnessSkillS3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI pointing to the skill directory (e.g., s3://bucket/skills/my-skill/).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An S3 source for a skill.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessSkillS3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 16383 + }, + "smithy.api#pattern": "^s3://" + } + }, + "com.amazonaws.bedrockagentcore#HarnessSkills": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#HarnessSkill" + } + }, + "com.amazonaws.bedrockagentcore#HarnessStopReason": { + "type": "enum", + "members": { + "END_TURN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "end_turn" + } + }, + "TOOL_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tool_use" + } + }, + "TOOL_RESULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tool_result" + } + }, + "MAX_TOKENS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "max_tokens" + } + }, + "STOP_SEQUENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stop_sequence" + } + }, + "CONTENT_FILTERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "content_filtered" + } + }, + "MALFORMED_MODEL_OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "malformed_model_output" + } + }, + "MALFORMED_TOOL_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "malformed_tool_use" + } + }, + "INTERRUPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "interrupted" + } + }, + "PARTIAL_TURN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "partial_turn" + } + }, + "MODEL_CONTEXT_WINDOW_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "model_context_window_exceeded" + } + }, + "MAX_ITERATIONS_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "max_iterations_exceeded" + } + }, + "MAX_OUTPUT_TOKENS_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "max_output_tokens_exceeded" + } + }, + "TIMEOUT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "timeout_exceeded" + } + } + } + }, + "com.amazonaws.bedrockagentcore#HarnessStreamMetrics": { + "type": "structure", + "members": { + "latencyMs": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The end-to-end latency of the invocation in milliseconds.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Latency metrics for the invocation.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessSystemContentBlock": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentcore#SensitiveText", + "traits": { + "smithy.api#documentation": "The text content of the system prompt block.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A content block in the system prompt.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessSystemPrompt": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#HarnessSystemContentBlock" + } + }, + "com.amazonaws.bedrockagentcore#HarnessTokenUsage": { + "type": "structure", + "members": { + "inputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of input tokens consumed.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "outputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of output tokens generated.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "totalTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of tokens consumed.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "cacheReadInputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of input tokens read from cache.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "cacheWriteInputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of input tokens written to cache.
", + "smithy.api#range": { + "min": 0 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Token usage counts for the invocation.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessTool": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolType", + "traits": { + "smithy.api#documentation": "The type of tool.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolName", + "traits": { + "smithy.api#documentation": "Unique name for the tool. If not provided, a name will be inferred or generated.
" + } + }, + "config": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolConfiguration", + "traits": { + "smithy.api#documentation": "Tool-specific configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A tool available to the agent loop.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolConfiguration": { + "type": "union", + "members": { + "remoteMcp": { + "target": "com.amazonaws.bedrockagentcore#HarnessRemoteMcpConfig", + "traits": { + "smithy.api#documentation": "Configuration for remote MCP server.
" + } + }, + "agentCoreBrowser": { + "target": "com.amazonaws.bedrockagentcore#HarnessAgentCoreBrowserConfig", + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Browser.
" + } + }, + "agentCoreGateway": { + "target": "com.amazonaws.bedrockagentcore#HarnessAgentCoreGatewayConfig", + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Gateway.
" + } + }, + "inlineFunction": { + "target": "com.amazonaws.bedrockagentcore#HarnessInlineFunctionConfig", + "traits": { + "smithy.api#documentation": "Configuration for an inline function tool.
" + } + }, + "agentCoreCodeInterpreter": { + "target": "com.amazonaws.bedrockagentcore#HarnessAgentCoreCodeInterpreterConfig", + "traits": { + "smithy.api#documentation": "Configuration for AgentCore Code Interpreter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration union for different tool types.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolResultBlock": { + "type": "structure", + "members": { + "toolUseId": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolUseId", + "traits": { + "smithy.api#documentation": "The tool use ID that this result corresponds to.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolResultContentBlocks", + "traits": { + "smithy.api#documentation": "The content of the tool result.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolUseStatus", + "traits": { + "smithy.api#documentation": "The status of the tool execution.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolUseType", + "traits": { + "smithy.api#documentation": "The type of tool use that produced this result.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a tool execution.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolResultBlockDelta": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentcore#SensitiveText", + "traits": { + "smithy.api#documentation": "A text tool result delta.
" + } + }, + "json": { + "target": "com.amazonaws.bedrockagentcore#SensitiveJson", + "traits": { + "smithy.api#documentation": "A JSON tool result delta.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A delta update to a tool result content block.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolResultBlockStart": { + "type": "structure", + "members": { + "toolUseId": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolUseId", + "traits": { + "smithy.api#documentation": "The tool use ID that this result corresponds to.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolUseStatus", + "traits": { + "smithy.api#documentation": "The status of the tool execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Start payload for a tool result content block.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolResultBlocksDelta": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolResultBlockDelta" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolResultContentBlock": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentcore#SensitiveText", + "traits": { + "smithy.api#documentation": "Text content.
" + } + }, + "json": { + "target": "com.amazonaws.bedrockagentcore#SensitiveJson", + "traits": { + "smithy.api#documentation": "JSON content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A content block within a tool result.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolResultContentBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolResultContentBlock" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolResultMetadataBlockDelta": { + "type": "structure", + "members": { + "metadata": { + "target": "com.amazonaws.bedrockagentcore#SensitiveText", + "traits": { + "smithy.api#documentation": "The partial JSON-string fragment of the tool result metadata.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Delta payload for a tool result metadata.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolType": { + "type": "enum", + "members": { + "REMOTE_MCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "remote_mcp" + } + }, + "AGENTCORE_BROWSER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "agentcore_browser" + } + }, + "AGENTCORE_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "agentcore_gateway" + } + }, + "INLINE_FUNCTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inline_function" + } + }, + "AGENTCORE_CODE_INTERPRETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "agentcore_code_interpreter" + } + } + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolUseBlock": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolName", + "traits": { + "smithy.api#documentation": "The name of the tool to call.
", + "smithy.api#required": {} + } + }, + "toolUseId": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolUseId", + "traits": { + "smithy.api#documentation": "The unique ID of this tool use.
", + "smithy.api#required": {} + } + }, + "input": { + "target": "com.amazonaws.bedrockagentcore#SensitiveJson", + "traits": { + "smithy.api#documentation": "The JSON input to pass to the tool.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolUseType", + "traits": { + "smithy.api#documentation": "The type of tool use.
" + } + }, + "serverName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the MCP server providing this tool.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A tool use request from the model.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolUseBlockDelta": { + "type": "structure", + "members": { + "input": { + "target": "com.amazonaws.bedrockagentcore#SensitiveText", + "traits": { + "smithy.api#documentation": "The partial JSON input for the tool call.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Delta payload for tool use input.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolUseBlockStart": { + "type": "structure", + "members": { + "toolUseId": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolUseId", + "traits": { + "smithy.api#documentation": "The unique ID of this tool use.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolName", + "traits": { + "smithy.api#documentation": "The name of the tool being called.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcore#HarnessToolUseType", + "traits": { + "smithy.api#documentation": "The type of tool use.
" + } + }, + "serverName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the MCP server providing this tool.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Start payload for a tool use content block.
" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolUseId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolUseStatus": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "success" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.bedrockagentcore#HarnessToolUseType": { + "type": "enum", + "members": { + "TOOL_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tool_use" + } + }, + "SERVER_TOOL_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "server_tool_use" + } + }, + "MCP_TOOL_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mcp_tool_use" + } + } + } + }, + "com.amazonaws.bedrockagentcore#HarnessTools": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#HarnessTool" + } + }, + "com.amazonaws.bedrockagentcore#HostName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?(\\.[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?)*$" + } + }, + "com.amazonaws.bedrockagentcore#HttpHeaderKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "The key of an HTTP header.", + "smithy.api#length": { + "min": 1, + "max": 16383 + } + } + }, + "com.amazonaws.bedrockagentcore#HttpHeaderValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "The value of an HTTP header.", + "smithy.api#length": { + "min": 1, + "max": 16383 + } + } + }, + "com.amazonaws.bedrockagentcore#HttpHeadersMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcore#HttpHeaderKey" + }, + "value": { + "target": "com.amazonaws.bedrockagentcore#HttpHeaderValue" + }, + "traits": { + "smithy.api#documentation": "Map of key/value pairs for HTTP headers.", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#HttpResponseCode": { + "type": "integer" + }, + "com.amazonaws.bedrockagentcore#IgnoredReferenceInputField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagentcore#IgnoredReferenceInputFields": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#IgnoredReferenceInputField" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcore#InlineContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 409600 + } + } + }, + "com.amazonaws.bedrockagentcore#InlineGroundTruth": { + "type": "structure", + "members": { + "assertions": { + "target": "com.amazonaws.bedrockagentcore#EvaluationContentList", + "traits": { + "smithy.api#documentation": "Assertions for evaluation, reuses common model EvaluationContentList.
" + } + }, + "expectedTrajectory": { + "target": "com.amazonaws.bedrockagentcore#EvaluationExpectedTrajectory", + "traits": { + "smithy.api#documentation": "The expected tool call sequence for trajectory evaluation.
" + } + }, + "turns": { + "target": "com.amazonaws.bedrockagentcore#GroundTruthTurnList", + "traits": { + "smithy.api#documentation": "A list of per-turn ground truth data, each containing an input prompt and expected response.
", + "smithy.api#length": { + "min": 1 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Inline ground truth data containing assertions, expected trajectories, and per-turn expected responses.
" + } + }, + "com.amazonaws.bedrockagentcore#InputContentBlock": { + "type": "structure", + "members": { + "path": { + "target": "com.amazonaws.bedrockagentcore#MaxLenString", + "traits": { + "smithy.api#documentation": "The path to the input content.
", + "smithy.api#required": {} + } + }, + "text": { + "target": "com.amazonaws.bedrockagentcore#MaxLenString", + "traits": { + "smithy.api#documentation": "The text input content.
" + } + }, + "blob": { + "target": "com.amazonaws.bedrockagentcore#Body", + "traits": { + "smithy.api#documentation": "The binary input content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A block of input content.
" + } + }, + "com.amazonaws.bedrockagentcore#InputContentBlockList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#InputContentBlock" + } + }, + "com.amazonaws.bedrockagentcore#Insight": { + "type": "structure", + "members": { + "insightId": { + "target": "com.amazonaws.bedrockagentcore#InsightId", + "traits": { + "smithy.api#documentation": "The unique identifier of the insight to run.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to an insight analysis to run against sessions during batch evaluation. Insights provide deeper analysis beyond individual evaluator scores, including failure detection, user intent clustering, and execution summarization.
" + } + }, + "com.amazonaws.bedrockagentcore#InsightId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Canonical insight identifiers using the Builtin.Insight.* naming convention.\nUsed by BatchEvaluate, InternalEvaluate, and ServiceEngineEvaluate flows.", + "smithy.api#pattern": "^(Builtin\\.[a-zA-Z0-9._-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})$" + } + }, + "com.amazonaws.bedrockagentcore#InsightList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#Insight" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcore#InsightsFailureCategory": { + "type": "enum", + "members": { + "EXECUTION_ERROR_AUTHENTICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "execution-error-category-authentication" + } + }, + "EXECUTION_ERROR_RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "execution-error-category-resource-not-found" + } + }, + "EXECUTION_ERROR_SERVICE_ERRORS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "execution-error-category-service-errors" + } + }, + "EXECUTION_ERROR_RATE_LIMITING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "execution-error-category-rate-limiting" + } + }, + "EXECUTION_ERROR_FORMATTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "execution-error-category-formatting" + } + }, + "EXECUTION_ERROR_TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "execution-error-category-timeout" + } + }, + "EXECUTION_ERROR_RESOURCE_EXHAUSTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "execution-error-category-resource-exhaustion" + } + }, + "EXECUTION_ERROR_ENVIRONMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "execution-error-category-environment" + } + }, + "EXECUTION_ERROR_TOOL_SCHEMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "execution-error-category-tool-schema" + } + }, + "TASK_INSTRUCTION_NON_COMPLIANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "task-instruction-category-non-compliance" + } + }, + "TASK_INSTRUCTION_PROBLEM_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "task-instruction-category-problem-id" + } + }, + "INCORRECT_ACTIONS_TOOL_SELECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incorrect-actions-category-tool-selection" + } + }, + "INCORRECT_ACTIONS_POOR_INFORMATION_RETRIEVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incorrect-actions-category-poor-information-retrieval" + } + }, + "INCORRECT_ACTIONS_CLARIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incorrect-actions-category-clarification" + } + }, + "INCORRECT_ACTIONS_INAPPROPRIATE_INFO_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incorrect-actions-category-inappropriate-info-request" + } + }, + "CONTEXT_HANDLING_FAILURES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "context-handling-error-category-context-handling-failures" + } + }, + "HALLUCINATION_CAPABILITIES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hallucination-category-hall-capabilities" + } + }, + "HALLUCINATION_MISUNDERSTAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hallucination-category-hall-misunderstand" + } + }, + "HALLUCINATION_USAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hallucination-category-hall-usage" + } + }, + "HALLUCINATION_HISTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hallucination-category-hall-history" + } + }, + "HALLUCINATION_PARAMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hallucination-category-hall-params" + } + }, + "HALLUCINATION_FABRICATE_TOOL_OUTPUTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hallucination-category-fabricate-tool-outputs" + } + }, + "REPETITIVE_BEHAVIOR_TOOL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "repetitive-behavior-category-repetition-tool" + } + }, + "REPETITIVE_BEHAVIOR_INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "repetitive-behavior-category-repetition-info" + } + }, + "REPETITIVE_BEHAVIOR_STEP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "repetitive-behavior-category-step-repetition" + } + }, + "ORCHESTRATION_REASONING_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "orchestration-related-errors-category-reasoning-mismatch" + } + }, + "ORCHESTRATION_GOAL_DEVIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "orchestration-related-errors-category-goal-deviation" + } + }, + "ORCHESTRATION_PREMATURE_TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "orchestration-related-errors-category-premature-termination" + } + }, + "ORCHESTRATION_UNAWARE_TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "orchestration-related-errors-category-unaware-termination" + } + }, + "LLM_OUTPUT_NONSENSICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "llm-output-category-nonsensical" + } + }, + "CONFIGURATION_MISMATCH_TOOL_DEFINITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "configuration-mismatch-category-tool-definition" + } + }, + "CODING_EDGE_CASE_OVERSIGHTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "coding-use-case-specific-failure-types-category-edge-case-oversights" + } + }, + "CODING_DEPENDENCY_ISSUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "coding-use-case-specific-failure-types-category-dependency-issues" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + }, + "traits": { + "smithy.api#documentation": "Failure category taxonomy for agent session insights.\nValues must stay in sync with the category registry in AgentCoreLens\n(amzn_agentcore_lens.config.failure_detection.FAILURE_CATEGORIES)." + } + }, + "com.amazonaws.bedrockagentcore#InsightsFailureSignal": { + "type": "structure", + "members": { + "category": { + "target": "com.amazonaws.bedrockagentcore#InsightsFailureCategory", + "traits": { + "smithy.api#documentation": "The failure category classification for this signal.
", + "smithy.api#required": {} + } + }, + "evidence": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The evidence supporting the failure detection.
", + "smithy.api#required": {} + } + }, + "confidence": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The confidence score of the failure detection.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A signal indicating a detected failure within a span.
" + } + }, + "com.amazonaws.bedrockagentcore#InsightsFailureSignalList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#InsightsFailureSignal" + } + }, + "com.amazonaws.bedrockagentcore#InstrumentBalanceToken": { + "type": "enum", + "members": { + "USDC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USDC" + } + } + }, + "traits": { + "smithy.api#documentation": "Supported tokens for instrument balance queries. Only tokens supported for X402 payments are returned.
" + } + }, + "com.amazonaws.bedrockagentcore#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcore#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockagentcore#InvalidInputException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagentcore#InvokeAgentRuntime": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#InvokeAgentRuntimeRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#InvokeAgentRuntimeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#RetryableConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#RuntimeClientError" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
To invoke an agent, you can specify either the AgentCore Runtime ARN or the agent ID with an account ID, and provide a payload containing your request. When you use the agent ID instead of the full ARN, you don't need to URL-encode the identifier. You can optionally specify a qualifier to target a specific endpoint of the agent.
This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.
For example code, see Invoke an AgentCore Runtime agent.
If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.
To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission. If you are making a call to InvokeAgentRuntime on behalf of a user ID with the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header, You require permissions to both actions (bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser).
Executes a command in a runtime session container and streams the output back to the caller. This operation allows you to run shell commands within the agent runtime environment and receive real-time streaming responses including standard output and standard error.
To invoke a command, you must specify the agent runtime ARN and a runtime session ID. The command execution supports streaming responses, allowing you to receive output as it becomes available through contentStart, contentDelta, and contentStop events.
To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntimeCommand permission.
The MIME type of the input data in the request payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "accept": { + "target": "com.amazonaws.bedrockagentcore#MimeType", + "traits": { + "smithy.api#documentation": "The desired MIME type for the response from the agent runtime command. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.
", + "smithy.api#httpHeader": "Accept" + } + }, + "runtimeSessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionType", + "traits": { + "smithy.api#documentation": "The unique identifier of the runtime session in which to execute the command. This session ID is used to maintain state and context across multiple command invocations.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Runtime-Session-Id", + "smithy.api#idempotencyToken": {} + } + }, + "traceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The trace identifier for request tracking.
", + "smithy.api#httpHeader": "X-Amzn-Trace-Id", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "traceParent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The parent trace information for distributed tracing.
", + "smithy.api#httpHeader": "traceparent", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "traceState": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The trace state information for distributed tracing.
", + "smithy.api#httpHeader": "tracestate", + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "baggage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Additional context information for distributed tracing.
", + "smithy.api#httpHeader": "baggage", + "smithy.api#length": { + "min": 0, + "max": 8192 + } + } + }, + "agentRuntimeArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent runtime on which to execute the command. This identifies the specific agent runtime environment where the command will run.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "qualifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The qualifier to use for the agent runtime. This is an endpoint name that points to a specific version. If not specified, Amazon Bedrock AgentCore uses the default endpoint of the agent runtime.
", + "smithy.api#httpQuery": "qualifier" + } + }, + "accountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services account for the agent runtime resource. This parameter is required when you specify an agent ID instead of the full ARN for agentRuntimeArn.
The request body containing the command to execute and optional configuration parameters such as timeout settings.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request for InvokeAgentRuntimeCommand operation.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#InvokeAgentRuntimeCommandRequestBody": { + "type": "structure", + "members": { + "command": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The shell command to execute on the agent runtime. This command is executed in the runtime environment and its output is streamed back to the caller.
", + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#required": {} + } + }, + "timeout": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum duration in seconds to wait for the command to complete. If the command execution exceeds this timeout, it will be terminated. Default is 300 seconds. Minimum is 1 second. Maximum is 3600 seconds.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request body structure for the InvokeAgentRuntimeCommand operation, containing the command to execute and optional configuration parameters.
The unique identifier of the runtime session in which the command was executed.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" + } + }, + "traceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The trace identifier for request tracking.
", + "smithy.api#httpHeader": "X-Amzn-Trace-Id" + } + }, + "traceParent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The parent trace information for distributed tracing.
", + "smithy.api#httpHeader": "traceparent" + } + }, + "traceState": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The trace state information for distributed tracing.
", + "smithy.api#httpHeader": "tracestate" + } + }, + "baggage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Additional context information for distributed tracing.
", + "smithy.api#httpHeader": "baggage" + } + }, + "contentType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The MIME type of the response data. This indicates how to interpret the response data. Common values include application/json for JSON data.
", + "smithy.api#httpHeader": "Content-Type", + "smithy.api#required": {} + } + }, + "statusCode": { + "target": "com.amazonaws.bedrockagentcore#HttpResponseCode", + "traits": { + "smithy.api#documentation": "The HTTP status code of the response. A status code of 200 indicates a successful operation. Other status codes indicate various error conditions.
", + "smithy.api#httpResponseCode": {} + } + }, + "stream": { + "target": "com.amazonaws.bedrockagentcore#InvokeAgentRuntimeCommandStreamOutput", + "traits": { + "smithy.api#documentation": "The streaming output from the command execution. This stream contains events that provide real-time updates including standard output, standard error, and completion status.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response for InvokeAgentRuntimeCommand operation.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#InvokeAgentRuntimeCommandStreamOutput": { + "type": "union", + "members": { + "chunk": { + "target": "com.amazonaws.bedrockagentcore#ResponseChunk", + "traits": { + "smithy.api#documentation": "A response chunk containing command execution events such as content start, content delta, or content stop events.
" + } + }, + "accessDeniedException": { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException", + "traits": { + "smithy.api#documentation": "Exception events for error streaming.
" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + "resourceNotFoundException": { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + "serviceQuotaExceededException": { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + "throttlingException": { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + "validationException": { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + }, + "runtimeClientError": { + "target": "com.amazonaws.bedrockagentcore#RuntimeClientError" + } + }, + "traits": { + "smithy.api#documentation": "The streaming output union for the InvokeAgentRuntimeCommand operation. This union delivers typed events: contentStart (first), contentDelta (middle), and contentStop (last).
The MIME type of the input data in the payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "accept": { + "target": "com.amazonaws.bedrockagentcore#MimeType", + "traits": { + "smithy.api#documentation": "The desired MIME type for the response from the agent runtime. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.
", + "smithy.api#httpHeader": "Accept" + } + }, + "mcpSessionId": { + "target": "com.amazonaws.bedrockagentcore#StringType", + "traits": { + "smithy.api#documentation": "The identifier of the MCP session.
", + "smithy.api#httpHeader": "Mcp-Session-Id" + } + }, + "runtimeSessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionType", + "traits": { + "smithy.api#documentation": "The identifier of the runtime session.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Runtime-Session-Id", + "smithy.api#idempotencyToken": {} + } + }, + "mcpProtocolVersion": { + "target": "com.amazonaws.bedrockagentcore#StringType", + "traits": { + "smithy.api#documentation": "The version of the MCP protocol being used.
", + "smithy.api#httpHeader": "Mcp-Protocol-Version" + } + }, + "mcpMethod": { + "target": "com.amazonaws.bedrockagentcore#StringType", + "traits": { + "smithy.api#documentation": "The MCP method being invoked. For example, tools/call, resources/read, or prompts/get.
The name of the MCP resource, tool, or prompt being accessed. The value depends on the method:
tools/call – The tool name.
resources/read – The resource URI.
prompts/get – The prompt name.
The identifier of the runtime user.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Runtime-User-Id" + } + }, + "traceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The trace identifier for request tracking.
", + "smithy.api#httpHeader": "X-Amzn-Trace-Id", + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "traceParent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The parent trace information for distributed tracing.
", + "smithy.api#httpHeader": "traceparent", + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "traceState": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The trace state information for distributed tracing.
", + "smithy.api#httpHeader": "tracestate", + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "baggage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Additional context information for distributed tracing.
", + "smithy.api#httpHeader": "baggage", + "smithy.api#length": { + "min": 0, + "max": 8192 + } + } + }, + "agentRuntimeArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the agent runtime to invoke. You can specify either the full Amazon Web Services Resource Name (ARN) or the agent ID. If you use the agent ID, you must also provide the accountId query parameter.
The qualifier to use for the agent runtime. This is an endpoint name that points to a specific version. If not specified, Amazon Bedrock AgentCore uses the default endpoint of the agent runtime.
", + "smithy.api#httpQuery": "qualifier" + } + }, + "accountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services account for the agent runtime resource. This parameter is required when you specify an agent ID instead of the full ARN for agentRuntimeArn.
The input data to send to the agent runtime. The format of this data depends on the specific agent configuration and must match the specified content type. For most agents, this is a JSON object containing the user's request.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#InvokeAgentRuntimeResponse": { + "type": "structure", + "members": { + "runtimeSessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionId", + "traits": { + "smithy.api#documentation": "The identifier of the runtime session.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" + } + }, + "mcpSessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionId", + "traits": { + "smithy.api#documentation": "The identifier of the MCP session.
", + "smithy.api#httpHeader": "Mcp-Session-Id" + } + }, + "mcpProtocolVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the MCP protocol being used.
", + "smithy.api#httpHeader": "Mcp-Protocol-Version" + } + }, + "traceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The trace identifier for request tracking.
", + "smithy.api#httpHeader": "X-Amzn-Trace-Id" + } + }, + "traceParent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The parent trace information for distributed tracing.
", + "smithy.api#httpHeader": "traceparent" + } + }, + "traceState": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The trace state information for distributed tracing.
", + "smithy.api#httpHeader": "tracestate" + } + }, + "baggage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Additional context information for distributed tracing.
", + "smithy.api#httpHeader": "baggage" + } + }, + "contentType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The MIME type of the response data. This indicates how to interpret the response data. Common values include application/json for JSON data.
", + "smithy.api#httpHeader": "Content-Type", + "smithy.api#required": {} + } + }, + "response": { + "target": "com.amazonaws.bedrockagentcore#ResponseStream", + "traits": { + "smithy.api#default": "", + "smithy.api#documentation": "The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.
", + "smithy.api#httpPayload": {} + } + }, + "statusCode": { + "target": "com.amazonaws.bedrockagentcore#HttpResponseCode", + "traits": { + "smithy.api#documentation": "The HTTP status code of the response. A status code of 200 indicates a successful operation. Other status codes indicate various error conditions.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#InvokeBrowser": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#InvokeBrowserRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#InvokeBrowserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Invokes an operating system-level action on a browser session in Amazon Bedrock AgentCore. This operation provides direct OS-level control over browser sessions, enabling mouse actions, keyboard input, and screenshots that the WebSocket-based Chrome DevTools Protocol (CDP) cannot handle — such as interacting with print dialogs, context menus, and JavaScript alerts.
You send a request with exactly one action in the BrowserAction union, and receive a corresponding result in the BrowserActionResult union.
The following operations are related to InvokeBrowser:
The unique identifier of the browser associated with the session. This must match the identifier used when creating the session with StartBrowserSession.
The unique identifier of the browser session on which to perform the action. This must be an active session created with StartBrowserSession.
The browser action to perform. Exactly one member of the BrowserAction union must be set per request.
Request for the InvokeBrowser operation.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#InvokeBrowserResponse": { + "type": "structure", + "members": { + "result": { + "target": "com.amazonaws.bedrockagentcore#BrowserActionResult", + "traits": { + "smithy.api#documentation": "The result of the browser action. The member set in the result corresponds to the action that was performed.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser session on which the action was performed.
", + "smithy.api#httpHeader": "x-amzn-browser-session-id", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response for the InvokeBrowser operation.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#InvokeCodeInterpreter": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#InvokeCodeInterpreterRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#InvokeCodeInterpreterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Executes code within an active code interpreter session in Amazon Bedrock AgentCore. This operation processes the provided code, runs it in a secure environment, and returns the execution results including output, errors, and generated visualizations.
To execute code, you must specify the code interpreter identifier, session ID, and the code to run in the arguments parameter. The operation returns a stream containing the execution results, which can include text output, error messages, and data visualizations.
This operation is subject to request rate limiting based on your account's service quotas.
The following operations are related to InvokeCodeInterpreter:
The unique identifier of the code interpreter associated with the session. This must match the identifier used when creating the session with StartCodeInterpreterSession.
The unique identifier of the code interpreter session to use. This must be an active session created with StartCodeInterpreterSession. If the session has expired or been stopped, the request will fail.
The trace identifier for request tracking.
", + "smithy.api#httpHeader": "X-Amzn-Trace-Id", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "traceParent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The parent trace information for distributed tracing.
", + "smithy.api#httpHeader": "traceparent", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#ToolName", + "traits": { + "smithy.api#documentation": "The name of the code interpreter to invoke.
", + "smithy.api#required": {} + } + }, + "arguments": { + "target": "com.amazonaws.bedrockagentcore#ToolArguments", + "traits": { + "smithy.api#documentation": "The arguments for the code interpreter. This includes the code to execute and any additional parameters such as the programming language, whether to clear the execution context, and other execution options. The structure of this parameter depends on the specific code interpreter being used.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#InvokeCodeInterpreterResponse": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionId", + "traits": { + "smithy.api#documentation": "The identifier of the code interpreter session.
", + "smithy.api#httpHeader": "x-amzn-code-interpreter-session-id" + } + }, + "stream": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterStreamOutput", + "traits": { + "smithy.api#documentation": "The stream containing the results of the code execution. This includes output, errors, and execution status.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#InvokeHarness": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#InvokeHarnessRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#InvokeHarnessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#RuntimeClientError" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Operation to invoke a Harness.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/harnesses/invoke" + } + } + }, + "com.amazonaws.bedrockagentcore#InvokeHarnessRequest": { + "type": "structure", + "members": { + "harnessArn": { + "target": "com.amazonaws.bedrockagentcore#HarnessArn", + "traits": { + "smithy.api#documentation": "The ARN of the harness to invoke.
", + "smithy.api#httpQuery": "harnessArn", + "smithy.api#required": {} + } + }, + "qualifier": { + "target": "com.amazonaws.bedrockagentcore#HarnessEndpointName", + "traits": { + "smithy.api#documentation": "The endpoint name to invoke. If omitted, the DEFAULT endpoint is used.
", + "smithy.api#httpQuery": "qualifier" + } + }, + "runtimeSessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionId", + "traits": { + "smithy.api#documentation": "The session ID for the invocation. Use the same session ID across requests to continue a conversation.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Runtime-Session-Id", + "smithy.api#length": { + "min": 33, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "runtimeUserId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "An identifier for the end user making the request. This value is passed through to the runtime container.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Runtime-User-Id" + } + }, + "traceParent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "W3C trace context parent header containing version, trace ID, parent span ID, and trace flags.
", + "smithy.api#httpHeader": "traceparent", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "traceState": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "W3C trace context state header for vendor-specific trace information.
", + "smithy.api#httpHeader": "tracestate", + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "traceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Trace ID for maintaining observability through the operation.
", + "smithy.api#httpHeader": "X-Amzn-Trace-Id", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "baggage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "W3C Baggage header for user-defined context propagation. Format: key1=value1,key2=value2
", + "smithy.api#httpHeader": "baggage", + "smithy.api#length": { + "min": 0, + "max": 8192 + } + } + }, + "messages": { + "target": "com.amazonaws.bedrockagentcore#HarnessMessages", + "traits": { + "smithy.api#documentation": "The messages to send to the agent.
", + "smithy.api#required": {} + } + }, + "model": { + "target": "com.amazonaws.bedrockagentcore#HarnessModelConfiguration", + "traits": { + "smithy.api#documentation": "The model configuration to use for this invocation. If specified, overrides the harness default.
" + } + }, + "systemPrompt": { + "target": "com.amazonaws.bedrockagentcore#HarnessSystemPrompt", + "traits": { + "smithy.api#documentation": "The system prompt to use for this invocation. If specified, overrides the harness default.
" + } + }, + "tools": { + "target": "com.amazonaws.bedrockagentcore#HarnessTools", + "traits": { + "smithy.api#documentation": "The tools available to the agent for this invocation. If specified, overrides the harness default.
" + } + }, + "skills": { + "target": "com.amazonaws.bedrockagentcore#HarnessSkills", + "traits": { + "smithy.api#documentation": "The skills available to the agent for this invocation. If specified, overrides the harness default.
" + } + }, + "allowedTools": { + "target": "com.amazonaws.bedrockagentcore#HarnessAllowedTools", + "traits": { + "smithy.api#documentation": "The tools that the agent is allowed to use for this invocation. If specified, overrides the harness default.
" + } + }, + "maxIterations": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of iterations the agent loop can execute. If specified, overrides the harness default.
" + } + }, + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens the agent can generate per iteration. If specified, overrides the harness default.
" + } + }, + "timeoutSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum duration in seconds for the agent loop execution. If specified, overrides the harness default.
" + } + }, + "actorId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The actor ID for memory operations. Overrides the actor ID configured on the harness.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#InvokeHarnessResponse": { + "type": "structure", + "members": { + "stream": { + "target": "com.amazonaws.bedrockagentcore#InvokeHarnessStreamOutput", + "traits": { + "smithy.api#documentation": "The streaming output from the harness invocation.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#InvokeHarnessStreamOutput": { + "type": "union", + "members": { + "messageStart": { + "target": "com.amazonaws.bedrockagentcore#HarnessMessageStartEvent", + "traits": { + "smithy.api#documentation": "Indicates the start of a new message from the agent.
" + } + }, + "contentBlockStart": { + "target": "com.amazonaws.bedrockagentcore#HarnessContentBlockStartEvent", + "traits": { + "smithy.api#documentation": "Indicates the start of a new content block.
" + } + }, + "contentBlockDelta": { + "target": "com.amazonaws.bedrockagentcore#HarnessContentBlockDeltaEvent", + "traits": { + "smithy.api#documentation": "A delta update to the current content block.
" + } + }, + "contentBlockStop": { + "target": "com.amazonaws.bedrockagentcore#HarnessContentBlockStopEvent", + "traits": { + "smithy.api#documentation": "Indicates the end of the current content block.
" + } + }, + "messageStop": { + "target": "com.amazonaws.bedrockagentcore#HarnessMessageStopEvent", + "traits": { + "smithy.api#documentation": "Indicates the end of the current message.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentcore#HarnessMetadataEvent", + "traits": { + "smithy.api#documentation": "Token usage and latency metrics for the invocation.
" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + "validationException": { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + }, + "runtimeClientError": { + "target": "com.amazonaws.bedrockagentcore#RuntimeClientError", + "traits": { + "smithy.api#documentation": "An error returned by the runtime container during agent execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The streaming events returned by a harness invocation.
", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockagentcore#JwtKeyId": { + "type": "string", + "traits": { + "smithy.api#documentation": "JWT Key ID (kid) from the JWT header.
", + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,255}$" + } + }, + "com.amazonaws.bedrockagentcore#KeyList": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#documentation": "A list of key names for keyboard shortcuts.
", + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentcore#KeyPressArguments": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The key name to press (for example, enter, tab, escape).
The number of times to press the key. Valid range: 1–100. Defaults to 1.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Arguments for a key press action.
" + } + }, + "com.amazonaws.bedrockagentcore#KeyPressResult": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcore#BrowserActionStatus", + "traits": { + "smithy.api#documentation": "The status of the action execution.
", + "smithy.api#required": {} + } + }, + "error": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message. Present only when the action failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a key press action.
" + } + }, + "com.amazonaws.bedrockagentcore#KeyShortcutArguments": { + "type": "structure", + "members": { + "keys": { + "target": "com.amazonaws.bedrockagentcore#KeyList", + "traits": { + "smithy.api#documentation": "The key combination to press (for example, [\"ctrl\", \"s\"]). Maximum 5 keys.
Arguments for a key shortcut action.
" + } + }, + "com.amazonaws.bedrockagentcore#KeyShortcutResult": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcore#BrowserActionStatus", + "traits": { + "smithy.api#documentation": "The status of the action execution.
", + "smithy.api#required": {} + } + }, + "error": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message. Present only when the action failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a key shortcut action.
" + } + }, + "com.amazonaws.bedrockagentcore#KeyTypeArguments": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text string to type. Maximum length: 10,000 characters.
", + "smithy.api#length": { + "max": 10000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Arguments for a key type action.
" + } + }, + "com.amazonaws.bedrockagentcore#KeyTypeResult": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcore#BrowserActionStatus", + "traits": { + "smithy.api#documentation": "The status of the action execution.
", + "smithy.api#required": {} + } + }, + "error": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message. Present only when the action failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a key type action.
" + } + }, + "com.amazonaws.bedrockagentcore#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.bedrockagentcore#LanguageRuntime": { + "type": "enum", + "members": { + "NODEJS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs" + } + }, + "DENO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deno" + } + }, + "PYTHON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python" + } + } + } + }, + "com.amazonaws.bedrockagentcore#LeftExpression": { + "type": "union", + "members": { + "metadataKey": { + "target": "com.amazonaws.bedrockagentcore#MetadataKey", + "traits": { + "smithy.api#documentation": "Key associated with the metadata in an event.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Left expression of the event metadata filter.
" + } + }, + "com.amazonaws.bedrockagentcore#LinkedAccount": { + "type": "union", + "members": { + "email": { + "target": "com.amazonaws.bedrockagentcore#LinkedAccountEmail", + "traits": { + "smithy.api#documentation": "Email-based linked account.
" + } + }, + "sms": { + "target": "com.amazonaws.bedrockagentcore#LinkedAccountSms", + "traits": { + "smithy.api#documentation": "SMS-based linked account using phone number.
" + } + }, + "developerJwt": { + "target": "com.amazonaws.bedrockagentcore#LinkedAccountDeveloperJwt", + "traits": { + "smithy.api#documentation": "Developer JWT linked account with key ID and subject.
" + } + }, + "oAuth2": { + "target": "com.amazonaws.bedrockagentcore#LinkedAccountOAuth2", + "traits": { + "smithy.api#documentation": "OAuth2 provider linked account (Google, Apple, X, Telegram, GitHub).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents different linked accounts that can be linked to an embedded wallet. Supports email, SMS, JWT, and OAuth2 approaches.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#LinkedAccountDeveloperJwt": { + "type": "structure", + "members": { + "kid": { + "target": "com.amazonaws.bedrockagentcore#JwtKeyId", + "traits": { + "smithy.api#documentation": "The key ID (kid) from the JWT header. Identifies which key was used to sign the JWT.
", + "smithy.api#required": {} + } + }, + "sub": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The subject (sub) claim from the JWT payload. Identifies the principal that is the subject of the JWT.
", + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Authentication method using JWT with key ID and subject claims.
" + } + }, + "com.amazonaws.bedrockagentcore#LinkedAccountEmail": { + "type": "structure", + "members": { + "emailAddress": { + "target": "com.amazonaws.bedrockagentcore#Email", + "traits": { + "smithy.api#documentation": "The email address used for the linked account. Must be a valid email format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Linked account using an email address.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#LinkedAccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#LinkedAccount" + }, + "traits": { + "smithy.api#documentation": "A list of linkedAccount methods linked to an embedded wallet.
", + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentcore#LinkedAccountOAuth2": { + "type": "union", + "members": { + "google": { + "target": "com.amazonaws.bedrockagentcore#OAuth2Authentication", + "traits": { + "smithy.api#documentation": "Google OAuth2 authentication.
" + } + }, + "apple": { + "target": "com.amazonaws.bedrockagentcore#OAuth2Authentication", + "traits": { + "smithy.api#documentation": "Apple OAuth2 authentication.
" + } + }, + "x": { + "target": "com.amazonaws.bedrockagentcore#OAuth2Authentication", + "traits": { + "smithy.api#documentation": "X (formerly Twitter) OAuth2 authentication.
" + } + }, + "telegram": { + "target": "com.amazonaws.bedrockagentcore#OAuth2Authentication", + "traits": { + "smithy.api#documentation": "Telegram OAuth2 authentication.
" + } + }, + "github": { + "target": "com.amazonaws.bedrockagentcore#OAuth2Authentication", + "traits": { + "smithy.api#documentation": "GitHub OAuth2 authentication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Authentication method using OAuth2 providers. Supports Google, Apple, X, Telegram, and GitHub providers.
" + } + }, + "com.amazonaws.bedrockagentcore#LinkedAccountSms": { + "type": "structure", + "members": { + "phoneNumber": { + "target": "com.amazonaws.bedrockagentcore#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number in E.164 format (e.g., +1234567890).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Linked account using a phone number in E.164 format.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#ListABTests": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#ListABTestsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#ListABTestsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all A/B tests in the account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/ab-tests" + }, + "smithy.api#paginated": { + "items": "abTests", + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#ListABTestsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The list of A/B test summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:ListActors permission.
The identifier of the AgentCore Memory resource for which to list actors.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcore#MaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "The maximum number of results to return in a single call. The default value is 20.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#ListActorsOutput": { + "type": "structure", + "members": { + "actorSummaries": { + "target": "com.amazonaws.bedrockagentcore#ActorSummaryList", + "traits": { + "smithy.api#documentation": "The list of actor summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#ListBatchEvaluations": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#ListBatchEvaluationsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#ListBatchEvaluationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration.
", + "smithy.api#http": { + "method": "GET", + "uri": "/evaluations/batch-evaluate" + }, + "smithy.api#paginated": { + "items": "batchEvaluations", + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#ListBatchEvaluationsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The list of batch evaluation summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Retrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.
You can filter the results by browser identifier and session status. The operation supports pagination to handle large result sets efficiently.
We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.
The following operations are related to ListBrowserSessions:
The unique identifier of the browser to list sessions for. If specified, only sessions for this browser are returned. If not specified, sessions for all browsers are returned.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcore#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call. The default value is 10. Valid values range from 1 to 100. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. If not specified, Amazon Bedrock AgentCore returns the first page of results.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionStatus", + "traits": { + "smithy.api#documentation": "The status of the browser sessions to list. Valid values include ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are returned.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#ListBrowserSessionsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionSummaries", + "traits": { + "smithy.api#documentation": "The list of browser sessions that match the specified criteria.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#NextToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent ListBrowserSessions request to get the next set of results.
Retrieves a list of code interpreter sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.
You can filter the results by code interpreter identifier and session status. The operation supports pagination to handle large result sets efficiently.
We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.
The following operations are related to ListCodeInterpreterSessions:
The unique identifier of the code interpreter to list sessions for. If specified, only sessions for this code interpreter are returned. If not specified, sessions for all code interpreters are returned.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcore#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call. The default value is 10. Valid values range from 1 to 100. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. If not specified, Amazon Bedrock AgentCore returns the first page of results.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionStatus", + "traits": { + "smithy.api#documentation": "The status of the code interpreter sessions to list. Valid values include ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are returned.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#ListCodeInterpreterSessionsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionSummaries", + "traits": { + "smithy.api#documentation": "The list of code interpreter sessions that match the specified criteria.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#NextToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent ListCodeInterpreterSessions request to get the next set of results.
Lists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:ListEvents permission.
The identifier of the AgentCore Memory resource for which to list events.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionId", + "traits": { + "smithy.api#documentation": "The identifier of the session for which to list events.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actorId": { + "target": "com.amazonaws.bedrockagentcore#ActorId", + "traits": { + "smithy.api#documentation": "The identifier of the actor for which to list events.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "includePayloads": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": true, + "smithy.api#documentation": "Specifies whether to include event payloads in the response. Set to true to include payloads, or false to exclude them.
" + } + }, + "filter": { + "target": "com.amazonaws.bedrockagentcore#FilterInput", + "traits": { + "smithy.api#documentation": "Filter criteria to apply when listing events.
" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcore#MaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "The maximum number of results to return in a single call. The default value is 20.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#ListEventsOutput": { + "type": "structure", + "members": { + "events": { + "target": "com.amazonaws.bedrockagentcore#EventList", + "traits": { + "smithy.api#documentation": "The list of events that match the specified criteria.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#ListMemoryExtractionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#ListMemoryExtractionJobsInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#ListMemoryExtractionJobsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.
To use this operation, you must have the bedrock-agentcore:ListMemoryExtractionJobs permission.
The unique identifier of the memory to list extraction jobs for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 20, + "smithy.api#documentation": "The maximum number of results to return in a single call. The default value is 20.
", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "filter": { + "target": "com.amazonaws.bedrockagentcore#ExtractionJobFilterInput", + "traits": { + "smithy.api#documentation": "Filter criteria to apply when listing extraction jobs.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#ListMemoryExtractionJobsOutput": { + "type": "structure", + "members": { + "jobs": { + "target": "com.amazonaws.bedrockagentcore#ExtractionJobMetadataList", + "traits": { + "smithy.api#documentation": "List of extraction job metadata matching the specified criteria.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#PaginationToken", + "traits": { + "smithy.api#documentation": "Token to retrieve the next page of results, if available.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#ListMemoryRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#ListMemoryRecordsInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#ListMemoryRecordsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InvalidInputException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists memory records in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:ListMemoryRecords permission.
The identifier of the AgentCore Memory resource for which to list memory records.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.bedrockagentcore#Namespace", + "traits": { + "smithy.api#documentation": "The namespace prefix to filter memory records by. Returns all memory records in namespaces that start with the provided prefix. Either namespace or namespacePath is required.
Use namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy. Either namespace or namespacePath is required.
The memory strategy identifier to filter memory records by. If specified, only memory records with this strategy ID are returned.
" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcore#MaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "The maximum number of results to return in a single call. The default value is 20.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" + } + }, + "metadataFilters": { + "target": "com.amazonaws.bedrockagentcore#MemoryMetadataFilterList", + "traits": { + "smithy.api#documentation": "A list of metadata filter expressions to scope the returned memory records.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#ListMemoryRecordsOutput": { + "type": "structure", + "members": { + "memoryRecordSummaries": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordSummaryList", + "traits": { + "smithy.api#documentation": "The list of memory record summaries that match the specified criteria.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#ListPaymentInstruments": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#ListPaymentInstrumentsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#ListPaymentInstrumentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List payment instruments for a manager.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/payments/listPaymentInstruments" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "paymentInstruments" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#ListPaymentInstrumentsRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID associated with the payment instruments.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-User-Id" + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagentcore#PaymentAgentName", + "traits": { + "smithy.api#documentation": "The agent name associated with this request, used for observability.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-Agent-Name" + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager that owns the payment instruments.
", + "smithy.api#required": {} + } + }, + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcore#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The ID of the payment connector to filter by.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#NextToken", + "traits": { + "smithy.api#documentation": "Token for pagination to retrieve the next set of results.
" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Maximum number of results to return in a single response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Request structure for listing payment instruments.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#ListPaymentInstrumentsResponse": { + "type": "structure", + "members": { + "paymentInstruments": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentSummaryList", + "traits": { + "smithy.api#documentation": "List of payment instrument summaries matching the request criteria.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Token for pagination to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Response structure for listing payment instruments.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#ListPaymentSessions": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#ListPaymentSessionsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#ListPaymentSessionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List payment sessions.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/payments/listPaymentSessions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "paymentSessions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#ListPaymentSessionsRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID associated with the payment sessions.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-User-Id" + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagentcore#PaymentAgentName", + "traits": { + "smithy.api#documentation": "The agent name associated with this request, used for observability.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-Agent-Name" + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager that owns the sessions.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#NextToken", + "traits": { + "smithy.api#documentation": "Token for pagination to retrieve the next set of results.
" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Maximum number of results to return in a single response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Request structure for listing payment sessions.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#ListPaymentSessionsResponse": { + "type": "structure", + "members": { + "paymentSessions": { + "target": "com.amazonaws.bedrockagentcore#PaymentSessionSummaryList", + "traits": { + "smithy.api#documentation": "List of payment session summaries matching the request criteria.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#NextToken", + "traits": { + "smithy.api#documentation": "Token for pagination to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Response structure for listing payment sessions.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#ListRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#ListRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#ListRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all recommendations in the account, with optional filtering by status.
", + "smithy.api#http": { + "method": "GET", + "uri": "/recommendations" + }, + "smithy.api#paginated": { + "items": "recommendationSummaries", + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcore#ListRecommendationsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
Optional filter to return only recommendations with the specified status.
", + "smithy.api#httpQuery": "status" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#ListRecommendationsResponse": { + "type": "structure", + "members": { + "recommendationSummaries": { + "target": "com.amazonaws.bedrockagentcore#RecommendationSummaryList", + "traits": { + "smithy.api#documentation": "The list of recommendation summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
Empty sessions are automatically deleted after one day.
To use this operation, you must have the bedrock-agentcore:ListSessions permission.
The identifier of the AgentCore Memory resource for which to list sessions.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actorId": { + "target": "com.amazonaws.bedrockagentcore#ActorId", + "traits": { + "smithy.api#documentation": "The identifier of the actor for which to list sessions.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcore#MaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "The maximum number of results to return in a single call. The default value is 20.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" + } + }, + "filter": { + "target": "com.amazonaws.bedrockagentcore#SessionFilter", + "traits": { + "smithy.api#documentation": "Filter criteria to apply when listing sessions.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#ListSessionsOutput": { + "type": "structure", + "members": { + "sessionSummaries": { + "target": "com.amazonaws.bedrockagentcore#SessionSummaryList", + "traits": { + "smithy.api#documentation": "The list of session summaries that match the specified criteria.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#LiveViewStream": { + "type": "structure", + "members": { + "streamEndpoint": { + "target": "com.amazonaws.bedrockagentcore#BrowserStreamEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL for the live view stream. This URL is used to establish a connection to receive visual updates from the browser session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a stream that provides a visual representation of a browser session in Amazon Bedrock AgentCore. This stream enables agents to observe the current state of the browser, including rendered web pages, visual elements, and the results of interactions.
" + } + }, + "com.amazonaws.bedrockagentcore#LogGroupArnList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrockagentcore#MaxLenString": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 100000000 + } + } + }, + "com.amazonaws.bedrockagentcore#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcore#MaxTokens": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockagentcore#McpDescriptor": { + "type": "structure", + "members": { + "server": { + "target": "com.amazonaws.bedrockagentcore#ServerDefinition", + "traits": { + "smithy.api#documentation": "The MCP server definition that describes the server configuration.
", + "smithy.api#required": {} + } + }, + "tools": { + "target": "com.amazonaws.bedrockagentcore#ToolsDefinition", + "traits": { + "smithy.api#documentation": "The MCP tools definition that describes the available tools.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The MCP (Model Context Protocol) descriptor configuration for a registry record. Contains the server definition and tools definition.
" + } + }, + "com.amazonaws.bedrockagentcore#MemoryContent": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentcore#SensitiveString", + "traits": { + "smithy.api#documentation": "The text content of the memory record.
", + "smithy.api#length": { + "min": 1, + "max": 16000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the content of a memory record.
" + } + }, + "com.amazonaws.bedrockagentcore#MemoryDocument": { + "type": "document", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#MemoryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12 + }, + "smithy.api#pattern": "^(arn:(aws|aws-cn|aws-us-gov):bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:memory/)?[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#MemoryMetadataFilterExpression": { + "type": "structure", + "members": { + "left": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordLeftExpression", + "traits": { + "smithy.api#documentation": "The metadata key to evaluate.
", + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordOperatorType", + "traits": { + "smithy.api#documentation": "The relationship between the metadata key and value to match when applying the metadata filter.
", + "smithy.api#required": {} + } + }, + "right": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordRightExpression", + "traits": { + "smithy.api#documentation": "The value to compare against. Required for all operators except EXISTS and NOT_EXISTS.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Filters to apply to metadata associated with a memory. Specify the metadata key and value in the left and right fields and use the operator field to define the relationship to match.
The unique identifier of the memory record.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentcore#MemoryContent", + "traits": { + "smithy.api#documentation": "The content of the memory record.
", + "smithy.api#required": {} + } + }, + "memoryStrategyId": { + "target": "com.amazonaws.bedrockagentcore#MemoryStrategyId", + "traits": { + "smithy.api#documentation": "The identifier of the memory strategy associated with this record.
", + "smithy.api#required": {} + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcore#NamespacesList", + "traits": { + "smithy.api#documentation": "The namespaces associated with this memory record. Namespaces help organize and categorize memory records.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the memory record was created.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordMetadataMap", + "traits": { + "smithy.api#documentation": "A map of metadata key-value pairs associated with a memory record.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a memory record in an AgentCore Memory resource.
" + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordCreateInput": { + "type": "structure", + "members": { + "requestIdentifier": { + "target": "com.amazonaws.bedrockagentcore#RequestIdentifier", + "traits": { + "smithy.api#documentation": "A client-provided identifier for tracking this specific record creation request.
", + "smithy.api#required": {} + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcore#NamespacesList", + "traits": { + "smithy.api#documentation": "A list of namespace identifiers that categorize or group the memory record.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentcore#MemoryContent", + "traits": { + "smithy.api#documentation": "The content to be stored within the memory record.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "Time at which the memory record was created.
", + "smithy.api#required": {} + } + }, + "memoryStrategyId": { + "target": "com.amazonaws.bedrockagentcore#MemoryStrategyId", + "traits": { + "smithy.api#documentation": "The ID of the memory strategy that defines how this memory record is grouped.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordMetadataMap", + "traits": { + "smithy.api#documentation": "Metadata key-value pairs to be stored with the memory record.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input structure to create a new memory record.
" + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordDeleteInput": { + "type": "structure", + "members": { + "memoryRecordId": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordId", + "traits": { + "smithy.api#documentation": "The unique ID of the memory record to be deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input structure to delete an existing memory record.
" + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 40, + "max": 50 + }, + "smithy.api#pattern": "^mem-[a-zA-Z0-9-_]*$" + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordLeftExpression": { + "type": "union", + "members": { + "metadataKey": { + "target": "com.amazonaws.bedrockagentcore#MetadataKey", + "traits": { + "smithy.api#documentation": "The metadata key to filter on.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The left-hand side of a memory record metadata filter expression.
" + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordMetadataMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcore#MetadataKey" + }, + "value": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordMetadataValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordMetadataValue": { + "type": "union", + "members": { + "stringValue": { + "target": "com.amazonaws.bedrockagentcore#StringValue", + "traits": { + "smithy.api#documentation": "A string value.
" + } + }, + "stringListValue": { + "target": "com.amazonaws.bedrockagentcore#StringValueList", + "traits": { + "smithy.api#documentation": "A list of string values.
" + } + }, + "numberValue": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "A numeric value.
" + } + }, + "dateTimeValue": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp value in ISO 8601 UTC format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The value of a memory record metadata entry.
" + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordOperatorType": { + "type": "enum", + "members": { + "EQUALS_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS_TO" + } + }, + "EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXISTS" + } + }, + "NOT_EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EXISTS" + } + }, + "BEFORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEFORE" + } + }, + "AFTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFTER" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN" + } + }, + "GREATER_THAN_OR_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN_OR_EQUALS" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN" + } + }, + "LESS_THAN_OR_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN_OR_EQUALS" + } + } + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordOutput": { + "type": "structure", + "members": { + "memoryRecordId": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordId", + "traits": { + "smithy.api#documentation": "The unique ID associated to the memory record.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordStatus", + "traits": { + "smithy.api#documentation": "The status of the memory record operation (e.g., SUCCEEDED, FAILED).
", + "smithy.api#required": {} + } + }, + "requestIdentifier": { + "target": "com.amazonaws.bedrockagentcore#RequestIdentifier", + "traits": { + "smithy.api#documentation": "The client-provided identifier that was used to track this record operation.
" + } + }, + "errorCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The error code returned when the memory record operation fails.
" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A human-readable error message describing why the memory record operation failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Output information returned after processing a memory record operation.
" + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordRightExpression": { + "type": "union", + "members": { + "metadataValue": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordMetadataValue", + "traits": { + "smithy.api#documentation": "The metadata value to compare against.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The right-hand side of a memory record metadata filter expression.
" + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordStatus": { + "type": "enum", + "members": { + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordSummary": { + "type": "structure", + "members": { + "memoryRecordId": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordId", + "traits": { + "smithy.api#documentation": "The unique identifier of the memory record.
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentcore#MemoryContent", + "traits": { + "smithy.api#documentation": "The content of the memory record.
", + "smithy.api#required": {} + } + }, + "memoryStrategyId": { + "target": "com.amazonaws.bedrockagentcore#MemoryStrategyId", + "traits": { + "smithy.api#documentation": "The identifier of the memory strategy associated with this record.
", + "smithy.api#required": {} + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcore#NamespacesList", + "traits": { + "smithy.api#documentation": "The namespaces associated with this memory record.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the memory record was created.
", + "smithy.api#required": {} + } + }, + "score": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The relevance score of the memory record when returned as part of a search result. Higher values indicate greater relevance to the search query.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordMetadataMap", + "traits": { + "smithy.api#documentation": "A map of metadata key-value pairs associated with a memory record.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a memory record.
" + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordSummary" + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordUpdateInput": { + "type": "structure", + "members": { + "memoryRecordId": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordId", + "traits": { + "smithy.api#documentation": "The unique ID of the memory record to be updated.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "Time at which the memory record was updated
", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentcore#MemoryContent", + "traits": { + "smithy.api#documentation": "The content to be stored within the memory record.
" + } + }, + "namespaces": { + "target": "com.amazonaws.bedrockagentcore#NamespacesList", + "traits": { + "smithy.api#documentation": "The updated list of namespace identifiers for categorizing the memory record.
" + } + }, + "memoryStrategyId": { + "target": "com.amazonaws.bedrockagentcore#MemoryStrategyId", + "traits": { + "smithy.api#documentation": "The updated ID of the memory strategy that defines how this memory record is grouped.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordMetadataMap", + "traits": { + "smithy.api#documentation": "Metadata key-value pairs to be stored with the memory record.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input structure to update an existing memory record.
" + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordsCreateInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordCreateInput" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordsDeleteInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordDeleteInput" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordsOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordOutput" + } + }, + "com.amazonaws.bedrockagentcore#MemoryRecordsUpdateInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordUpdateInput" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcore#MemoryResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentcore#BatchCreateMemoryRecords" + }, + { + "target": "com.amazonaws.bedrockagentcore#BatchDeleteMemoryRecords" + }, + { + "target": "com.amazonaws.bedrockagentcore#BatchUpdateMemoryRecords" + }, + { + "target": "com.amazonaws.bedrockagentcore#CreateEvent" + }, + { + "target": "com.amazonaws.bedrockagentcore#DeleteEvent" + }, + { + "target": "com.amazonaws.bedrockagentcore#DeleteMemoryRecord" + }, + { + "target": "com.amazonaws.bedrockagentcore#GetEvent" + }, + { + "target": "com.amazonaws.bedrockagentcore#GetMemoryRecord" + }, + { + "target": "com.amazonaws.bedrockagentcore#ListActors" + }, + { + "target": "com.amazonaws.bedrockagentcore#ListEvents" + }, + { + "target": "com.amazonaws.bedrockagentcore#ListMemoryExtractionJobs" + }, + { + "target": "com.amazonaws.bedrockagentcore#ListMemoryRecords" + }, + { + "target": "com.amazonaws.bedrockagentcore#ListSessions" + }, + { + "target": "com.amazonaws.bedrockagentcore#RetrieveMemoryRecords" + }, + { + "target": "com.amazonaws.bedrockagentcore#StartMemoryExtractionJob" + } + ] + }, + "com.amazonaws.bedrockagentcore#MemoryStrategyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + } + }, + "com.amazonaws.bedrockagentcore#MessageMetadata": { + "type": "structure", + "members": { + "eventId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the event associated with this message.
", + "smithy.api#required": {} + } + }, + "messageIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The position of this message within that event’s ordered list of messages.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata information associated with this message.
" + } + }, + "com.amazonaws.bedrockagentcore#MessagesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#MessageMetadata" + } + }, + "com.amazonaws.bedrockagentcore#MetadataFilterExpression": { + "type": "document", + "traits": { + "smithy.api#documentation": " A JSON document that represents a structured metadata filter expression. Supports field-level operators ($eq, $ne, $in) and logical operators ($and, $or) on filterable fields (name, descriptorType, version).
Value associated with the eventMetadata key.
Value associated with the eventMetadata key.
The mouse button to use for a browser mouse action.
" + } + }, + "com.amazonaws.bedrockagentcore#MouseClickArguments": { + "type": "structure", + "members": { + "x": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The X coordinate on screen where the click occurs.
", + "smithy.api#required": {} + } + }, + "y": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The Y coordinate on screen where the click occurs.
", + "smithy.api#required": {} + } + }, + "button": { + "target": "com.amazonaws.bedrockagentcore#MouseButton", + "traits": { + "smithy.api#documentation": "The mouse button to use. Defaults to LEFT.
The number of clicks to perform. Valid range: 1–10. Defaults to 1.
", + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Arguments for a mouse click action.
" + } + }, + "com.amazonaws.bedrockagentcore#MouseClickResult": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcore#BrowserActionStatus", + "traits": { + "smithy.api#documentation": "The status of the action execution.
", + "smithy.api#required": {} + } + }, + "error": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message. Present only when the action failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a mouse click action.
" + } + }, + "com.amazonaws.bedrockagentcore#MouseDragArguments": { + "type": "structure", + "members": { + "endX": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The ending X coordinate for the drag.
", + "smithy.api#required": {} + } + }, + "endY": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The ending Y coordinate for the drag.
", + "smithy.api#required": {} + } + }, + "startX": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The starting X coordinate for the drag.
", + "smithy.api#required": {} + } + }, + "startY": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The starting Y coordinate for the drag.
", + "smithy.api#required": {} + } + }, + "button": { + "target": "com.amazonaws.bedrockagentcore#MouseButton", + "traits": { + "smithy.api#documentation": "The mouse button to use for the drag. Defaults to LEFT.
Arguments for a mouse drag action.
" + } + }, + "com.amazonaws.bedrockagentcore#MouseDragResult": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcore#BrowserActionStatus", + "traits": { + "smithy.api#documentation": "The status of the action execution.
", + "smithy.api#required": {} + } + }, + "error": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message. Present only when the action failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a mouse drag action.
" + } + }, + "com.amazonaws.bedrockagentcore#MouseMoveArguments": { + "type": "structure", + "members": { + "x": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The target X coordinate on screen.
", + "smithy.api#required": {} + } + }, + "y": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The target Y coordinate on screen.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Arguments for a mouse move action.
" + } + }, + "com.amazonaws.bedrockagentcore#MouseMoveResult": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcore#BrowserActionStatus", + "traits": { + "smithy.api#documentation": "The status of the action execution.
", + "smithy.api#required": {} + } + }, + "error": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message. Present only when the action failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a mouse move action.
" + } + }, + "com.amazonaws.bedrockagentcore#MouseScrollArguments": { + "type": "structure", + "members": { + "x": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The X coordinate on screen where the scroll occurs.
", + "smithy.api#required": {} + } + }, + "y": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The Y coordinate on screen where the scroll occurs.
", + "smithy.api#required": {} + } + }, + "deltaX": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The horizontal scroll delta. Valid range: -1000 to 1000.
", + "smithy.api#range": { + "min": -1000, + "max": 1000 + } + } + }, + "deltaY": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The vertical scroll delta. Valid range: -1000 to 1000. Negative values scroll down.
", + "smithy.api#range": { + "min": -1000, + "max": 1000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Arguments for a mouse scroll action.
" + } + }, + "com.amazonaws.bedrockagentcore#MouseScrollResult": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcore#BrowserActionStatus", + "traits": { + "smithy.api#documentation": "The status of the action execution.
", + "smithy.api#required": {} + } + }, + "error": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message. Present only when the action failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a mouse scroll action.
" + } + }, + "com.amazonaws.bedrockagentcore#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcore#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9/*][a-zA-Z0-9-_/*]*(?::[a-zA-Z0-9-_/*]+)*[a-zA-Z0-9-_/*]*$" + } + }, + "com.amazonaws.bedrockagentcore#NamespacesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#Namespace" + }, + "traits": { + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentcore#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockagentcore#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.bedrockagentcore#OAuth2Authentication": { + "type": "structure", + "members": { + "sub": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The subject (sub) claim from the OAuth2 provider. Uniquely identifies the user at the provider.
", + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#required": {} + } + }, + "emailAddress": { + "target": "com.amazonaws.bedrockagentcore#Email", + "traits": { + "smithy.api#documentation": "The email address from the OAuth2 provider.
" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The user's name from the OAuth2 provider.
", + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "username": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The username from the OAuth2 provider.
", + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + } + }, + "traits": { + "smithy.api#documentation": "OAuth2 authentication information for third-party providers.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#OAuthCredentialProvider": { + "type": "structure", + "members": { + "providerArn": { + "target": "com.amazonaws.bedrockagentcore#OAuthCredentialProviderArn", + "traits": { + "smithy.api#documentation": "The ARN of the OAuth 2.0 credential provider in AgentCore Identity.
", + "smithy.api#required": {} + } + }, + "scopes": { + "target": "com.amazonaws.bedrockagentcore#OAuthScopes", + "traits": { + "smithy.api#documentation": "The OAuth 2.0 scopes to request when obtaining an access token.
", + "smithy.api#required": {} + } + }, + "customParameters": { + "target": "com.amazonaws.bedrockagentcore#OAuthCustomParameters", + "traits": { + "smithy.api#documentation": "Additional custom parameters to include in the OAuth 2.0 token request.
" + } + }, + "grantType": { + "target": "com.amazonaws.bedrockagentcore#OAuthGrantType", + "traits": { + "smithy.api#default": "CLIENT_CREDENTIALS", + "smithy.api#documentation": "The OAuth 2.0 grant type to use for authentication.
" + } + }, + "defaultReturnUrl": { + "target": "com.amazonaws.bedrockagentcore#OAuthDefaultReturnUrl", + "traits": { + "smithy.api#documentation": "The default return URL for the OAuth 2.0 authorization flow.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for an OAuth 2.0 credential provider used to authenticate tool calls.
" + } + }, + "com.amazonaws.bedrockagentcore#OAuthCredentialProviderArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)$" + } + }, + "com.amazonaws.bedrockagentcore#OAuthCustomParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcore#OAuthCustomParametersKey" + }, + "value": { + "target": "com.amazonaws.bedrockagentcore#OAuthCustomParametersValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcore#OAuthCustomParametersKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.bedrockagentcore#OAuthCustomParametersValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#OAuthDefaultReturnUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\w+:(\\/?\\/?)[^\\s]+$" + } + }, + "com.amazonaws.bedrockagentcore#OAuthGrantType": { + "type": "enum", + "members": { + "CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIENT_CREDENTIALS" + } + }, + "AUTHORIZATION_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZATION_CODE" + } + }, + "TOKEN_EXCHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN_EXCHANGE" + } + } + } + }, + "com.amazonaws.bedrockagentcore#OAuthScope": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.bedrockagentcore#OAuthScopes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#OAuthScope" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcore#Oauth2FlowType": { + "type": "enum", + "members": { + "USER_FEDERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_FEDERATION" + } + }, + "M2M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "M2M" + } + }, + "ON_BEHALF_OF_TOKEN_EXCHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_BEHALF_OF_TOKEN_EXCHANGE" + } + } + } + }, + "com.amazonaws.bedrockagentcore#OnlineEvaluationConfigArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::OnlineEvaluationConfig" + }, + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:online-evaluation-config\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#OnlineEvaluationConfigSource": { + "type": "structure", + "members": { + "onlineEvaluationConfigArn": { + "target": "com.amazonaws.bedrockagentcore#OnlineEvaluationConfigArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the online evaluation configuration to use as the session source.
", + "smithy.api#required": {} + } + }, + "timeRange": { + "target": "com.amazonaws.bedrockagentcore#SessionFilterConfig", + "traits": { + "smithy.api#documentation": "Optional session filter configuration to narrow down which sessions from the online evaluation configuration to include.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to an existing online evaluation configuration to use as the data source for batch evaluation.
" + } + }, + "com.amazonaws.bedrockagentcore#OperatorType": { + "type": "enum", + "members": { + "EQUALS_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS_TO" + } + }, + "EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXISTS" + } + }, + "NOT_EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EXISTS" + } + } + } + }, + "com.amazonaws.bedrockagentcore#OutputConfig": { + "type": "union", + "members": { + "cloudWatchConfig": { + "target": "com.amazonaws.bedrockagentcore#CloudWatchOutputConfig", + "traits": { + "smithy.api#documentation": "The CloudWatch Logs configuration for writing evaluation results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Output destination configuration.
" + } + }, + "com.amazonaws.bedrockagentcore#PaginationToken": { + "type": "string" + }, + "com.amazonaws.bedrockagentcore#PathPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagentcore#PayloadType": { + "type": "union", + "members": { + "conversational": { + "target": "com.amazonaws.bedrockagentcore#Conversational", + "traits": { + "smithy.api#documentation": "The conversational content of the payload.
" + } + }, + "blob": { + "target": "com.amazonaws.bedrockagentcore#MemoryDocument", + "traits": { + "smithy.api#documentation": "The binary content of the payload.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the payload content for an event.
" + } + }, + "com.amazonaws.bedrockagentcore#PayloadTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#PayloadType" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcore#PaymentAgentName": { + "type": "string", + "traits": { + "smithy.api#documentation": "The agent name associated with the payment request.
", + "smithy.api#length": { + "max": 256 + } + } + }, + "com.amazonaws.bedrockagentcore#PaymentConnectorId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 211 + }, + "smithy.api#pattern": "^([0-9a-z][-]?){1,100}-[0-9a-z]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#PaymentDocument": { + "type": "document", + "traits": { + "smithy.api#documentation": "Custom document type for payment payloads.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#PaymentHttpMethodType": { + "type": "enum", + "members": { + "GET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GET" + } + }, + "POST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST" + } + }, + "PUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + }, + "PATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PATCH" + } + } + } + }, + "com.amazonaws.bedrockagentcore#PaymentInput": { + "type": "union", + "members": { + "cryptoX402": { + "target": "com.amazonaws.bedrockagentcore#CryptoX402PaymentInput", + "traits": { + "smithy.api#documentation": "Input for a crypto X402 payment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The payment input details, which vary by payment type.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentInstrument": { + "type": "structure", + "members": { + "paymentInstrumentId": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentId", + "traits": { + "smithy.api#documentation": "The unique identifier for this payment instrument.
", + "smithy.api#required": {} + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager that owns this payment instrument.
", + "smithy.api#required": {} + } + }, + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcore#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The ID of the payment connector associated with this instrument.
", + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID associated with this payment instrument.
", + "smithy.api#required": {} + } + }, + "paymentInstrumentType": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentType", + "traits": { + "smithy.api#documentation": "The type of payment instrument (e.g., EMBEDDED_CRYPTO_WALLET).
", + "smithy.api#required": {} + } + }, + "paymentInstrumentDetails": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentDetails", + "traits": { + "smithy.api#documentation": "The details specific to the payment instrument type.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this payment instrument was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentStatus", + "traits": { + "smithy.api#documentation": "The current status of this payment instrument.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this payment instrument was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a payment instrument.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentInstrumentDetails": { + "type": "union", + "members": { + "embeddedCryptoWallet": { + "target": "com.amazonaws.bedrockagentcore#EmbeddedCryptoWallet", + "traits": { + "smithy.api#documentation": "Embedded crypto wallet managed directly by end user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details specific to the instrument type.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentInstrumentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 34, + "max": 34 + }, + "smithy.api#pattern": "^payment-instrument-[0-9a-zA-Z-]{15}$" + } + }, + "com.amazonaws.bedrockagentcore#PaymentInstrumentResource": { + "type": "resource", + "identifiers": { + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn" + }, + "paymentInstrumentId": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcore#CreatePaymentInstrument" + }, + "read": { + "target": "com.amazonaws.bedrockagentcore#GetPaymentInstrument" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcore#DeletePaymentInstrument" + }, + "list": { + "target": "com.amazonaws.bedrockagentcore#ListPaymentInstruments" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentcore#GetPaymentInstrumentBalance" + } + ] + }, + "com.amazonaws.bedrockagentcore#PaymentInstrumentStatus": { + "type": "enum", + "members": { + "INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIATED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of a payment instrument.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentInstrumentSummary": { + "type": "structure", + "members": { + "paymentInstrumentId": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentId", + "traits": { + "smithy.api#documentation": "The unique identifier for this payment instrument.
", + "smithy.api#required": {} + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager that owns this payment instrument.
", + "smithy.api#required": {} + } + }, + "paymentConnectorId": { + "target": "com.amazonaws.bedrockagentcore#PaymentConnectorId", + "traits": { + "smithy.api#documentation": "The ID of the payment connector associated with this instrument.
", + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID associated with this payment instrument.
", + "smithy.api#required": {} + } + }, + "paymentInstrumentType": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentType", + "traits": { + "smithy.api#documentation": "The type of payment instrument (e.g., EMBEDDED_CRYPTO_WALLET).
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentStatus", + "traits": { + "smithy.api#documentation": "The current status of this payment instrument.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this payment instrument was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this payment instrument was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of a payment instrument for list operations.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentInstrumentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentSummary" + } + }, + "com.amazonaws.bedrockagentcore#PaymentInstrumentType": { + "type": "enum", + "members": { + "EMBEDDED_CRYPTO_WALLET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMBEDDED_CRYPTO_WALLET" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of payment instrument.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentManagerArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::PaymentManager" + }, + "smithy.api#length": { + "min": 66, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws|aws-[a-z0-9-]+):bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/[a-z0-9]([a-z0-9-]{0,47}[a-z0-9])?-[a-z0-9]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#PaymentOutput": { + "type": "union", + "members": { + "cryptoX402": { + "target": "com.amazonaws.bedrockagentcore#CryptoX402PaymentOutput", + "traits": { + "smithy.api#documentation": "Output from a crypto X402 payment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The payment output details, which vary by payment type.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentRequestHostType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\.]+$" + } + }, + "com.amazonaws.bedrockagentcore#PaymentRequestPathType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^/[a-zA-Z0-9/_\\-\\.~%?=&]+$" + } + }, + "com.amazonaws.bedrockagentcore#PaymentSession": { + "type": "structure", + "members": { + "paymentSessionId": { + "target": "com.amazonaws.bedrockagentcore#PaymentSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment session.
", + "smithy.api#required": {} + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager that owns this session.
", + "smithy.api#required": {} + } + }, + "limits": { + "target": "com.amazonaws.bedrockagentcore#SessionLimits", + "traits": { + "smithy.api#documentation": "The spending limits for the payment session.
" + } + }, + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID associated with this session.
", + "smithy.api#required": {} + } + }, + "expiryTimeInMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The session expiry time in minutes.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the session was created.
", + "smithy.api#required": {} + } + }, + "availableLimits": { + "target": "com.amazonaws.bedrockagentcore#AvailableLimits", + "traits": { + "smithy.api#documentation": "The current available spending limits.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the session was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A payment session for managing payment transactions.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentSessionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 31, + "max": 31 + }, + "smithy.api#pattern": "^payment-session-[0-9a-zA-Z-]{15}$" + } + }, + "com.amazonaws.bedrockagentcore#PaymentSessionResource": { + "type": "resource", + "identifiers": { + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn" + }, + "paymentSessionId": { + "target": "com.amazonaws.bedrockagentcore#PaymentSessionId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcore#CreatePaymentSession" + }, + "read": { + "target": "com.amazonaws.bedrockagentcore#GetPaymentSession" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcore#DeletePaymentSession" + }, + "list": { + "target": "com.amazonaws.bedrockagentcore#ListPaymentSessions" + } + }, + "com.amazonaws.bedrockagentcore#PaymentSessionStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of a payment session.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentSessionSummary": { + "type": "structure", + "members": { + "paymentSessionId": { + "target": "com.amazonaws.bedrockagentcore#PaymentSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the payment session.
", + "smithy.api#required": {} + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager that owns this session.
", + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID associated with this session.
", + "smithy.api#required": {} + } + }, + "expiryTimeInMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The session expiry time in minutes.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the session was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the session was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a payment session.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentSessionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#PaymentSessionSummary" + } + }, + "com.amazonaws.bedrockagentcore#PaymentStatus": { + "type": "enum", + "members": { + "PROOF_GENERATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROOF_GENERATED" + } + } + }, + "traits": { + "smithy.api#documentation": "Transaction status enum.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentTokenRequestInput": { + "type": "union", + "members": { + "coinbaseCdpTokenRequest": { + "target": "com.amazonaws.bedrockagentcore#CoinbaseCdpTokenRequestInput", + "traits": { + "smithy.api#documentation": "The Coinbase CDP token request.
" + } + }, + "stripePrivyTokenRequest": { + "target": "com.amazonaws.bedrockagentcore#StripePrivyTokenRequestInput", + "traits": { + "smithy.api#documentation": "The Stripe Privy token request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Vendor-specific token request configuration.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentTokenResponseOutput": { + "type": "union", + "members": { + "coinbaseCdpTokenResponse": { + "target": "com.amazonaws.bedrockagentcore#CoinbaseCdpTokenResponseOutput", + "traits": { + "smithy.api#documentation": "The Coinbase CDP token response.
" + } + }, + "stripePrivyTokenResponse": { + "target": "com.amazonaws.bedrockagentcore#StripePrivyTokenResponseOutput", + "traits": { + "smithy.api#documentation": "The Stripe Privy token response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Vendor-specific token response configuration.
" + } + }, + "com.amazonaws.bedrockagentcore#PaymentType": { + "type": "enum", + "members": { + "CRYPTO_X402": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRYPTO_X402" + } + } + }, + "traits": { + "smithy.api#documentation": "Payment type enum.
" + } + }, + "com.amazonaws.bedrockagentcore#PerVariantOnlineEvaluationConfig": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcore#VariantName", + "traits": { + "smithy.api#documentation": "The name of the variant this evaluation configuration applies to.
", + "smithy.api#required": {} + } + }, + "onlineEvaluationConfigArn": { + "target": "com.amazonaws.bedrockagentcore#OnlineEvaluationConfigArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the online evaluation configuration for this variant.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An online evaluation configuration associated with a specific A/B test variant.
" + } + }, + "com.amazonaws.bedrockagentcore#PerVariantOnlineEvaluationConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#PerVariantOnlineEvaluationConfig" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagentcore#PhoneNumber": { + "type": "string", + "traits": { + "smithy.api#documentation": "Phone number in E.164 format (e.g., +1234567890).
", + "smithy.api#length": { + "min": 3, + "max": 16 + }, + "smithy.api#pattern": "^\\+[1-9]\\d{1,14}$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#ProcessPayment": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#ProcessPaymentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#ProcessPaymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Processes a payment using a payment instrument within a payment session.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/payments/processPayment" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#ProcessPaymentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + } + }, + "com.amazonaws.bedrockagentcore#ProcessPaymentRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserId", + "traits": { + "smithy.api#documentation": "The user ID associated with this payment.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-User-Id" + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagentcore#PaymentAgentName", + "traits": { + "smithy.api#documentation": "The agent name associated with this request, used for observability.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Payments-Agent-Name" + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager.
", + "smithy.api#required": {} + } + }, + "paymentSessionId": { + "target": "com.amazonaws.bedrockagentcore#PaymentSessionId", + "traits": { + "smithy.api#documentation": "The ID of the payment session.
", + "smithy.api#required": {} + } + }, + "paymentInstrumentId": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentId", + "traits": { + "smithy.api#documentation": "The ID of the payment instrument to use.
", + "smithy.api#required": {} + } + }, + "paymentType": { + "target": "com.amazonaws.bedrockagentcore#PaymentType", + "traits": { + "smithy.api#documentation": "The type of payment to process.
", + "smithy.api#required": {} + } + }, + "paymentInput": { + "target": "com.amazonaws.bedrockagentcore#PaymentInput", + "traits": { + "smithy.api#documentation": "The payment input details specific to the payment type.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request structure for processing a payment.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#ProcessPaymentResource": { + "type": "resource", + "identifiers": { + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn" + }, + "paymentTransactionId": { + "target": "com.amazonaws.bedrockagentcore#ProcessPaymentId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcore#ProcessPayment" + } + }, + "com.amazonaws.bedrockagentcore#ProcessPaymentResponse": { + "type": "structure", + "members": { + "processPaymentId": { + "target": "com.amazonaws.bedrockagentcore#ProcessPaymentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the processed payment.
", + "smithy.api#required": {} + } + }, + "paymentManagerArn": { + "target": "com.amazonaws.bedrockagentcore#PaymentManagerArn", + "traits": { + "smithy.api#documentation": "The ARN of the payment manager.
", + "smithy.api#required": {} + } + }, + "paymentSessionId": { + "target": "com.amazonaws.bedrockagentcore#PaymentSessionId", + "traits": { + "smithy.api#documentation": "The ID of the payment session used.
", + "smithy.api#required": {} + } + }, + "paymentInstrumentId": { + "target": "com.amazonaws.bedrockagentcore#PaymentInstrumentId", + "traits": { + "smithy.api#documentation": "The ID of the payment instrument used.
", + "smithy.api#required": {} + } + }, + "paymentType": { + "target": "com.amazonaws.bedrockagentcore#PaymentType", + "traits": { + "smithy.api#documentation": "The type of payment processed.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#PaymentStatus", + "traits": { + "smithy.api#documentation": "The status of the payment.
", + "smithy.api#required": {} + } + }, + "paymentOutput": { + "target": "com.amazonaws.bedrockagentcore#PaymentOutput", + "traits": { + "smithy.api#documentation": "The payment output details specific to the payment type.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the payment was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response structure for processing a payment.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#ProgrammingLanguage": { + "type": "enum", + "members": { + "PYTHON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python" + } + }, + "JAVASCRIPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "javascript" + } + }, + "TYPESCRIPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "typescript" + } + } + } + }, + "com.amazonaws.bedrockagentcore#Proxies": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#Proxy" + } + }, + "com.amazonaws.bedrockagentcore#Proxy": { + "type": "union", + "members": { + "externalProxy": { + "target": "com.amazonaws.bedrockagentcore#ExternalProxy", + "traits": { + "smithy.api#documentation": "Configuration for an external customer-managed proxy server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Union type representing different proxy configurations. Currently supports external customer-managed proxies.
" + } + }, + "com.amazonaws.bedrockagentcore#ProxyBypass": { + "type": "structure", + "members": { + "domainPatterns": { + "target": "com.amazonaws.bedrockagentcore#DomainPatterns", + "traits": { + "smithy.api#documentation": "Array of domain patterns that should bypass the proxy. Supports .amazonaws.com for subdomain matching or amazonaws.com for exact domain matching. Requests to these domains connect directly without using any proxy. Maximum 253 characters per pattern.
Configuration for domains that should bypass all proxies and connect directly to the internet. These bypass rules take precedence over all proxy routing rules.
" + } + }, + "com.amazonaws.bedrockagentcore#ProxyConfiguration": { + "type": "structure", + "members": { + "proxies": { + "target": "com.amazonaws.bedrockagentcore#Proxies", + "traits": { + "smithy.api#documentation": "An array of 1-5 proxy server configurations for domain-based routing. Each proxy can specify which domains it handles via domainPatterns, enabling flexible routing of different traffic through different proxies based on destination domain.
Optional configuration for domains that should bypass all proxies and connect directly to their destination, like the internet. Takes precedence over all proxy routing rules.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for routing browser traffic through customer-managed proxy servers. Supports 1-5 proxy servers for domain-based routing and proxy bypass rules.
" + } + }, + "com.amazonaws.bedrockagentcore#ProxyCredentials": { + "type": "union", + "members": { + "basicAuth": { + "target": "com.amazonaws.bedrockagentcore#BasicAuth", + "traits": { + "smithy.api#documentation": "HTTP Basic Authentication credentials (username and password) stored in Amazon Web Services Secrets Manager.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Union type representing different proxy authentication methods. Currently supports HTTP Basic Authentication (username and password).
" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::Recommendation" + }, + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:recommendation/[0-9a-zA-Z_-]{1,48}-[0-9A-Z]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationConfig": { + "type": "union", + "members": { + "systemPromptRecommendationConfig": { + "target": "com.amazonaws.bedrockagentcore#SystemPromptRecommendationConfig", + "traits": { + "smithy.api#documentation": "The configuration for a system prompt recommendation.
" + } + }, + "toolDescriptionRecommendationConfig": { + "target": "com.amazonaws.bedrockagentcore#ToolDescriptionRecommendationConfig", + "traits": { + "smithy.api#documentation": "The configuration for a tool description recommendation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a recommendation, varying by recommendation type.
" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 4096 + } + } + }, + "com.amazonaws.bedrockagentcore#RecommendationErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + } + } + }, + "com.amazonaws.bedrockagentcore#RecommendationErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagentcore#RecommendationEvaluationConfig": { + "type": "structure", + "members": { + "evaluators": { + "target": "com.amazonaws.bedrockagentcore#RecommendationEvaluatorList", + "traits": { + "smithy.api#documentation": "The list of evaluators to use for assessing recommendation quality.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The evaluation configuration for assessing recommendation quality.
" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationEvaluatorList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#RecommendationEvaluatorReference" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationEvaluatorReference": { + "type": "structure", + "members": { + "evaluatorArn": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the evaluator.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to an evaluator used for recommendation assessment.
" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationExplanation": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 4096 + } + } + }, + "com.amazonaws.bedrockagentcore#RecommendationId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,48}-[0-9A-Z]{10}$" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_-]{0,47}$" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationResult": { + "type": "union", + "members": { + "systemPromptRecommendationResult": { + "target": "com.amazonaws.bedrockagentcore#SystemPromptRecommendationResult", + "traits": { + "smithy.api#documentation": "The result of a system prompt recommendation.
" + } + }, + "toolDescriptionRecommendationResult": { + "target": "com.amazonaws.bedrockagentcore#ToolDescriptionRecommendationResult", + "traits": { + "smithy.api#documentation": "The result of a tool description recommendation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a recommendation, containing the optimized output.
" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationResultConfigurationBundle": { + "type": "structure", + "members": { + "bundleArn": { + "target": "com.amazonaws.bedrockagentcore#ConfigurationBundleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "versionId": { + "target": "com.amazonaws.bedrockagentcore#ConfigurationBundleVersionId", + "traits": { + "smithy.api#documentation": "The version identifier of the configuration bundle containing the recommendation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A configuration bundle reference in a recommendation result.
" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + }, + "traits": { + "smithy.api#documentation": "The lifecycle status of a recommendation.
" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationSummary": { + "type": "structure", + "members": { + "recommendationId": { + "target": "com.amazonaws.bedrockagentcore#RecommendationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the recommendation.
", + "smithy.api#required": {} + } + }, + "recommendationArn": { + "target": "com.amazonaws.bedrockagentcore#RecommendationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommendation.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#RecommendationName", + "traits": { + "smithy.api#documentation": "The name of the recommendation.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#RecommendationDescription", + "traits": { + "smithy.api#documentation": "The description of the recommendation.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcore#RecommendationType", + "traits": { + "smithy.api#documentation": "The type of recommendation.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#RecommendationStatus", + "traits": { + "smithy.api#documentation": "The current status of the recommendation.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the recommendation was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the recommendation was last updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a recommendation.
" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#RecommendationSummary" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationToolName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\.]+$" + } + }, + "com.amazonaws.bedrockagentcore#RecommendationType": { + "type": "enum", + "members": { + "SYSTEM_PROMPT_RECOMMENDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM_PROMPT_RECOMMENDATION" + } + }, + "TOOL_DESCRIPTION_RECOMMENDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOOL_DESCRIPTION_RECOMMENDATION" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of recommendation to generate.
" + } + }, + "com.amazonaws.bedrockagentcore#RegistryArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}$" + } + }, + "com.amazonaws.bedrockagentcore#RegistryIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#RegistryIdentifier" + } + }, + "com.amazonaws.bedrockagentcore#RegistryIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/)?[a-zA-Z0-9]{12,16}$" + } + }, + "com.amazonaws.bedrockagentcore#RegistryRecordArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/[a-zA-Z0-9]{12}$" + } + }, + "com.amazonaws.bedrockagentcore#RegistryRecordId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{12}$" + } + }, + "com.amazonaws.bedrockagentcore#RegistryRecordName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-\\.\\/]*$" + } + }, + "com.amazonaws.bedrockagentcore#RegistryRecordResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentcore#SearchRegistryRecords" + } + ] + }, + "com.amazonaws.bedrockagentcore#RegistryRecordStatus": { + "type": "enum", + "members": { + "DRAFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRAFT" + } + }, + "PENDING_APPROVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_APPROVAL" + } + }, + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPROVED" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + }, + "DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATED" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of a registry record in its lifecycle.
" + } + }, + "com.amazonaws.bedrockagentcore#RegistryRecordSummary": { + "type": "structure", + "members": { + "registryArn": { + "target": "com.amazonaws.bedrockagentcore#RegistryArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the registry that this record belongs to.
", + "smithy.api#required": {} + } + }, + "recordArn": { + "target": "com.amazonaws.bedrockagentcore#RegistryRecordArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the registry record.
", + "smithy.api#required": {} + } + }, + "recordId": { + "target": "com.amazonaws.bedrockagentcore#RegistryRecordId", + "traits": { + "smithy.api#documentation": "The unique identifier of the registry record.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#RegistryRecordName", + "traits": { + "smithy.api#documentation": "The name of the registry record.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#Description", + "traits": { + "smithy.api#documentation": "A description of the registry record.
" + } + }, + "descriptorType": { + "target": "com.amazonaws.bedrockagentcore#DescriptorType", + "traits": { + "smithy.api#documentation": "The type of descriptor associated with this registry record.
", + "smithy.api#required": {} + } + }, + "descriptors": { + "target": "com.amazonaws.bedrockagentcore#Descriptors", + "traits": { + "smithy.api#documentation": "The descriptor configurations for this registry record.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagentcore#RegistryRecordVersion", + "traits": { + "smithy.api#documentation": "The version of the registry record.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#RegistryRecordStatus", + "traits": { + "smithy.api#documentation": "The current status of the registry record.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the registry record was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the registry record was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a registry record.
" + } + }, + "com.amazonaws.bedrockagentcore#RegistryRecordSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#RegistryRecordSummary" + } + }, + "com.amazonaws.bedrockagentcore#RegistryRecordVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9.-]+$" + } + }, + "com.amazonaws.bedrockagentcore#RequestIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 80 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.bedrockagentcore#RequestUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^urn:ietf:params:oauth:request_uri:[a-zA-Z0-9-._~]+$" + } + }, + "com.amazonaws.bedrockagentcore#ResourceContent": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentcore#ResourceContentType", + "traits": { + "smithy.api#documentation": "The type of resource content.
", + "smithy.api#required": {} + } + }, + "uri": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The URI of the resource content.
" + } + }, + "mimeType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The MIME type of the resource content.
" + } + }, + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text resource content.
" + } + }, + "blob": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "The binary resource content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about resource content.
" + } + }, + "com.amazonaws.bedrockagentcore#ResourceContentType": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "text" + } + }, + "BLOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blob" + } + } + } + }, + "com.amazonaws.bedrockagentcore#ResourceLocation": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagentcore#S3Location", + "traits": { + "smithy.api#documentation": "The Amazon S3 location of the resource. Use this when the resource is stored in an Amazon S3 bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location of the browser extension.
" + } + }, + "com.amazonaws.bedrockagentcore#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcore#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrockagentcore#ResourceOauth2ReturnUrlType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\w+:(\\/?\\/?)[^\\s]+$" + } + }, + "com.amazonaws.bedrockagentcore#ResourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagentcore#ResourcesListType": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ResourceType" + } + }, + "com.amazonaws.bedrockagentcore#ResponseChunk": { + "type": "structure", + "members": { + "contentStart": { + "target": "com.amazonaws.bedrockagentcore#ContentStartEvent", + "traits": { + "smithy.api#documentation": "An event indicating the start of content streaming from the command execution. This is the first chunk received.
" + } + }, + "contentDelta": { + "target": "com.amazonaws.bedrockagentcore#ContentDeltaEvent", + "traits": { + "smithy.api#documentation": "An event containing incremental output (stdout or stderr) from the command execution. These are the middle chunks.
" + } + }, + "contentStop": { + "target": "com.amazonaws.bedrockagentcore#ContentStopEvent", + "traits": { + "smithy.api#documentation": "An event indicating the completion of the command execution, including the exit code and final status. This is the last chunk received.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure representing a response chunk that contains exactly one of the possible event types: contentStart, contentDelta, or contentStop.
Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:RetrieveMemoryRecords permission.
The identifier of the AgentCore Memory resource from which to retrieve memory records.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.bedrockagentcore#Namespace", + "traits": { + "smithy.api#documentation": "The namespace prefix to filter memory records by. Searches for memory records in namespaces that start with the provided prefix. Either namespace or namespacePath is required.
Use namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy. Either namespace or namespacePath is required.
The search criteria to use for finding relevant memory records. This includes the search query, memory strategy ID, and other search parameters.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentcore#MaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "The maximum number of results to return in a single call. The default value is 20.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#RetrieveMemoryRecordsOutput": { + "type": "structure", + "members": { + "memoryRecordSummaries": { + "target": "com.amazonaws.bedrockagentcore#MemoryRecordSummaryList", + "traits": { + "smithy.api#documentation": "The list of memory record summaries that match the search criteria, ordered by relevance.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentcore#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#RetryableConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.bedrockagentcore#RightExpression": { + "type": "union", + "members": { + "metadataValue": { + "target": "com.amazonaws.bedrockagentcore#MetadataValue", + "traits": { + "smithy.api#documentation": "Value associated with the key in eventMetadata.
Right expression of the eventMetadatafilter.
The unique identifier of the root cause cluster.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the root cause cluster.
", + "smithy.api#required": {} + } + }, + "rootCause": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The root cause explanation for this cluster of failures.
", + "smithy.api#required": {} + } + }, + "recommendation": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The recommended fix for this root cause.
", + "smithy.api#required": {} + } + }, + "affectedSessionCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of sessions affected by this root cause.
", + "smithy.api#required": {} + } + }, + "affectedSessions": { + "target": "com.amazonaws.bedrockagentcore#AffectedSessionList", + "traits": { + "smithy.api#documentation": "The list of sessions affected by this root cause.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A cluster of similar root causes identified within a failure subcategory.
" + } + }, + "com.amazonaws.bedrockagentcore#RootCauseClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#RootCauseCluster" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.bedrockagentcore#RuntimeClientError": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcore#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.
", + "smithy.api#error": "client", + "smithy.api#httpError": 424 + } + }, + "com.amazonaws.bedrockagentcore#S3FilesAccessPointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}$" + } + }, + "com.amazonaws.bedrockagentcore#S3FilesConfiguration": { + "type": "structure", + "members": { + "accessPointArn": { + "target": "com.amazonaws.bedrockagentcore#S3FilesAccessPointArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Simple Storage Service (Amazon S3) Files access point to mount.
", + "smithy.api#required": {} + } + }, + "mountPath": { + "target": "com.amazonaws.bedrockagentcore#MountPath", + "traits": { + "smithy.api#documentation": "The absolute path within the session at which the access point is mounted, for example /mnt/s3data. Each mount path must be unique across all file system configurations in the session.
The Amazon Resource Name (ARN) of the Amazon Simple Storage Service (Amazon S3) Files file system that owns the access point.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for mounting an Amazon Simple Storage Service (Amazon S3) Files access point that you own into a session.
" + } + }, + "com.amazonaws.bedrockagentcore#S3FilesFileSystemArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Simple Storage Service (Amazon S3) Files file system. The access points you specify must belong to this file system.
", + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:s3files:[a-z0-9-]+:[0-9]{12}:file-system/fs-[0-9a-f]{17,40}$" + } + }, + "com.amazonaws.bedrockagentcore#S3Location": { + "type": "structure", + "members": { + "bucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket where the resource is stored.
", + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][a-z0-9.-]*[a-z0-9]$", + "smithy.api#required": {} + } + }, + "prefix": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 prefix/key where the resource is stored.
", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#required": {} + } + }, + "versionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 version ID where the resource is stored (Optional).
", + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location configuration of a resource.
" + } + }, + "com.amazonaws.bedrockagentcore#SaveBrowserSessionProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#SaveBrowserSessionProfileRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#SaveBrowserSessionProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Saves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore. A browser profile captures persistent browser data such as cookies and local storage from an active session, enabling you to reuse this data in future browser sessions.
To save a browser session profile, you must specify the profile identifier, browser identifier, and session ID. The session must be active when saving the profile. Once saved, the profile can be used with the StartBrowserSession operation to initialize new sessions with the stored browser state.
Browser profiles are useful for scenarios that require persistent authentication, maintaining user preferences across sessions, or continuing tasks that depend on previously stored browser data.
The following operations are related to SaveBrowserSessionProfile:
The trace identifier for request tracking.
", + "smithy.api#httpHeader": "X-Amzn-Trace-Id", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "traceParent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The parent trace information for distributed tracing.
", + "smithy.api#httpHeader": "traceparent", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "profileIdentifier": { + "target": "com.amazonaws.bedrockagentcore#BrowserProfileId", + "traits": { + "smithy.api#documentation": "The unique identifier for the browser profile. This identifier is used to reference the profile when starting new browser sessions. The identifier must follow the pattern of an alphanumeric name (up to 48 characters) followed by a hyphen and a 10-character alphanumeric suffix.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "browserIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser associated with the session from which to save the profile.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser session from which to save the profile. The session must be active when saving the profile.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#SaveBrowserSessionProfileResponse": { + "type": "structure", + "members": { + "profileIdentifier": { + "target": "com.amazonaws.bedrockagentcore#BrowserProfileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the saved browser profile.
", + "smithy.api#required": {} + } + }, + "browserIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser associated with the session from which the profile was saved.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser session from which the profile was saved.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser profile was last updated. This value is in ISO 8601 format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#SchemaVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.bedrockagentcore#ScopeType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.bedrockagentcore#ScopesListType": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ScopeType" + } + }, + "com.amazonaws.bedrockagentcore#ScreenshotArguments": { + "type": "structure", + "members": { + "format": { + "target": "com.amazonaws.bedrockagentcore#ScreenshotFormat", + "traits": { + "smithy.api#documentation": "The image format for the screenshot. Defaults to PNG.
Arguments for a screenshot action.
" + } + }, + "com.amazonaws.bedrockagentcore#ScreenshotFormat": { + "type": "enum", + "members": { + "PNG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PNG" + } + } + }, + "traits": { + "smithy.api#documentation": "The image format for a browser screenshot.
" + } + }, + "com.amazonaws.bedrockagentcore#ScreenshotResult": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockagentcore#BrowserActionStatus", + "traits": { + "smithy.api#documentation": "The status of the action execution.
", + "smithy.api#required": {} + } + }, + "error": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message. Present only when the action failed.
" + } + }, + "data": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "The base64-encoded image data. Present only when the action succeeded.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a screenshot action.
" + } + }, + "com.amazonaws.bedrockagentcore#SearchCriteria": { + "type": "structure", + "members": { + "searchQuery": { + "target": "com.amazonaws.bedrockagentcore#SensitiveString", + "traits": { + "smithy.api#documentation": "The search query to use for finding relevant memory records.
", + "smithy.api#length": { + "min": 1, + "max": 10000 + }, + "smithy.api#required": {} + } + }, + "memoryStrategyId": { + "target": "com.amazonaws.bedrockagentcore#MemoryStrategyId", + "traits": { + "smithy.api#documentation": "The memory strategy identifier to filter memory records by.
" + } + }, + "topK": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "The maximum number of top-scoring memory records to return. This value is used for semantic search ranking.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "metadataFilters": { + "target": "com.amazonaws.bedrockagentcore#MemoryMetadataFilterList", + "traits": { + "smithy.api#documentation": "Filters to apply to metadata associated with a memory.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains search criteria for retrieving memory records.
" + } + }, + "com.amazonaws.bedrockagentcore#SearchRegistryRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#SearchRegistryRecordsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#SearchRegistryRecordsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Searches for registry records using semantic, lexical, or hybrid queries. Returns metadata for matching records ordered by relevance within the specified registry.
", + "smithy.api#http": { + "method": "POST", + "uri": "/registry-records/search", + "code": 200 + } + } + }, + "com.amazonaws.bedrockagentcore#SearchRegistryRecordsRequest": { + "type": "structure", + "members": { + "searchQuery": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The search query to find matching registry records.
", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#required": {} + } + }, + "registryIds": { + "target": "com.amazonaws.bedrockagentcore#RegistryIdList", + "traits": { + "smithy.api#documentation": "The list of registry identifiers to search within. Currently, you can specify exactly one registry identifier. You can provide either the full Amazon Web Services Resource Name (ARN) or the 12-character alphanumeric registry ID.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "The maximum number of records to return in a single call. Valid values are 1 through 20. The default value is 10.
", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "filters": { + "target": "com.amazonaws.bedrockagentcore#MetadataFilterExpression", + "traits": { + "smithy.api#documentation": " A metadata filter expression to narrow search results. Uses structured JSON operators including field-level operators ($eq, $ne, $in) and logical operators ($and, $or) on filterable fields (name, descriptorType, version). For example, to filter by descriptor type: {\"descriptorType\": {\"$eq\": \"MCP\"}}. To combine filters: {\"$and\": [{\"descriptorType\": {\"$eq\": \"MCP\"}}, {\"name\": {\"$eq\": \"my-tool\"}}]}.
The list of registry records that match the search query, ordered by relevance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#SecretArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[a-z-]+)?:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+$" + } + }, + "com.amazonaws.bedrockagentcore#SecretsManagerLocation": { + "type": "structure", + "members": { + "secretArn": { + "target": "com.amazonaws.bedrockagentcore#SecretArn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Web Services Secrets Manager secret containing the certificate.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon Web Services Secrets Manager location configuration.
" + } + }, + "com.amazonaws.bedrockagentcore#SensitiveJson": { + "type": "document", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#SensitiveText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#ServerDefinition": { + "type": "structure", + "members": { + "schemaVersion": { + "target": "com.amazonaws.bedrockagentcore#SchemaVersion", + "traits": { + "smithy.api#documentation": "The schema version of the MCP server configuration. The schema version identifies the format of the server definition content.
" + } + }, + "inlineContent": { + "target": "com.amazonaws.bedrockagentcore#InlineContent", + "traits": { + "smithy.api#documentation": "The inline content of the server definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": " The MCP server definition with a schema version and inline content. The schemaVersion identifies the version of the MCP server configuration schema.
The service encountered an internal error. Try your request again later.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockagentcore#ServiceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.bedrockagentcore#ServiceNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ServiceName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcore#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.bedrockagentcore#SessionFilter": { + "type": "structure", + "members": { + "eventFilter": { + "target": "com.amazonaws.bedrockagentcore#EventFilterCondition", + "traits": { + "smithy.api#documentation": "The event filter condition to apply. Use this to filter sessions based on event presence.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains filter criteria for listing sessions.
" + } + }, + "com.amazonaws.bedrockagentcore#SessionFilterConfig": { + "type": "structure", + "members": { + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the time range. Only sessions with activity at or after this timestamp are included.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the time range. Only sessions with activity before this timestamp are included.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "A time range filter for selecting sessions. Specifies the start and end times to narrow down which sessions are included.
" + } + }, + "com.amazonaws.bedrockagentcore#SessionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + } + }, + "com.amazonaws.bedrockagentcore#SessionLimits": { + "type": "structure", + "members": { + "maxSpendAmount": { + "target": "com.amazonaws.bedrockagentcore#Amount", + "traits": { + "smithy.api#documentation": "The maximum amount that can be spent in the session.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The spending limits configuration for a payment session.
" + } + }, + "com.amazonaws.bedrockagentcore#SessionMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#SessionMetadataShape" + }, + "traits": { + "smithy.api#length": { + "max": 500 + } + } + }, + "com.amazonaws.bedrockagentcore#SessionMetadataShape": { + "type": "structure", + "members": { + "sessionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the session this metadata applies to.
", + "smithy.api#required": {} + } + }, + "testScenarioId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "An optional test scenario identifier for categorizing and tracking evaluation results.
" + } + }, + "groundTruth": { + "target": "com.amazonaws.bedrockagentcore#GroundTruthSource", + "traits": { + "smithy.api#documentation": "The ground truth data for this session, including expected responses and assertions.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentcore#StringMap", + "traits": { + "smithy.api#documentation": "Additional key-value metadata associated with this session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for a specific session in a batch evaluation, including ground truth data and test scenario identifiers.
" + } + }, + "com.amazonaws.bedrockagentcore#SessionStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrockagentcore#SessionSummary": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the session.
", + "smithy.api#required": {} + } + }, + "actorId": { + "target": "com.amazonaws.bedrockagentcore#ActorId", + "traits": { + "smithy.api#documentation": "The identifier of the actor associated with the session.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the session was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a session in an AgentCore Memory resource.
" + } + }, + "com.amazonaws.bedrockagentcore#SessionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#SessionSummary" + } + }, + "com.amazonaws.bedrockagentcore#SessionType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 33, + "max": 256 + } + } + }, + "com.amazonaws.bedrockagentcore#SkillDefinition": { + "type": "structure", + "members": { + "schemaVersion": { + "target": "com.amazonaws.bedrockagentcore#SchemaVersion", + "traits": { + "smithy.api#documentation": "The schema version of the skill definition. If you don't specify a version, the service detects it automatically.
" + } + }, + "inlineContent": { + "target": "com.amazonaws.bedrockagentcore#InlineContent", + "traits": { + "smithy.api#documentation": "The inline content of the skill definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structured skill definition with a schema version and inline content.
" + } + }, + "com.amazonaws.bedrockagentcore#SkillMdDefinition": { + "type": "structure", + "members": { + "inlineContent": { + "target": "com.amazonaws.bedrockagentcore#InlineContent", + "traits": { + "smithy.api#documentation": "The inline markdown content of the skill definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The skill markdown definition for agent skills descriptors.
" + } + }, + "com.amazonaws.bedrockagentcore#Span": { + "type": "document" + }, + "com.amazonaws.bedrockagentcore#SpanContext": { + "type": "structure", + "members": { + "sessionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": " The unique identifier of the session containing this span. Sessions represent complete conversation flows and are detected using configurable SessionTimeoutMinutes (default 15 minutes).
The unique identifier of the trace containing this span. Traces represent individual request-response interactions within a session and group related spans together.
" + } + }, + "spanId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the specific span being referenced. Spans represent individual operations like tool calls, model invocations, or other discrete actions within the agent's execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The contextual information that uniquely identifies a span within the distributed tracing system. Contains session, trace, and span identifiers used to correlate evaluation results with specific agent execution points.
" + } + }, + "com.amazonaws.bedrockagentcore#SpanId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 16 + } + } + }, + "com.amazonaws.bedrockagentcore#SpanIds": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#SpanId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcore#Spans": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#Span" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#StartBatchEvaluation": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#StartBatchEvaluationRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#StartBatchEvaluationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a batch evaluation job that evaluates agent performance across multiple sessions. Batch evaluations pull agent traces from CloudWatch Logs or an existing online evaluation configuration and run specified evaluators and insights against them.
", + "smithy.api#http": { + "method": "POST", + "uri": "/evaluations/batch-evaluate", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#StartBatchEvaluationRequest": { + "type": "structure", + "members": { + "batchEvaluationName": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationName", + "traits": { + "smithy.api#documentation": "The name of the batch evaluation. Must be unique within your account.
", + "smithy.api#required": {} + } + }, + "evaluators": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorList", + "traits": { + "smithy.api#documentation": "The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.
", + "smithy.api#length": { + "max": 10 + } + } + }, + "insights": { + "target": "com.amazonaws.bedrockagentcore#InsightList", + "traits": { + "smithy.api#documentation": "The list of insight analyses to run against sessions during the batch evaluation. Maximum of 10 insights.
", + "smithy.api#length": { + "max": 10 + } + } + }, + "dataSourceConfig": { + "target": "com.amazonaws.bedrockagentcore#DataSourceConfig", + "traits": { + "smithy.api#documentation": "The data source configuration that specifies where to pull agent session traces from for evaluation.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "evaluationMetadata": { + "target": "com.amazonaws.bedrockagentcore#EvaluationMetadata", + "traits": { + "smithy.api#documentation": "Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcore#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to associate with the batch evaluation.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcore#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key used to encrypt evaluation data. If provided, customer data is encrypted at rest with the specified key.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationDescription", + "traits": { + "smithy.api#documentation": "The description of the batch evaluation.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#StartBatchEvaluationResponse": { + "type": "structure", + "members": { + "batchEvaluationId": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created batch evaluation.
", + "smithy.api#required": {} + } + }, + "batchEvaluationArn": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created batch evaluation.
", + "smithy.api#required": {} + } + }, + "batchEvaluationName": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationName", + "traits": { + "smithy.api#documentation": "The name of the batch evaluation.
", + "smithy.api#required": {} + } + }, + "evaluators": { + "target": "com.amazonaws.bedrockagentcore#EvaluatorList", + "traits": { + "smithy.api#documentation": "The list of evaluators applied during the batch evaluation.
" + } + }, + "insights": { + "target": "com.amazonaws.bedrockagentcore#InsightList", + "traits": { + "smithy.api#documentation": "The list of insight analyses applied during the batch evaluation.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationStatus", + "traits": { + "smithy.api#documentation": "The status of the batch evaluation.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the batch evaluation was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "outputConfig": { + "target": "com.amazonaws.bedrockagentcore#OutputConfig", + "traits": { + "smithy.api#documentation": "The output configuration specifying where evaluation results are written.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcore#TagsMap", + "traits": { + "smithy.api#documentation": "The tags associated with the batch evaluation.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcore#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key used to encrypt evaluation data.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationDescription", + "traits": { + "smithy.api#documentation": "The description of the batch evaluation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#StartBrowserSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#StartBrowserSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#StartBrowserSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates and initializes a browser session in Amazon Bedrock AgentCore. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation.
To create a session, you must specify a browser identifier and a name. You can also configure the viewport dimensions to control the visible area of web content. The session remains active until it times out or you explicitly stop it using the StopBrowserSession operation.
The following operations are related to StartBrowserSession:
The trace identifier for request tracking.
", + "smithy.api#httpHeader": "X-Amzn-Trace-Id", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "traceParent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The parent trace information for distributed tracing.
", + "smithy.api#httpHeader": "traceparent", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "browserIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser to use for this session. This identifier specifies which browser environment to initialize for the session.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#Name", + "traits": { + "smithy.api#documentation": "The name of the browser session. This name helps you identify and manage the session. The name does not need to be unique.
" + } + }, + "sessionTimeoutSeconds": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionTimeout", + "traits": { + "smithy.api#default": 3600, + "smithy.api#documentation": "The duration in seconds (time-to-live) after which the session automatically terminates, regardless of ongoing activity. Defaults to 3600 seconds (1 hour). Recommended minimum: 60 seconds. Maximum allowed: 28,800 seconds (8 hours).
" + } + }, + "viewPort": { + "target": "com.amazonaws.bedrockagentcore#ViewPort", + "traits": { + "smithy.api#documentation": "The dimensions of the browser viewport for this session. This determines the visible area of the web content and affects how web pages are rendered. If not specified, Amazon Bedrock AgentCore uses a default viewport size.
" + } + }, + "extensions": { + "target": "com.amazonaws.bedrockagentcore#BrowserExtensions", + "traits": { + "smithy.api#documentation": "A list of browser extensions to load into the browser session.
" + } + }, + "profileConfiguration": { + "target": "com.amazonaws.bedrockagentcore#BrowserProfileConfiguration", + "traits": { + "smithy.api#documentation": "The browser profile configuration to use for this session. A browser profile contains persistent data such as cookies and local storage that can be reused across multiple browser sessions. If specified, the session initializes with the profile's stored data, enabling continuity for tasks that require authentication or personalized settings.
" + } + }, + "proxyConfiguration": { + "target": "com.amazonaws.bedrockagentcore#ProxyConfiguration", + "traits": { + "smithy.api#documentation": "Optional proxy configuration for routing browser traffic through customer-specified proxy servers. When provided, enables HTTP Basic authentication via Amazon Web Services Secrets Manager and domain-based routing rules. Requires secretsmanager:GetSecretValue IAM permission for the specified secret ARNs.
A list of files containing enterprise policies for the browser.
" + } + }, + "certificates": { + "target": "com.amazonaws.bedrockagentcore#Certificates", + "traits": { + "smithy.api#documentation": "A list of certificates to install in the browser session.
" + } + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcore#ToolsFileSystemConfigurations", + "traits": { + "smithy.api#documentation": "The file system configurations to mount into the browser session. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your session can then read and write your data. If you don't specify this field, no additional file systems are mounted.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#StartBrowserSessionResponse": { + "type": "structure", + "members": { + "browserIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the browser.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created browser session.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the browser session was created.
", + "smithy.api#required": {} + } + }, + "streams": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionStream", + "traits": { + "smithy.api#documentation": "The streams associated with this browser session. These include the automation stream and live view stream.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#StartCodeInterpreterSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#StartCodeInterpreterSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#StartCodeInterpreterSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates and initializes a code interpreter session in Amazon Bedrock AgentCore. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.
To create a session, you must specify a code interpreter identifier and a name. The session remains active until it times out or you explicitly stop it using the StopCodeInterpreterSession operation.
The following operations are related to StartCodeInterpreterSession:
The trace identifier for request tracking.
", + "smithy.api#httpHeader": "X-Amzn-Trace-Id", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "traceParent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The parent trace information for distributed tracing.
", + "smithy.api#httpHeader": "traceparent", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "codeInterpreterIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the code interpreter to use for this session. This identifier specifies which code interpreter environment to initialize for the session.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#Name", + "traits": { + "smithy.api#documentation": "The name of the code interpreter session. This name helps you identify and manage the session. The name does not need to be unique.
" + } + }, + "sessionTimeoutSeconds": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionTimeout", + "traits": { + "smithy.api#default": 900, + "smithy.api#documentation": "The duration in seconds (time-to-live) after which the session automatically terminates, regardless of ongoing activity. Defaults to 900 seconds (15 minutes). Recommended minimum: 60 seconds. Maximum allowed: 28,800 seconds (8 hours).
" + } + }, + "certificates": { + "target": "com.amazonaws.bedrockagentcore#Certificates", + "traits": { + "smithy.api#documentation": "A list of certificates to install in the code interpreter session.
" + } + }, + "filesystemConfigurations": { + "target": "com.amazonaws.bedrockagentcore#ToolsFileSystemConfigurations", + "traits": { + "smithy.api#documentation": "The file system configurations to mount into the code interpreter session. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your session can then read and write your data. If you don't specify this field, no additional file systems are mounted.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#StartCodeInterpreterSessionResponse": { + "type": "structure", + "members": { + "codeInterpreterIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the code interpreter.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created code interpreter session.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the code interpreter session was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#StartMemoryExtractionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#StartMemoryExtractionJobInput" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#StartMemoryExtractionJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottledException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records. When earlier extraction attempts have left events unprocessed, this job will pick up and extract those as well.
To use this operation, you must have the bedrock-agentcore:StartMemoryExtractionJob permission.
The unique identifier of the memory for which to start extraction jobs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "extractionJob": { + "target": "com.amazonaws.bedrockagentcore#ExtractionJob", + "traits": { + "smithy.api#documentation": "Extraction job to start in this operation.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotent processing of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#StartMemoryExtractionJobOutput": { + "type": "structure", + "members": { + "jobId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Extraction Job ID that was attempted to start.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#StartRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#StartRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#StartRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.
", + "smithy.api#http": { + "method": "POST", + "uri": "/recommendations", + "code": 202 + } + } + }, + "com.amazonaws.bedrockagentcore#StartRecommendationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcore#RecommendationName", + "traits": { + "smithy.api#documentation": "The name of the recommendation. Must be unique within your account.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#RecommendationDescription", + "traits": { + "smithy.api#documentation": "The description of the recommendation.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcore#RecommendationType", + "traits": { + "smithy.api#documentation": "The type of recommendation to generate. Valid values are SYSTEM_PROMPT_RECOMMENDATION for system prompt optimization or TOOL_DESCRIPTION_RECOMMENDATION for tool description optimization.
The configuration for the recommendation, including the input to optimize, agent traces to analyze, and evaluation settings.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagentcore#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key used to encrypt recommendation data. If provided, customer data is encrypted at rest with the specified key.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcore#TagsMap", + "traits": { + "smithy.api#documentation": "A map of tag keys and values to associate with the recommendation.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#StartRecommendationResponse": { + "type": "structure", + "members": { + "recommendationId": { + "target": "com.amazonaws.bedrockagentcore#RecommendationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created recommendation.
", + "smithy.api#required": {} + } + }, + "recommendationArn": { + "target": "com.amazonaws.bedrockagentcore#RecommendationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created recommendation.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#RecommendationName", + "traits": { + "smithy.api#documentation": "The name of the recommendation.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#RecommendationDescription", + "traits": { + "smithy.api#documentation": "The description of the recommendation.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentcore#RecommendationType", + "traits": { + "smithy.api#documentation": "The type of recommendation.
", + "smithy.api#required": {} + } + }, + "recommendationConfig": { + "target": "com.amazonaws.bedrockagentcore#RecommendationConfig", + "traits": { + "smithy.api#documentation": "The configuration for the recommendation.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#RecommendationStatus", + "traits": { + "smithy.api#documentation": "The status of the recommendation.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the recommendation was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the recommendation was last updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#State": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#StopBatchEvaluation": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#StopBatchEvaluationRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#StopBatchEvaluationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a running batch evaluation. Sessions that have already been evaluated retain their results.
", + "smithy.api#http": { + "method": "POST", + "uri": "/evaluations/batch-evaluate/{batchEvaluationId}/stop", + "code": 202 + } + } + }, + "com.amazonaws.bedrockagentcore#StopBatchEvaluationRequest": { + "type": "structure", + "members": { + "batchEvaluationId": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the batch evaluation to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#StopBatchEvaluationResponse": { + "type": "structure", + "members": { + "batchEvaluationId": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the stopped batch evaluation.
", + "smithy.api#required": {} + } + }, + "batchEvaluationArn": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the stopped batch evaluation.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationStatus", + "traits": { + "smithy.api#documentation": "The status of the batch evaluation after the stop request.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#BatchEvaluationDescription", + "traits": { + "smithy.api#documentation": "The description of the batch evaluation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#StopBrowserSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#StopBrowserSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#StopBrowserSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Terminates an active browser session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.
To stop a browser session, you must specify both the browser identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartBrowserSession.
The following operations are related to StopBrowserSession:
The trace identifier for request tracking.
", + "smithy.api#httpHeader": "X-Amzn-Trace-Id", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "traceParent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The parent trace information for distributed tracing.
", + "smithy.api#httpHeader": "traceparent", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "browserIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser associated with the session.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the browser session to stop.
", + "smithy.api#httpQuery": "sessionId", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#StopBrowserSessionResponse": { + "type": "structure", + "members": { + "browserIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the browser.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The identifier of the browser session.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the browser session was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#StopCodeInterpreterSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#StopCodeInterpreterSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#StopCodeInterpreterSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Terminates an active code interpreter session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.
To stop a code interpreter session, you must specify both the code interpreter identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartCodeInterpreterSession.
The following operations are related to StopCodeInterpreterSession:
The trace identifier for request tracking.
", + "smithy.api#httpHeader": "X-Amzn-Trace-Id", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "traceParent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The parent trace information for distributed tracing.
", + "smithy.api#httpHeader": "traceparent", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "codeInterpreterIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the code interpreter associated with the session.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionId", + "traits": { + "smithy.api#documentation": "The unique identifier of the code interpreter session to stop.
", + "smithy.api#httpQuery": "sessionId", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#StopCodeInterpreterSessionResponse": { + "type": "structure", + "members": { + "codeInterpreterIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the code interpreter.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#CodeInterpreterSessionId", + "traits": { + "smithy.api#documentation": "The identifier of the code interpreter session.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the code interpreter session was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#StopRuntimeSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#StopRuntimeSessionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#StopRuntimeSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#RetryableConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#RuntimeClientError" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a session that is running in an running AgentCore Runtime agent.
", + "smithy.api#http": { + "method": "POST", + "uri": "/runtimes/{agentRuntimeArn}/stopruntimesession", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#StopRuntimeSessionRequest": { + "type": "structure", + "members": { + "runtimeSessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionType", + "traits": { + "smithy.api#documentation": "The ID of the session that you want to stop.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Runtime-Session-Id", + "smithy.api#required": {} + } + }, + "agentRuntimeArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the agent that contains the session that you want to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "qualifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Optional qualifier to specify an agent alias, such as prodcode> or dev. If you don't provide a value, the DEFAULT alias is used.
Idempotent token used to identify the request. If you use the same token with multiple requests, the same response is returned. Use ClientToken to prevent the same request from being processed more than once.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#StopRuntimeSessionResponse": { + "type": "structure", + "members": { + "runtimeSessionId": { + "target": "com.amazonaws.bedrockagentcore#SessionId", + "traits": { + "smithy.api#documentation": "The ID of the session that you requested to stop.
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" + } + }, + "statusCode": { + "target": "com.amazonaws.bedrockagentcore#HttpResponseCode", + "traits": { + "smithy.api#documentation": "The status code of the request to stop the session.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#StreamUpdate": { + "type": "union", + "members": { + "automationStreamUpdate": { + "target": "com.amazonaws.bedrockagentcore#AutomationStreamUpdate", + "traits": { + "smithy.api#documentation": "The update to an automation stream.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an update to a stream.
" + } + }, + "com.amazonaws.bedrockagentcore#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#MaxLenString" + } + }, + "com.amazonaws.bedrockagentcore#StringListMemberValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentcore#StringMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrockagentcore#StringType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.bedrockagentcore#StringValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentcore#StringValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#StringListMemberValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentcore#StripePrivyAppIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-_]+$" + } + }, + "com.amazonaws.bedrockagentcore#StripePrivyAuthorizationSignatureType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#StripePrivyBasicAuthTokenType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#StripePrivyRequestBodyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#StripePrivyRequestHostType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\.]+$" + } + }, + "com.amazonaws.bedrockagentcore#StripePrivyRequestPathType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^/[a-zA-Z0-9/_\\-\\.~%?=&]+$" + } + }, + "com.amazonaws.bedrockagentcore#StripePrivyTokenRequestInput": { + "type": "structure", + "members": { + "requestHost": { + "target": "com.amazonaws.bedrockagentcore#StripePrivyRequestHostType", + "traits": { + "smithy.api#documentation": "The host for the Privy API request. Defaults to \"api.privy.io\".
" + } + }, + "requestPath": { + "target": "com.amazonaws.bedrockagentcore#StripePrivyRequestPathType", + "traits": { + "smithy.api#documentation": "The path of the Stripe Privy API request.
", + "smithy.api#required": {} + } + }, + "requestBody": { + "target": "com.amazonaws.bedrockagentcore#StripePrivyRequestBodyType", + "traits": { + "smithy.api#documentation": "Request body JSON for the Privy API call.
", + "smithy.api#required": {} + } + }, + "includeAuthorizationSignature": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Set to true to generate privy-authorization-signature.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Stripe Privy token request parameters.
" + } + }, + "com.amazonaws.bedrockagentcore#StripePrivyTokenResponseOutput": { + "type": "structure", + "members": { + "authorizationSignature": { + "target": "com.amazonaws.bedrockagentcore#StripePrivyAuthorizationSignatureType", + "traits": { + "smithy.api#documentation": "Base64-encoded ECDSA P-256 authorization signature (only present when includeAuthorizationSignature is true).
" + } + }, + "requestExpiry": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "Unix timestamp in milliseconds when the authorization signature expires.
" + } + }, + "appId": { + "target": "com.amazonaws.bedrockagentcore#StripePrivyAppIdType", + "traits": { + "smithy.api#documentation": "The Privy app ID for the privy-app-id header.
", + "smithy.api#required": {} + } + }, + "basicAuthToken": { + "target": "com.amazonaws.bedrockagentcore#StripePrivyBasicAuthTokenType", + "traits": { + "smithy.api#documentation": "Base64-encoded Basic Auth token (appId:appSecret) for the Authorization header.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stripe Privy token response containing appId, basicAuthToken, and optionally authorizationSignature.
" + } + }, + "com.amazonaws.bedrockagentcore#SystemPromptConfig": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentcore#SystemPromptText", + "traits": { + "smithy.api#documentation": "The system prompt text provided inline.
" + } + }, + "configurationBundle": { + "target": "com.amazonaws.bedrockagentcore#SystemPromptConfigurationBundle", + "traits": { + "smithy.api#documentation": "The system prompt sourced from a configuration bundle version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The system prompt input, either as inline text or from a configuration bundle.
" + } + }, + "com.amazonaws.bedrockagentcore#SystemPromptConfigurationBundle": { + "type": "structure", + "members": { + "bundleArn": { + "target": "com.amazonaws.bedrockagentcore#ConfigurationBundleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "versionId": { + "target": "com.amazonaws.bedrockagentcore#ConfigurationBundleVersionId", + "traits": { + "smithy.api#documentation": "The version identifier of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "systemPromptJsonPath": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The JSON path within the configuration bundle that contains the system prompt.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A system prompt sourced from a configuration bundle version.
" + } + }, + "com.amazonaws.bedrockagentcore#SystemPromptRecommendationConfig": { + "type": "structure", + "members": { + "systemPrompt": { + "target": "com.amazonaws.bedrockagentcore#SystemPromptConfig", + "traits": { + "smithy.api#documentation": "The current system prompt to optimize.
", + "smithy.api#required": {} + } + }, + "agentTraces": { + "target": "com.amazonaws.bedrockagentcore#AgentTracesConfig", + "traits": { + "smithy.api#documentation": "The agent traces to analyze for generating recommendations.
", + "smithy.api#required": {} + } + }, + "evaluationConfig": { + "target": "com.amazonaws.bedrockagentcore#RecommendationEvaluationConfig", + "traits": { + "smithy.api#documentation": "The evaluation configuration specifying which evaluator to use for assessing recommendation quality.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for generating system prompt optimization recommendations.
" + } + }, + "com.amazonaws.bedrockagentcore#SystemPromptRecommendationResult": { + "type": "structure", + "members": { + "recommendedSystemPrompt": { + "target": "com.amazonaws.bedrockagentcore#SystemPromptText", + "traits": { + "smithy.api#documentation": "The optimized system prompt text generated by the recommendation.
" + } + }, + "configurationBundle": { + "target": "com.amazonaws.bedrockagentcore#RecommendationResultConfigurationBundle", + "traits": { + "smithy.api#documentation": "The configuration bundle containing the recommended system prompt, if the input was sourced from a configuration bundle.
" + } + }, + "explanation": { + "target": "com.amazonaws.bedrockagentcore#RecommendationExplanation", + "traits": { + "smithy.api#documentation": "An explanation of why the recommendation was generated and what patterns were identified in the agent traces.
" + } + }, + "errorCode": { + "target": "com.amazonaws.bedrockagentcore#RecommendationErrorCode", + "traits": { + "smithy.api#documentation": "The error code if the recommendation failed.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.bedrockagentcore#RecommendationErrorMessage", + "traits": { + "smithy.api#documentation": "The error message if the recommendation failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a system prompt recommendation, containing the optimized prompt.
" + } + }, + "com.amazonaws.bedrockagentcore#SystemPromptText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentcore#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentcore#TagsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcore#TagKey" + }, + "value": { + "target": "com.amazonaws.bedrockagentcore#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.bedrockagentcore#TargetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagentcore#TargetPathList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#PathPattern" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentcore#TargetRef": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcore#TargetName", + "traits": { + "smithy.api#documentation": "The name of the gateway target.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to a gateway target.
" + } + }, + "com.amazonaws.bedrockagentcore#TaskStatus": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "submitted" + } + }, + "WORKING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "working" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "CANCELED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "canceled" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.bedrockagentcore#Temperature": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0.0, + "max": 2.0 + } + } + }, + "com.amazonaws.bedrockagentcore#ThrottledException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling. Reduce the frequency of requests and try again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bedrockagentcore#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcore#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bedrockagentcore#TokenBalance": { + "type": "structure", + "members": { + "amount": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Raw balance in the smallest denomination (e.g., USDC base units where 1 USDC = 1000000).
", + "smithy.api#required": {} + } + }, + "decimals": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Number of decimal places for the token (e.g., 6 for USDC).
", + "smithy.api#required": {} + } + }, + "token": { + "target": "com.amazonaws.bedrockagentcore#InstrumentBalanceToken", + "traits": { + "smithy.api#documentation": "The supported token for this balance.
", + "smithy.api#required": {} + } + }, + "network": { + "target": "com.amazonaws.bedrockagentcore#CryptoWalletNetwork", + "traits": { + "smithy.api#documentation": "The blockchain network family (ETHEREUM or SOLANA).
", + "smithy.api#required": {} + } + }, + "chain": { + "target": "com.amazonaws.bedrockagentcore#BlockchainChainId", + "traits": { + "smithy.api#documentation": "The specific blockchain chain.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A single token balance entry.
" + } + }, + "com.amazonaws.bedrockagentcore#TokenUsage": { + "type": "structure", + "members": { + "inputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of tokens consumed for input processing during the evaluation. Includes tokens from the evaluation prompt, agent traces, and any additional context provided to the evaluator model.
" + } + }, + "outputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of tokens generated by the evaluator model in its response. Includes tokens for the score, explanation, and any additional output produced during the evaluation process.
" + } + }, + "totalTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of tokens consumed during the evaluation, calculated as the sum of input and output tokens. Used for cost calculation and rate limiting within the service limits.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The token consumption statistics for language model operations during evaluation. Provides detailed breakdown of input, output, and total tokens used for cost tracking and performance monitoring.
" + } + }, + "com.amazonaws.bedrockagentcore#ToolArguments": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.bedrockagentcore#MaxLenString", + "traits": { + "smithy.api#documentation": "The code to execute in a code interpreter session. This is the source code in the specified programming language that will be executed by the code interpreter.
" + } + }, + "language": { + "target": "com.amazonaws.bedrockagentcore#ProgrammingLanguage", + "traits": { + "smithy.api#documentation": "The programming language of the code to execute. This tells the code interpreter which language runtime to use for execution.
" + } + }, + "clearContext": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to clear the context for the tool.
" + } + }, + "command": { + "target": "com.amazonaws.bedrockagentcore#MaxLenString", + "traits": { + "smithy.api#documentation": "The command to execute with the tool.
" + } + }, + "path": { + "target": "com.amazonaws.bedrockagentcore#MaxLenString", + "traits": { + "smithy.api#documentation": "The path for the tool operation.
" + } + }, + "paths": { + "target": "com.amazonaws.bedrockagentcore#StringList", + "traits": { + "smithy.api#documentation": "The paths for the tool operation.
" + } + }, + "content": { + "target": "com.amazonaws.bedrockagentcore#InputContentBlockList", + "traits": { + "smithy.api#documentation": "The content for the tool operation.
" + } + }, + "directoryPath": { + "target": "com.amazonaws.bedrockagentcore#MaxLenString", + "traits": { + "smithy.api#documentation": "The directory path for the tool operation.
" + } + }, + "taskId": { + "target": "com.amazonaws.bedrockagentcore#MaxLenString", + "traits": { + "smithy.api#documentation": "The identifier of the task for the tool operation.
" + } + }, + "runtime": { + "target": "com.amazonaws.bedrockagentcore#LanguageRuntime", + "traits": { + "smithy.api#documentation": "The runtime environment to use for code execution. If not specified, defaults to deno for JavaScript and TypeScript.
The collection of arguments that specify the operation to perform and its parameters when invoking a tool in Amazon Bedrock AgentCore. Different tools require different arguments, and this structure provides a flexible way to pass the appropriate arguments to each tool type.
" + } + }, + "com.amazonaws.bedrockagentcore#ToolDescriptionConfig": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagentcore#ToolDescriptionText", + "traits": { + "smithy.api#documentation": "The tool description as inline text.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The tool description content.
" + } + }, + "com.amazonaws.bedrockagentcore#ToolDescriptionConfigurationBundle": { + "type": "structure", + "members": { + "bundleArn": { + "target": "com.amazonaws.bedrockagentcore#ConfigurationBundleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "versionId": { + "target": "com.amazonaws.bedrockagentcore#ConfigurationBundleVersionId", + "traits": { + "smithy.api#documentation": "The version identifier of the configuration bundle.
", + "smithy.api#required": {} + } + }, + "tools": { + "target": "com.amazonaws.bedrockagentcore#ConfigurationBundleToolEntryList", + "traits": { + "smithy.api#documentation": "The list of tool entries mapping tool names to their JSON paths within the bundle.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Tool descriptions sourced from a configuration bundle version.
" + } + }, + "com.amazonaws.bedrockagentcore#ToolDescriptionInput": { + "type": "structure", + "members": { + "toolName": { + "target": "com.amazonaws.bedrockagentcore#RecommendationToolName", + "traits": { + "smithy.api#documentation": "The name of the tool.
", + "smithy.api#required": {} + } + }, + "toolDescription": { + "target": "com.amazonaws.bedrockagentcore#ToolDescriptionConfig", + "traits": { + "smithy.api#documentation": "The current description of the tool to optimize.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A tool description input containing the tool name and its current description.
" + } + }, + "com.amazonaws.bedrockagentcore#ToolDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ToolDescriptionInput" + } + }, + "com.amazonaws.bedrockagentcore#ToolDescriptionOutput": { + "type": "structure", + "members": { + "toolName": { + "target": "com.amazonaws.bedrockagentcore#RecommendationToolName", + "traits": { + "smithy.api#documentation": "The name of the tool.
", + "smithy.api#required": {} + } + }, + "recommendedToolDescription": { + "target": "com.amazonaws.bedrockagentcore#ToolDescriptionText", + "traits": { + "smithy.api#documentation": "The optimized tool description text generated by the recommendation.
" + } + }, + "explanation": { + "target": "com.amazonaws.bedrockagentcore#RecommendationExplanation", + "traits": { + "smithy.api#documentation": "An explanation of why the recommendation was generated for this tool and what patterns were identified in the agent traces.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for a single tool description recommendation.
" + } + }, + "com.amazonaws.bedrockagentcore#ToolDescriptionRecommendationConfig": { + "type": "structure", + "members": { + "toolDescription": { + "target": "com.amazonaws.bedrockagentcore#ToolDescriptionSource", + "traits": { + "smithy.api#documentation": "The current tool descriptions to optimize.
", + "smithy.api#required": {} + } + }, + "agentTraces": { + "target": "com.amazonaws.bedrockagentcore#AgentTracesConfig", + "traits": { + "smithy.api#documentation": "The agent traces to analyze for generating tool description recommendations.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for generating tool description optimization recommendations.
" + } + }, + "com.amazonaws.bedrockagentcore#ToolDescriptionRecommendationResult": { + "type": "structure", + "members": { + "tools": { + "target": "com.amazonaws.bedrockagentcore#ToolDescriptionResultList", + "traits": { + "smithy.api#documentation": "The list of tools with their recommended descriptions.
" + } + }, + "configurationBundle": { + "target": "com.amazonaws.bedrockagentcore#RecommendationResultConfigurationBundle", + "traits": { + "smithy.api#documentation": "The configuration bundle containing the recommended tool descriptions, if the input was sourced from a configuration bundle.
" + } + }, + "errorCode": { + "target": "com.amazonaws.bedrockagentcore#RecommendationErrorCode", + "traits": { + "smithy.api#documentation": "The error code if the recommendation failed.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.bedrockagentcore#RecommendationErrorMessage", + "traits": { + "smithy.api#documentation": "The error message if the recommendation failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a tool description recommendation, containing optimized descriptions.
" + } + }, + "com.amazonaws.bedrockagentcore#ToolDescriptionResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ToolDescriptionOutput" + } + }, + "com.amazonaws.bedrockagentcore#ToolDescriptionSource": { + "type": "union", + "members": { + "toolDescriptionText": { + "target": "com.amazonaws.bedrockagentcore#ToolDescriptionTextInput", + "traits": { + "smithy.api#documentation": "Tool descriptions provided as inline text.
" + } + }, + "configurationBundle": { + "target": "com.amazonaws.bedrockagentcore#ToolDescriptionConfigurationBundle", + "traits": { + "smithy.api#documentation": "Tool descriptions sourced from a configuration bundle version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The source of tool descriptions, either inline text or from a configuration bundle.
" + } + }, + "com.amazonaws.bedrockagentcore#ToolDescriptionText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#ToolDescriptionTextInput": { + "type": "structure", + "members": { + "tools": { + "target": "com.amazonaws.bedrockagentcore#ToolDescriptionList", + "traits": { + "smithy.api#documentation": "The list of tool descriptions to optimize.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Inline tool description input containing a list of tools.
" + } + }, + "com.amazonaws.bedrockagentcore#ToolName": { + "type": "enum", + "members": { + "EXECUTE_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executeCode" + } + }, + "EXECUTE_COMMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executeCommand" + } + }, + "READ_FILES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "readFiles" + } + }, + "LIST_FILES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "listFiles" + } + }, + "REMOVE_FILES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "removeFiles" + } + }, + "WRITE_FILES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "writeFiles" + } + }, + "START_COMMAND_EXECUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "startCommandExecution" + } + }, + "GET_TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "getTask" + } + }, + "STOP_TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopTask" + } + } + } + }, + "com.amazonaws.bedrockagentcore#ToolResultStructuredContent": { + "type": "structure", + "members": { + "taskId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the task that produced the result.
" + } + }, + "taskStatus": { + "target": "com.amazonaws.bedrockagentcore#TaskStatus", + "traits": { + "smithy.api#documentation": "The status of the task that produced the result.
" + } + }, + "stdout": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The standard output from the tool execution.
" + } + }, + "stderr": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The standard error output from the tool execution.
" + } + }, + "exitCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The exit code from the tool execution.
" + } + }, + "executionTime": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The execution time of the tool operation in milliseconds.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains structured content from a tool result.
" + } + }, + "com.amazonaws.bedrockagentcore#ToolsDefinition": { + "type": "structure", + "members": { + "protocolVersion": { + "target": "com.amazonaws.bedrockagentcore#SchemaVersion", + "traits": { + "smithy.api#documentation": " The MCP protocol version that the tools conform to. This differs from the schemaVersion field in the server definition, which identifies the server configuration schema format.
The inline content of the tools definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": " The MCP tools definition with a protocol version and inline content. The protocolVersion identifies the MCP protocol version that the tools conform to. This differs from schemaVersion in the server definition, which identifies the server configuration schema format.
The configuration for mounting your own Amazon Simple Storage Service (Amazon S3) Files access point into the session.
" + } + }, + "efsConfiguration": { + "target": "com.amazonaws.bedrockagentcore#EfsConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for mounting your own Amazon Elastic File System (Amazon EFS) access point into the session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a file system to mount into the session by providing exactly one of the following:
s3FilesConfiguration - Mounts an Amazon Simple Storage Service (Amazon S3) Files access point.
efsConfiguration - Mounts an Amazon Elastic File System (Amazon EFS) access point.
The file system configurations to mount into the session. Each configuration maps an access point to a path inside the session. You can specify up to 4 configurations. The maximum is 2 Amazon Simple Storage Service (Amazon S3) Files access points and 2 Amazon Elastic File System (Amazon EFS) access points.
", + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcore#TopK": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagentcore#TopP": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0.0, + "max": 1.0 + } + } + }, + "com.amazonaws.bedrockagentcore#TraceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 32 + } + } + }, + "com.amazonaws.bedrockagentcore#TraceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#TraceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentcore#UnauthorizedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentcore#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access
", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.bedrockagentcore#UpdateABTest": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#UpdateABTestRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#UpdateABTestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#UnauthorizedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/ab-tests/{abTestId}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#UpdateABTestRequest": { + "type": "structure", + "members": { + "abTestId": { + "target": "com.amazonaws.bedrockagentcore#ABTestId", + "traits": { + "smithy.api#documentation": "The unique identifier of the A/B test to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagentcore#ABTestName", + "traits": { + "smithy.api#documentation": "The updated name of the A/B test.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagentcore#ABTestDescription", + "traits": { + "smithy.api#documentation": "The updated description of the A/B test.
" + } + }, + "variants": { + "target": "com.amazonaws.bedrockagentcore#VariantList", + "traits": { + "smithy.api#documentation": "The updated list of variants.
" + } + }, + "gatewayFilter": { + "target": "com.amazonaws.bedrockagentcore#GatewayFilter", + "traits": { + "smithy.api#documentation": "The updated gateway filter.
" + } + }, + "evaluationConfig": { + "target": "com.amazonaws.bedrockagentcore#ABTestEvaluationConfig", + "traits": { + "smithy.api#documentation": "The updated evaluation configuration.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagentcore#RoleArn", + "traits": { + "smithy.api#documentation": "The updated IAM role ARN.
" + } + }, + "executionStatus": { + "target": "com.amazonaws.bedrockagentcore#ABTestExecutionStatus", + "traits": { + "smithy.api#documentation": "The updated execution status to enable or disable the A/B test.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#UpdateABTestResponse": { + "type": "structure", + "members": { + "abTestId": { + "target": "com.amazonaws.bedrockagentcore#ABTestId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated A/B test.
", + "smithy.api#required": {} + } + }, + "abTestArn": { + "target": "com.amazonaws.bedrockagentcore#ABTestArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated A/B test.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentcore#ABTestStatus", + "traits": { + "smithy.api#documentation": "The status of the A/B test.
", + "smithy.api#required": {} + } + }, + "executionStatus": { + "target": "com.amazonaws.bedrockagentcore#ABTestExecutionStatus", + "traits": { + "smithy.api#documentation": "The execution status of the A/B test.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the A/B test was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#UpdateBrowserStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcore#UpdateBrowserStreamRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcore#UpdateBrowserStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcore#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentcore#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/browsers/{browserIdentifier}/sessions/streams/update", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcore#UpdateBrowserStreamRequest": { + "type": "structure", + "members": { + "browserIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the browser.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The identifier of the browser session.
", + "smithy.api#httpQuery": "sessionId", + "smithy.api#required": {} + } + }, + "streamUpdate": { + "target": "com.amazonaws.bedrockagentcore#StreamUpdate", + "traits": { + "smithy.api#documentation": "The update to apply to the browser stream.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagentcore#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcore#UpdateBrowserStreamResponse": { + "type": "structure", + "members": { + "browserIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the browser.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionId", + "traits": { + "smithy.api#documentation": "The identifier of the browser session.
", + "smithy.api#required": {} + } + }, + "streams": { + "target": "com.amazonaws.bedrockagentcore#BrowserSessionStream", + "traits": { + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagentcore#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the browser stream was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcore#UserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 120 + } + } + }, + "com.amazonaws.bedrockagentcore#UserIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.bedrockagentcore#UserIdentifier": { + "type": "union", + "members": { + "userToken": { + "target": "com.amazonaws.bedrockagentcore#UserTokenType", + "traits": { + "smithy.api#documentation": "The OAuth2.0 token issued by the user’s identity provider that was used to generate the workload access token
" + } + }, + "userId": { + "target": "com.amazonaws.bedrockagentcore#UserIdType", + "traits": { + "smithy.api#documentation": "The ID of the user for whom you have retrieved a workload access token for
" + } + } + }, + "traits": { + "smithy.api#documentation": "The OAuth2.0 token or user ID that was used to generate the workload access token used for initiating the user authorization flow to retrieve OAuth2.0 tokens.
" + } + }, + "com.amazonaws.bedrockagentcore#UserIntentAffectedSession": { + "type": "structure", + "members": { + "sessionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the session.
", + "smithy.api#required": {} + } + }, + "userMessages": { + "target": "com.amazonaws.bedrockagentcore#UserIntentList", + "traits": { + "smithy.api#documentation": "The user messages from this session that contributed to the intent cluster.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A session associated with a user intent cluster.
" + } + }, + "com.amazonaws.bedrockagentcore#UserIntentAffectedSessionList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#UserIntentAffectedSession" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.bedrockagentcore#UserIntentCluster": { + "type": "structure", + "members": { + "clusterId": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The unique identifier of the user intent cluster.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the user intent cluster.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the user intent pattern.
", + "smithy.api#required": {} + } + }, + "affectedSessionCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of sessions with this user intent.
", + "smithy.api#required": {} + } + }, + "affectedSessions": { + "target": "com.amazonaws.bedrockagentcore#UserIntentAffectedSessionList", + "traits": { + "smithy.api#documentation": "The list of sessions with this user intent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A cluster of similar user intents identified across sessions.
" + } + }, + "com.amazonaws.bedrockagentcore#UserIntentClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#UserIntentCluster" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.bedrockagentcore#UserIntentClusteringResultContent": { + "type": "structure", + "members": { + "userIntents": { + "target": "com.amazonaws.bedrockagentcore#UserIntentClusterList", + "traits": { + "smithy.api#documentation": "The list of user intent clusters identified across analyzed sessions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The user intent clustering result containing grouped user intents identified across evaluated sessions.
" + } + }, + "com.amazonaws.bedrockagentcore#UserIntentList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrockagentcore#UserTokenType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 131072 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_=]+.[A-Za-z0-9-_=]+.[A-Za-z0-9-_=]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentcore#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.bedrockagentcore#ValidationExceptionReason", + "traits": { + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.bedrockagentcore#ValidationExceptionFieldList" + } + }, + "traits": { + "smithy.api#documentation": "The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagentcore#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the field.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A message describing why this field failed validation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stores information about a field passed inside a request that resulted in an exception.
" + } + }, + "com.amazonaws.bedrockagentcore#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#ValidationExceptionField" + } + }, + "com.amazonaws.bedrockagentcore#ValidationExceptionReason": { + "type": "enum", + "members": { + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FieldValidationFailed" + } + }, + "IDEMPOTENT_PARAMETER_MISMATCH_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IdempotentParameterMismatchException" + } + }, + "ROOT_EVENT_IN_OTHER_SESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventInOtherSession" + } + }, + "RESOURCE_CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceConflict" + } + } + } + }, + "com.amazonaws.bedrockagentcore#Variant": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentcore#VariantName", + "traits": { + "smithy.api#documentation": "The name of the variant. Must be C for control or T1 for treatment.
The percentage of traffic to route to this variant. Weights across all variants must sum to 100.
", + "smithy.api#range": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "variantConfiguration": { + "target": "com.amazonaws.bedrockagentcore#VariantConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for this variant, including the configuration bundle or target reference.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A variant in an A/B test, representing either the control (C) or treatment (T1) configuration.
" + } + }, + "com.amazonaws.bedrockagentcore#VariantConfiguration": { + "type": "structure", + "members": { + "configurationBundle": { + "target": "com.amazonaws.bedrockagentcore#ConfigurationBundleRef", + "traits": { + "smithy.api#documentation": "A reference to a configuration bundle version to use for this variant.
" + } + }, + "target": { + "target": "com.amazonaws.bedrockagentcore#TargetRef", + "traits": { + "smithy.api#documentation": "A reference to a gateway target to route traffic to for this variant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for an A/B test variant.
" + } + }, + "com.amazonaws.bedrockagentcore#VariantList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#Variant" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagentcore#VariantName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#pattern": "^(C|T1)$" + } + }, + "com.amazonaws.bedrockagentcore#VariantResult": { + "type": "structure", + "members": { + "variantName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the treatment variant.
", + "smithy.api#required": {} + } + }, + "sampleSize": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of sessions evaluated for this variant.
", + "smithy.api#required": {} + } + }, + "mean": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The mean evaluation score for this variant.
", + "smithy.api#required": {} + } + }, + "absoluteChange": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The absolute change in mean score compared to the control variant.
" + } + }, + "percentChange": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The percentage change in mean score compared to the control variant.
" + } + }, + "pValue": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The p-value indicating the statistical significance of the observed difference.
" + } + }, + "confidenceInterval": { + "target": "com.amazonaws.bedrockagentcore#ConfidenceInterval", + "traits": { + "smithy.api#documentation": "The confidence interval for the observed difference.
" + } + }, + "isSignificant": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the observed difference is statistically significant.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Statistical results for a treatment variant compared against the control.
" + } + }, + "com.amazonaws.bedrockagentcore#VariantResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcore#VariantResult" + } + }, + "com.amazonaws.bedrockagentcore#ViewPort": { + "type": "structure", + "members": { + "width": { + "target": "com.amazonaws.bedrockagentcore#ViewPortWidth", + "traits": { + "smithy.api#documentation": "The width of the viewport in pixels. This value determines the horizontal dimension of the visible area. Valid values range from 800 to 1920 pixels.
", + "smithy.api#required": {} + } + }, + "height": { + "target": "com.amazonaws.bedrockagentcore#ViewPortHeight", + "traits": { + "smithy.api#documentation": "The height of the viewport in pixels. This value determines the vertical dimension of the visible area. Valid values range from 600 to 1080 pixels.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that defines the dimensions of a browser viewport in a browser session. The viewport determines the visible area of web content and affects how web pages are rendered and displayed. Proper viewport configuration ensures that web content is displayed correctly for the agent's browsing tasks.
" + } + }, + "com.amazonaws.bedrockagentcore#ViewPortHeight": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 240, + "max": 2160 + } + } + }, + "com.amazonaws.bedrockagentcore#ViewPortWidth": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 320, + "max": 3840 + } + } + }, + "com.amazonaws.bedrockagentcore#WorkloadIdentityNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z0-9_.-]+$" + } + }, + "com.amazonaws.bedrockagentcore#WorkloadIdentityTokenType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 131072 + }, + "smithy.api#sensitive": {} + } + } + } +} \ No newline at end of file diff --git a/codegen/aws-models/bedrock-data-automation.json b/codegen/aws-models/bedrock-data-automation.json new file mode 100644 index 0000000..fbd025d --- /dev/null +++ b/codegen/aws-models/bedrock-data-automation.json @@ -0,0 +1,6350 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.bedrockdataautomation#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockdataautomation#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a request is denied per access permissions", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bedrockdataautomation#AmazonBedrockKeystoneBuildTimeService": { + "type": "service", + "version": "2023-07-26", + "operations": [ + { + "target": "com.amazonaws.bedrockdataautomation#CopyBlueprintStage" + }, + { + "target": "com.amazonaws.bedrockdataautomation#CreateBlueprintVersion" + }, + { + "target": "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryEntity" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraryEntities" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ListTagsForResource" + }, + { + "target": "com.amazonaws.bedrockdataautomation#TagResource" + }, + { + "target": "com.amazonaws.bedrockdataautomation#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationJobResource" + }, + { + "target": "com.amazonaws.bedrockdataautomation#BlueprintResource" + }, + { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJobResource" + }, + { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryResource" + }, + { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Bedrock Data Automation", + "arnNamespace": "bedrock", + "endpointPrefix": "bedrock-data-automation", + "cloudTrailEventSource": "bedrock.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "bedrock" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon Bedrock Data Automation BuildTime", + "smithy.api#title": "Data Automation for Amazon Bedrock", + "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 + ] + } + ], + "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://bedrock-data-automation-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://bedrock-data-automation-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://bedrock-data-automation.{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://bedrock-data-automation.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 13, + "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" + }, + "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": [], + "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" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-data-automation-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-data-automation-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-data-automation.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-data-automation.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-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://bedrock-data-automation-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://bedrock-data-automation.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-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://bedrock-data-automation-fips.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://bedrock-data-automation.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://bedrock-data-automation.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 enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-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://bedrock-data-automation.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.bedrockdataautomation#AudioExtractionCategory": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State", + "traits": { + "smithy.api#required": {} + } + }, + "types": { + "target": "com.amazonaws.bedrockdataautomation#AudioExtractionCategoryTypes" + }, + "typeConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#AudioExtractionCategoryTypeConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Category of Audio Extraction" + } + }, + "com.amazonaws.bedrockdataautomation#AudioExtractionCategoryType": { + "type": "enum", + "members": { + "AUDIO_CONTENT_MODERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUDIO_CONTENT_MODERATION" + } + }, + "TRANSCRIPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSCRIPT" + } + }, + "TOPIC_CONTENT_MODERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOPIC_CONTENT_MODERATION" + } + } + } + }, + "com.amazonaws.bedrockdataautomation#AudioExtractionCategoryTypeConfiguration": { + "type": "structure", + "members": { + "transcript": { + "target": "com.amazonaws.bedrockdataautomation#TranscriptConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Configuration for different audio extraction category types" + } + }, + "com.amazonaws.bedrockdataautomation#AudioExtractionCategoryTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#AudioExtractionCategoryType" + }, + "traits": { + "smithy.api#documentation": "List of Audio Extraction Category Type" + } + }, + "com.amazonaws.bedrockdataautomation#AudioGenerativeOutputLanguage": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "EN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EN" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for Audio output language" + } + }, + "com.amazonaws.bedrockdataautomation#AudioInputLanguages": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#Language" + }, + "traits": { + "smithy.api#documentation": "List of supported audio languages" + } + }, + "com.amazonaws.bedrockdataautomation#AudioLanguageConfiguration": { + "type": "structure", + "members": { + "inputLanguages": { + "target": "com.amazonaws.bedrockdataautomation#AudioInputLanguages" + }, + "generativeOutputLanguage": { + "target": "com.amazonaws.bedrockdataautomation#AudioGenerativeOutputLanguage" + }, + "identifyMultipleLanguages": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Enable multiple language identification in audio" + } + } + }, + "traits": { + "smithy.api#documentation": "Optional configuration for audio language settings" + } + }, + "com.amazonaws.bedrockdataautomation#AudioOverrideConfiguration": { + "type": "structure", + "members": { + "modalityProcessing": { + "target": "com.amazonaws.bedrockdataautomation#ModalityProcessingConfiguration" + }, + "languageConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#AudioLanguageConfiguration" + }, + "sensitiveDataConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#SensitiveDataConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Override Configuration of Audio" + } + }, + "com.amazonaws.bedrockdataautomation#AudioStandardExtraction": { + "type": "structure", + "members": { + "category": { + "target": "com.amazonaws.bedrockdataautomation#AudioExtractionCategory", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Standard Extraction Configuration of Audio" + } + }, + "com.amazonaws.bedrockdataautomation#AudioStandardGenerativeField": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State", + "traits": { + "smithy.api#required": {} + } + }, + "types": { + "target": "com.amazonaws.bedrockdataautomation#AudioStandardGenerativeFieldTypes" + } + }, + "traits": { + "smithy.api#documentation": "Standard Generative Field Configuration of Audio" + } + }, + "com.amazonaws.bedrockdataautomation#AudioStandardGenerativeFieldType": { + "type": "enum", + "members": { + "AUDIO_SUMMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUDIO_SUMMARY" + } + }, + "IAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAB" + } + }, + "TOPIC_SUMMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOPIC_SUMMARY" + } + } + } + }, + "com.amazonaws.bedrockdataautomation#AudioStandardGenerativeFieldTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#AudioStandardGenerativeFieldType" + }, + "traits": { + "smithy.api#documentation": "List of Audio Standard Generative Field Type" + } + }, + "com.amazonaws.bedrockdataautomation#AudioStandardOutputConfiguration": { + "type": "structure", + "members": { + "extraction": { + "target": "com.amazonaws.bedrockdataautomation#AudioStandardExtraction" + }, + "generativeField": { + "target": "com.amazonaws.bedrockdataautomation#AudioStandardGenerativeField" + } + }, + "traits": { + "smithy.api#documentation": "Standard Output Configuration of Audio" + } + }, + "com.amazonaws.bedrockdataautomation#Blueprint": { + "type": "structure", + "members": { + "blueprintArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintArn", + "traits": { + "smithy.api#required": {} + } + }, + "schema": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintSchema", + "traits": { + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockdataautomation#Type", + "traits": { + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "blueprintName": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintName", + "traits": { + "smithy.api#required": {} + } + }, + "blueprintVersion": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintVersion" + }, + "blueprintStage": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintStage" + }, + "kmsKeyId": { + "target": "com.amazonaws.bedrockdataautomation#KmsKeyId" + }, + "kmsEncryptionContext": { + "target": "com.amazonaws.bedrockdataautomation#KmsEncryptionContext" + }, + "optimizationSamples": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationSamples" + }, + "optimizationTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp" + } + }, + "traits": { + "smithy.api#documentation": "Contains the information of a Blueprint." + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of a Blueprint", + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})$" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintFilter": { + "type": "structure", + "members": { + "blueprintArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintArn", + "traits": { + "smithy.api#required": {} + } + }, + "blueprintVersion": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintVersion" + }, + "blueprintStage": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintStage" + } + }, + "traits": { + "smithy.api#documentation": "Blueprint Filter" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintItem": { + "type": "structure", + "members": { + "blueprintArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintArn", + "traits": { + "smithy.api#required": {} + } + }, + "blueprintVersion": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintVersion" + }, + "blueprintStage": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintStage" + } + }, + "traits": { + "smithy.api#documentation": "Blueprint Item" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintItem" + }, + "traits": { + "smithy.api#documentation": "List of Blueprint Item" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintName": { + "type": "string", + "traits": { + "smithy.api#documentation": "Name of the Blueprint", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintOptimizationInvocationArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Invocation arn.", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:blueprint-optimization-invocation/[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintOptimizationJobResource": { + "type": "resource", + "identifiers": { + "invocationArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationInvocationArn" + } + }, + "create": { + "target": "com.amazonaws.bedrockdataautomation#InvokeBlueprintOptimizationAsync" + }, + "read": { + "target": "com.amazonaws.bedrockdataautomation#GetBlueprintOptimizationStatus" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintOptimizationJobStatus": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceError" + } + }, + "CLIENT_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClientError" + } + } + }, + "traits": { + "smithy.api#documentation": "List of status supported by optimization jobs" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintOptimizationObject": { + "type": "structure", + "members": { + "blueprintArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintArn", + "traits": { + "smithy.api#documentation": "Arn of blueprint.", + "smithy.api#required": {} + } + }, + "stage": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintStage", + "traits": { + "smithy.api#documentation": "Stage of blueprint." + } + } + }, + "traits": { + "smithy.api#documentation": "Structure for single blueprint entity." + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintOptimizationOutputConfiguration": { + "type": "structure", + "members": { + "s3Object": { + "target": "com.amazonaws.bedrockdataautomation#S3Object", + "traits": { + "smithy.api#documentation": "S3 object.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Blueprint Optimization Output configuration." + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintOptimizationSample": { + "type": "structure", + "members": { + "assetS3Object": { + "target": "com.amazonaws.bedrockdataautomation#S3Object", + "traits": { + "smithy.api#documentation": "S3 Object of the asset", + "smithy.api#required": {} + } + }, + "groundTruthS3Object": { + "target": "com.amazonaws.bedrockdataautomation#S3Object", + "traits": { + "smithy.api#documentation": "Ground truth for the Blueprint and Asset combination", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Blueprint Recommendation Sample" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintOptimizationSamples": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationSample" + }, + "traits": { + "smithy.api#documentation": "List of Blueprint Optimization Samples" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintResource": { + "type": "resource", + "identifiers": { + "blueprintArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintArn" + } + }, + "create": { + "target": "com.amazonaws.bedrockdataautomation#CreateBlueprint" + }, + "read": { + "target": "com.amazonaws.bedrockdataautomation#GetBlueprint" + }, + "update": { + "target": "com.amazonaws.bedrockdataautomation#UpdateBlueprint" + }, + "delete": { + "target": "com.amazonaws.bedrockdataautomation#DeleteBlueprint" + }, + "list": { + "target": "com.amazonaws.bedrockdataautomation#ListBlueprints" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintSchema": { + "type": "string", + "traits": { + "smithy.api#documentation": "Schema of the blueprint", + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintStage": { + "type": "enum", + "members": { + "DEVELOPMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVELOPMENT" + } + }, + "LIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVE" + } + } + }, + "traits": { + "smithy.api#documentation": "Stage of the Blueprint" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintStageFilter": { + "type": "enum", + "members": { + "DEVELOPMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVELOPMENT" + } + }, + "LIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVE" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + }, + "traits": { + "smithy.api#documentation": "Blueprint Stage filter" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintSummary": { + "type": "structure", + "members": { + "blueprintArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintArn", + "traits": { + "smithy.api#required": {} + } + }, + "blueprintVersion": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintVersion" + }, + "blueprintStage": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintStage" + }, + "blueprintName": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintName" + }, + "creationTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp" + } + }, + "traits": { + "smithy.api#documentation": "Summary of a Blueprint" + } + }, + "com.amazonaws.bedrockdataautomation#BlueprintVersion": { + "type": "string", + "traits": { + "smithy.api#documentation": "Blueprint Version", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[0-9]*$" + } + }, + "com.amazonaws.bedrockdataautomation#Blueprints": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintSummary" + }, + "traits": { + "smithy.api#documentation": "List of Blueprints" + } + }, + "com.amazonaws.bedrockdataautomation#ChannelLabelingConfiguration": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Channel labeling configuration" + } + }, + "com.amazonaws.bedrockdataautomation#ClientToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "Client specified token used for idempotency checks", + "smithy.api#length": { + "min": 33, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}$" + } + }, + "com.amazonaws.bedrockdataautomation#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockdataautomation#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when there is a conflict performing an operation", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.bedrockdataautomation#CopyBlueprintStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#CopyBlueprintStageRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#CopyBlueprintStageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Copies a Blueprint from one stage to another", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/blueprints/{blueprintArn}/copy-stage" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockdataautomation#CopyBlueprintStageRequest": { + "type": "structure", + "members": { + "blueprintArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintArn", + "traits": { + "smithy.api#documentation": "Blueprint to be copied", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sourceStage": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintStage", + "traits": { + "smithy.api#documentation": "Source stage to copy from", + "smithy.api#required": {} + } + }, + "targetStage": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintStage", + "traits": { + "smithy.api#documentation": "Target stage to copy to", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockdataautomation#ClientToken", + "traits": { + "smithy.api#documentation": "Client token for idempotency", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#documentation": "CopyBlueprintStage Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#CopyBlueprintStageResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "CopyBlueprintStage Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#CreateBlueprint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#CreateBlueprintRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#CreateBlueprintResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ConflictException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Bedrock Data Automation Blueprint", + "smithy.api#http": { + "code": 201, + "method": "PUT", + "uri": "/blueprints/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockdataautomation#CreateBlueprintRequest": { + "type": "structure", + "members": { + "blueprintName": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintName", + "traits": { + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockdataautomation#Type", + "traits": { + "smithy.api#required": {} + } + }, + "blueprintStage": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintStage" + }, + "schema": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintSchema", + "traits": { + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockdataautomation#ClientToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#EncryptionConfiguration" + }, + "tags": { + "target": "com.amazonaws.bedrockdataautomation#TagList" + } + }, + "traits": { + "smithy.api#documentation": "Create Blueprint Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#CreateBlueprintResponse": { + "type": "structure", + "members": { + "blueprint": { + "target": "com.amazonaws.bedrockdataautomation#Blueprint", + "traits": { + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Create Blueprint Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#CreateBlueprintVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#CreateBlueprintVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#CreateBlueprintVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new version of an existing Amazon Bedrock Data Automation Blueprint", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/blueprints/{blueprintArn}/versions/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockdataautomation#CreateBlueprintVersionRequest": { + "type": "structure", + "members": { + "blueprintArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintArn", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a Blueprint is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockdataautomation#ClientToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Create Blueprint Version Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#CreateBlueprintVersionResponse": { + "type": "structure", + "members": { + "blueprint": { + "target": "com.amazonaws.bedrockdataautomation#Blueprint", + "traits": { + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Create Blueprint Version Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#CreateDataAutomationLibrary": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#CreateDataAutomationLibraryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#CreateDataAutomationLibraryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ConflictException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Bedrock Data Automation Library", + "smithy.api#http": { + "code": 201, + "method": "PUT", + "uri": "/data-automation-libraries/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockdataautomation#CreateDataAutomationLibraryRequest": { + "type": "structure", + "members": { + "libraryName": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryName", + "traits": { + "smithy.api#required": {} + } + }, + "libraryDescription": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryDescription" + }, + "clientToken": { + "target": "com.amazonaws.bedrockdataautomation#ClientToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#EncryptionConfiguration" + }, + "tags": { + "target": "com.amazonaws.bedrockdataautomation#TagList" + } + }, + "traits": { + "smithy.api#documentation": "Create DataAutomationLibrary Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#CreateDataAutomationLibraryResponse": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn" + }, + "status": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryStatus" + } + }, + "traits": { + "smithy.api#documentation": "Create DataAutomationLibrary Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#CreateDataAutomationProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#CreateDataAutomationProjectRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#CreateDataAutomationProjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ConflictException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Bedrock Data Automation Project", + "smithy.api#http": { + "code": 201, + "method": "PUT", + "uri": "/data-automation-projects/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockdataautomation#CreateDataAutomationProjectRequest": { + "type": "structure", + "members": { + "projectName": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectName", + "traits": { + "smithy.api#required": {} + } + }, + "projectDescription": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectDescription" + }, + "projectStage": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectStage" + }, + "projectType": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectType", + "traits": { + "smithy.api#default": "ASYNC" + } + }, + "standardOutputConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#StandardOutputConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "customOutputConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#CustomOutputConfiguration" + }, + "overrideConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#OverrideConfiguration" + }, + "dataAutomationLibraryConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryConfiguration" + }, + "clientToken": { + "target": "com.amazonaws.bedrockdataautomation#ClientToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#EncryptionConfiguration" + }, + "tags": { + "target": "com.amazonaws.bedrockdataautomation#TagList" + } + }, + "traits": { + "smithy.api#documentation": "Create DataAutomationProject Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#CreateDataAutomationProjectResponse": { + "type": "structure", + "members": { + "projectArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectArn", + "traits": { + "smithy.api#required": {} + } + }, + "projectStage": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectStage" + }, + "status": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectStatus" + } + }, + "traits": { + "smithy.api#documentation": "Create DataAutomationProject Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#CustomOutputConfiguration": { + "type": "structure", + "members": { + "blueprints": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintItems" + }, + "document": { + "target": "com.amazonaws.bedrockdataautomation#DocumentCustomOutputConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Custom output configuration" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibrary": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn", + "traits": { + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "libraryName": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryName", + "traits": { + "smithy.api#required": {} + } + }, + "libraryDescription": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryDescription" + }, + "status": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryStatus", + "traits": { + "smithy.api#required": {} + } + }, + "entityTypes": { + "target": "com.amazonaws.bedrockdataautomation#EntityTypeInfoList" + }, + "kmsKeyId": { + "target": "com.amazonaws.bedrockdataautomation#KmsKeyId" + }, + "kmsEncryptionContext": { + "target": "com.amazonaws.bedrockdataautomation#KmsEncryptionContext" + } + }, + "traits": { + "smithy.api#documentation": "Contains the information of a DataAutomationLibrary." + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a DataAutomationLibrary is created", + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}$" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryConfiguration": { + "type": "structure", + "members": { + "libraries": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryItems" + } + }, + "traits": { + "smithy.api#documentation": "DataAutomation Library configuration" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "Description of the DataAutomationLibrary", + "smithy.api#length": { + "min": 0, + "max": 300 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s!\"\\#\\$%'&\\(\\)\\*\\+\\,\\-\\./:;=\\?@\\[\\\\\\]\\^_`\\{\\|\\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryEntitySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryEntitySummary" + }, + "traits": { + "smithy.api#documentation": "List of entity summary object" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryEntitySummary": { + "type": "union", + "members": { + "vocabulary": { + "target": "com.amazonaws.bedrockdataautomation#VocabularyEntitySummary" + } + }, + "traits": { + "smithy.api#documentation": "Summarized information about an entity" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryFilter": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Data Automation Library Filter" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJob": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJobArn", + "traits": { + "smithy.api#documentation": "ARN of the DataAutomationLibraryIngestionJob", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp", + "traits": { + "smithy.api#documentation": "Timestamp when the DataAutomationLibraryIngestionJob was created", + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.bedrockdataautomation#EntityType", + "traits": { + "smithy.api#documentation": "The entity type associated with DataAutomationLibraryIngestionJob", + "smithy.api#required": {} + } + }, + "operationType": { + "target": "com.amazonaws.bedrockdataautomation#LibraryIngestionJobOperationType", + "traits": { + "smithy.api#documentation": "The operation associated with DataAutomationLibraryIngestionJob", + "smithy.api#required": {} + } + }, + "jobStatus": { + "target": "com.amazonaws.bedrockdataautomation#LibraryIngestionJobStatus", + "traits": { + "smithy.api#documentation": "The status of the DataAutomationLibraryIngestionJob", + "smithy.api#required": {} + } + }, + "outputConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#OutputConfiguration", + "traits": { + "smithy.api#documentation": "Output configuration of DataAutomationLibraryIngestionJob", + "smithy.api#required": {} + } + }, + "completionTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp", + "traits": { + "smithy.api#documentation": "Timestamp when the DataAutomationLibraryIngestionJob was completed" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Error message" + } + }, + "errorType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Error type" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the information of a DataAutomationLibraryIngestionJob" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJobArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of the DataAutomationLibraryIngestionJob", + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library-ingestion-job/[a-zA-Z0-9-]{12,36}$" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJobResource": { + "type": "resource", + "identifiers": { + "jobArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJobArn" + } + }, + "create": { + "target": "com.amazonaws.bedrockdataautomation#InvokeDataAutomationLibraryIngestionJob" + }, + "read": { + "target": "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryIngestionJob" + }, + "list": { + "target": "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraryIngestionJobs" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJobSummary" + }, + "traits": { + "smithy.api#documentation": "List of DataAutomationLibraryIngestionJobSummary objects" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJobSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJobArn", + "traits": { + "smithy.api#required": {} + } + }, + "jobStatus": { + "target": "com.amazonaws.bedrockdataautomation#LibraryIngestionJobStatus", + "traits": { + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.bedrockdataautomation#EntityType", + "traits": { + "smithy.api#required": {} + } + }, + "operationType": { + "target": "com.amazonaws.bedrockdataautomation#LibraryIngestionJobOperationType", + "traits": { + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "completionTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp" + } + }, + "traits": { + "smithy.api#documentation": "Summary of a DataAutomationLibraryIngestionJob" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryItem": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "DataAutomationLibrary Item" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryItem" + }, + "traits": { + "smithy.api#documentation": "List of DataAutomationLibrary Items", + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryName": { + "type": "string", + "traits": { + "smithy.api#documentation": "Name of the DataAutomationLibrary", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryResource": { + "type": "resource", + "identifiers": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn" + } + }, + "create": { + "target": "com.amazonaws.bedrockdataautomation#CreateDataAutomationLibrary" + }, + "read": { + "target": "com.amazonaws.bedrockdataautomation#GetDataAutomationLibrary" + }, + "update": { + "target": "com.amazonaws.bedrockdataautomation#UpdateDataAutomationLibrary" + }, + "delete": { + "target": "com.amazonaws.bedrockdataautomation#DeleteDataAutomationLibrary" + }, + "list": { + "target": "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraries" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibraryStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + }, + "traits": { + "smithy.api#documentation": "Status of DataAutomationLibrary" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibrarySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibrarySummary" + }, + "traits": { + "smithy.api#documentation": "List of DataAutomationLibrarySummary objects" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationLibrarySummary": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn", + "traits": { + "smithy.api#required": {} + } + }, + "libraryName": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryName" + }, + "creationTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of a DataAutomationLibrary" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProfileArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Data automation profile arn.", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-profile/[a-zA-Z0-9-_.]+$" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProject": { + "type": "structure", + "members": { + "projectArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectArn", + "traits": { + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectName", + "traits": { + "smithy.api#required": {} + } + }, + "projectStage": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectStage" + }, + "projectType": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectType" + }, + "projectDescription": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectDescription" + }, + "standardOutputConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#StandardOutputConfiguration" + }, + "customOutputConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#CustomOutputConfiguration" + }, + "overrideConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#OverrideConfiguration" + }, + "dataAutomationLibraryConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryConfiguration" + }, + "status": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectStatus", + "traits": { + "smithy.api#required": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.bedrockdataautomation#KmsKeyId" + }, + "kmsEncryptionContext": { + "target": "com.amazonaws.bedrockdataautomation#KmsEncryptionContext" + } + }, + "traits": { + "smithy.api#documentation": "Contains the information of a DataAutomationProject." + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProjectArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of a DataAutomationProject", + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}$" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProjectDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "Description of the DataAutomationProject", + "smithy.api#length": { + "min": 0, + "max": 300 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProjectFilter": { + "type": "structure", + "members": { + "projectArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectArn", + "traits": { + "smithy.api#required": {} + } + }, + "projectStage": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectStage" + } + }, + "traits": { + "smithy.api#documentation": "Data Automation Project Filter" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProjectName": { + "type": "string", + "traits": { + "smithy.api#documentation": "Name of the DataAutomationProject", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProjectResource": { + "type": "resource", + "identifiers": { + "projectArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectArn" + } + }, + "create": { + "target": "com.amazonaws.bedrockdataautomation#CreateDataAutomationProject" + }, + "read": { + "target": "com.amazonaws.bedrockdataautomation#GetDataAutomationProject" + }, + "update": { + "target": "com.amazonaws.bedrockdataautomation#UpdateDataAutomationProject" + }, + "delete": { + "target": "com.amazonaws.bedrockdataautomation#DeleteDataAutomationProject" + }, + "list": { + "target": "com.amazonaws.bedrockdataautomation#ListDataAutomationProjects" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProjectStage": { + "type": "enum", + "members": { + "DEVELOPMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVELOPMENT" + } + }, + "LIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVE" + } + } + }, + "traits": { + "smithy.api#documentation": "Stage of the Project" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProjectStageFilter": { + "type": "enum", + "members": { + "DEVELOPMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVELOPMENT" + } + }, + "LIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVE" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + }, + "traits": { + "smithy.api#documentation": "Project Stage filter" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProjectStatus": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "Status of Data Automation Project" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProjectSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectSummary" + }, + "traits": { + "smithy.api#documentation": "List of DataAutomationProjectSummary" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProjectSummary": { + "type": "structure", + "members": { + "projectArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectArn", + "traits": { + "smithy.api#required": {} + } + }, + "projectStage": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectStage" + }, + "projectType": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectType" + }, + "projectName": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectName" + }, + "creationTime": { + "target": "com.amazonaws.bedrockdataautomation#DateTimestamp", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of a DataAutomationProject" + } + }, + "com.amazonaws.bedrockdataautomation#DataAutomationProjectType": { + "type": "enum", + "members": { + "ASYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASYNC" + } + }, + "SYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNC" + } + } + }, + "traits": { + "smithy.api#documentation": "Type of the DataAutomationProject" + } + }, + "com.amazonaws.bedrockdataautomation#DateTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "Time Stamp", + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.bedrockdataautomation#DeleteBlueprint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#DeleteBlueprintRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#DeleteBlueprintResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing Amazon Bedrock Data Automation Blueprint", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/blueprints/{blueprintArn}/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockdataautomation#DeleteBlueprintRequest": { + "type": "structure", + "members": { + "blueprintArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintArn", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a Blueprint is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "blueprintVersion": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintVersion", + "traits": { + "smithy.api#documentation": "Optional field to delete a specific Blueprint version", + "smithy.api#httpQuery": "blueprintVersion" + } + } + }, + "traits": { + "smithy.api#documentation": "Delete Blueprint Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#DeleteBlueprintResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Delete Blueprint Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#DeleteDataAutomationLibrary": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#DeleteDataAutomationLibraryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#DeleteDataAutomationLibraryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ConflictException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing Amazon Bedrock Data Automation Library", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/data-automation-libraries/{libraryArn}/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockdataautomation#DeleteDataAutomationLibraryRequest": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a DataAutomationLibrary is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Delete DataAutomationLibrary Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#DeleteDataAutomationLibraryResponse": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn" + }, + "status": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryStatus" + } + }, + "traits": { + "smithy.api#documentation": "Delete DataAutomationLibrary Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#DeleteDataAutomationProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#DeleteDataAutomationProjectRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#DeleteDataAutomationProjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing Amazon Bedrock Data Automation Project", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/data-automation-projects/{projectArn}/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockdataautomation#DeleteDataAutomationProjectRequest": { + "type": "structure", + "members": { + "projectArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectArn", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a DataAutomationProject is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Delete DataAutomationProject Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#DeleteDataAutomationProjectResponse": { + "type": "structure", + "members": { + "projectArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectArn", + "traits": { + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectStatus" + } + }, + "traits": { + "smithy.api#documentation": "Delete DataAutomationProject Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#DeleteEntitiesInfo": { + "type": "structure", + "members": { + "entityIds": { + "target": "com.amazonaws.bedrockdataautomation#EntityIdList", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for entities needed to be deleted" + } + }, + "com.amazonaws.bedrockdataautomation#DesiredModality": { + "type": "enum", + "members": { + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + }, + "DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT" + } + }, + "AUDIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUDIO" + } + }, + "VIDEO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO" + } + } + }, + "traits": { + "smithy.api#documentation": "Desired Modality types" + } + }, + "com.amazonaws.bedrockdataautomation#DocumentBoundingBox": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Bounding Box Configuration of Document Extraction" + } + }, + "com.amazonaws.bedrockdataautomation#DocumentCustomOutputConfiguration": { + "type": "structure", + "members": { + "fallbackBlueprints": { + "target": "com.amazonaws.bedrockdataautomation#FallbackBlueprintItems" + } + }, + "traits": { + "smithy.api#documentation": "Custom Configuration of Document" + } + }, + "com.amazonaws.bedrockdataautomation#DocumentExtractionGranularity": { + "type": "structure", + "members": { + "types": { + "target": "com.amazonaws.bedrockdataautomation#DocumentExtractionGranularityTypes" + } + }, + "traits": { + "smithy.api#documentation": "Granularity of Document Extraction" + } + }, + "com.amazonaws.bedrockdataautomation#DocumentExtractionGranularityType": { + "type": "enum", + "members": { + "DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT" + } + }, + "PAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGE" + } + }, + "ELEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ELEMENT" + } + }, + "WORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORD" + } + }, + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + } + } + }, + "com.amazonaws.bedrockdataautomation#DocumentExtractionGranularityTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#DocumentExtractionGranularityType" + }, + "traits": { + "smithy.api#documentation": "List of Document Extraction Granularity Type" + } + }, + "com.amazonaws.bedrockdataautomation#DocumentOutputAdditionalFileFormat": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Additional File Format of Document Output" + } + }, + "com.amazonaws.bedrockdataautomation#DocumentOutputFormat": { + "type": "structure", + "members": { + "textFormat": { + "target": "com.amazonaws.bedrockdataautomation#DocumentOutputTextFormat", + "traits": { + "smithy.api#required": {} + } + }, + "additionalFileFormat": { + "target": "com.amazonaws.bedrockdataautomation#DocumentOutputAdditionalFileFormat", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Output Format of Document" + } + }, + "com.amazonaws.bedrockdataautomation#DocumentOutputTextFormat": { + "type": "structure", + "members": { + "types": { + "target": "com.amazonaws.bedrockdataautomation#DocumentOutputTextFormatTypes" + } + }, + "traits": { + "smithy.api#documentation": "Text Format of Document Output" + } + }, + "com.amazonaws.bedrockdataautomation#DocumentOutputTextFormatType": { + "type": "enum", + "members": { + "PLAIN_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT" + } + }, + "MARKDOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MARKDOWN" + } + }, + "HTML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTML" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } + } + }, + "com.amazonaws.bedrockdataautomation#DocumentOutputTextFormatTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#DocumentOutputTextFormatType" + }, + "traits": { + "smithy.api#documentation": "List of Document Output Text Format Type" + } + }, + "com.amazonaws.bedrockdataautomation#DocumentOverrideConfiguration": { + "type": "structure", + "members": { + "splitter": { + "target": "com.amazonaws.bedrockdataautomation#SplitterConfiguration" + }, + "modalityProcessing": { + "target": "com.amazonaws.bedrockdataautomation#ModalityProcessingConfiguration" + }, + "sensitiveDataConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#SensitiveDataConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Override Configuration of Document" + } + }, + "com.amazonaws.bedrockdataautomation#DocumentStandardExtraction": { + "type": "structure", + "members": { + "granularity": { + "target": "com.amazonaws.bedrockdataautomation#DocumentExtractionGranularity", + "traits": { + "smithy.api#required": {} + } + }, + "boundingBox": { + "target": "com.amazonaws.bedrockdataautomation#DocumentBoundingBox", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Standard Extraction Configuration of Document" + } + }, + "com.amazonaws.bedrockdataautomation#DocumentStandardGenerativeField": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Standard Generative Field Configuration of Document" + } + }, + "com.amazonaws.bedrockdataautomation#DocumentStandardOutputConfiguration": { + "type": "structure", + "members": { + "extraction": { + "target": "com.amazonaws.bedrockdataautomation#DocumentStandardExtraction" + }, + "generativeField": { + "target": "com.amazonaws.bedrockdataautomation#DocumentStandardGenerativeField" + }, + "outputFormat": { + "target": "com.amazonaws.bedrockdataautomation#DocumentOutputFormat" + } + }, + "traits": { + "smithy.api#documentation": "Standard Output Configuration of Document" + } + }, + "com.amazonaws.bedrockdataautomation#EncryptionConfiguration": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.bedrockdataautomation#KmsKeyId", + "traits": { + "smithy.api#required": {} + } + }, + "kmsEncryptionContext": { + "target": "com.amazonaws.bedrockdataautomation#KmsEncryptionContext" + } + }, + "traits": { + "smithy.api#documentation": "KMS Encryption Configuration" + } + }, + "com.amazonaws.bedrockdataautomation#EncryptionContextKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "Encryption context key.", + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, + "com.amazonaws.bedrockdataautomation#EncryptionContextValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "Encryption context value.", + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, + "com.amazonaws.bedrockdataautomation#EntityDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "Description of the entity", + "smithy.api#length": { + "min": 0, + "max": 300 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s!\"\\#\\$%'&\\(\\)\\*\\+\\,\\-\\./:;=\\?@\\[\\\\\\]\\^_`\\{\\|\\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockdataautomation#EntityDetails": { + "type": "union", + "members": { + "vocabulary": { + "target": "com.amazonaws.bedrockdataautomation#VocabularyEntity" + } + }, + "traits": { + "smithy.api#documentation": "Detailed information about an entity" + } + }, + "com.amazonaws.bedrockdataautomation#EntityId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Unique identifier for the entity", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.bedrockdataautomation#EntityIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#EntityId" + }, + "traits": { + "smithy.api#documentation": "List of EntityId", + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockdataautomation#EntityMetadata": { + "type": "string", + "traits": { + "smithy.api#documentation": "JSON string representing relevant metadata for the entity type" + } + }, + "com.amazonaws.bedrockdataautomation#EntityType": { + "type": "enum", + "members": { + "VOCABULARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOCABULARY" + } + } + }, + "traits": { + "smithy.api#documentation": "Entity types supported in DataAutomationLibraries" + } + }, + "com.amazonaws.bedrockdataautomation#EntityTypeInfo": { + "type": "structure", + "members": { + "entityType": { + "target": "com.amazonaws.bedrockdataautomation#EntityType", + "traits": { + "smithy.api#required": {} + } + }, + "entityMetadata": { + "target": "com.amazonaws.bedrockdataautomation#EntityMetadata" + } + }, + "traits": { + "smithy.api#documentation": "Information about an entity type in the DataAutomationLibrary" + } + }, + "com.amazonaws.bedrockdataautomation#EntityTypeInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#EntityTypeInfo" + }, + "traits": { + "smithy.api#documentation": "List of info for each entity type in the DataAutomationLibrary" + } + }, + "com.amazonaws.bedrockdataautomation#EventBridgeConfiguration": { + "type": "structure", + "members": { + "eventBridgeEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Event bridge flag.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Event bridge configuration." + } + }, + "com.amazonaws.bedrockdataautomation#FallbackBlueprintItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintItem" + }, + "traits": { + "smithy.api#documentation": "List of Fallback Blueprint Items", + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockdataautomation#GetBlueprint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#GetBlueprintRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#GetBlueprintResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an existing Amazon Bedrock Data Automation Blueprint", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/blueprints/{blueprintArn}/" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetBlueprintOptimizationStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#GetBlueprintOptimizationStatusRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#GetBlueprintOptimizationStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "API used to get blueprint optimization status.", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/getBlueprintOptimizationStatus/{invocationArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetBlueprintOptimizationStatusRequest": { + "type": "structure", + "members": { + "invocationArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationInvocationArn", + "traits": { + "smithy.api#documentation": "Invocation arn.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Structure for request of GetBlueprintOptimizationStatus API.", + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationJobResource" + } + ] + } + }, + "com.amazonaws.bedrockdataautomation#GetBlueprintOptimizationStatusResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationJobStatus", + "traits": { + "smithy.api#documentation": "Job Status." + } + }, + "errorType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Error Type." + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Error Message." + } + }, + "outputConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationOutputConfiguration", + "traits": { + "smithy.api#documentation": "Output configuration." + } + } + }, + "traits": { + "smithy.api#documentation": "Response of GetBlueprintOptimizationStatus API.", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetBlueprintRequest": { + "type": "structure", + "members": { + "blueprintArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintArn", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a Blueprint is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "blueprintVersion": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintVersion", + "traits": { + "smithy.api#documentation": "Optional field to get a specific Blueprint version" + } + }, + "blueprintStage": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintStage", + "traits": { + "smithy.api#documentation": "Optional field to get a specific Blueprint stage" + } + } + }, + "traits": { + "smithy.api#documentation": "Get Blueprint Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetBlueprintResponse": { + "type": "structure", + "members": { + "blueprint": { + "target": "com.amazonaws.bedrockdataautomation#Blueprint", + "traits": { + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Blueprint Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetDataAutomationLibrary": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an existing Amazon Bedrock Data Automation Library", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/data-automation-libraries/{libraryArn}/" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryEntity": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryEntityRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryEntityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an existing entity based on entity type from the library", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/data-automation-libraries/{libraryArn}/entityType/{entityType}/entities/{entityId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryEntityRequest": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a DataAutomationLibrary is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.bedrockdataautomation#EntityType", + "traits": { + "smithy.api#documentation": "The entity type for which the entity is requested", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityId": { + "target": "com.amazonaws.bedrockdataautomation#EntityId", + "traits": { + "smithy.api#documentation": "Unique identifier for the entity", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get DataAutomationLibraryEntity Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryEntityResponse": { + "type": "structure", + "members": { + "entity": { + "target": "com.amazonaws.bedrockdataautomation#EntityDetails", + "traits": { + "smithy.api#documentation": "Detailed information about the entity" + } + } + }, + "traits": { + "smithy.api#documentation": "Get DataAutomationLibraryEntity Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "API used to get status of data automation library ingestion job", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/data-automation-libraries/{libraryArn}/library-ingestion-jobs/{jobArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryIngestionJobRequest": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a DataAutomationLibrary is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "jobArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJobArn", + "traits": { + "smithy.api#documentation": "ARN of the DataAutomationLibraryIngestionJob", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get DataAutomationLibraryIngestionJob Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryIngestionJobResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJob", + "traits": { + "smithy.api#documentation": "Contains the information of a library ingestion job" + } + } + }, + "traits": { + "smithy.api#documentation": "Get DataAutomationLibraryIngestionJob Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryRequest": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a DataAutomationLibrary is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get DataAutomationLibrary Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetDataAutomationLibraryResponse": { + "type": "structure", + "members": { + "library": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibrary", + "traits": { + "smithy.api#nestedProperties": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get DataAutomationLibrary Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetDataAutomationProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#GetDataAutomationProjectRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#GetDataAutomationProjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an existing Amazon Bedrock Data Automation Project", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/data-automation-projects/{projectArn}/" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetDataAutomationProjectRequest": { + "type": "structure", + "members": { + "projectArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectArn", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a DataAutomationProject is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectStage": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectStage", + "traits": { + "smithy.api#documentation": "Optional field to delete a specific DataAutomationProject stage" + } + } + }, + "traits": { + "smithy.api#documentation": "Get DataAutomationProject Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#GetDataAutomationProjectResponse": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProject", + "traits": { + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get DataAutomationProject Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#ImageBoundingBox": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Bounding Box Configuration of Image Extraction" + } + }, + "com.amazonaws.bedrockdataautomation#ImageExtractionCategory": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State", + "traits": { + "smithy.api#required": {} + } + }, + "types": { + "target": "com.amazonaws.bedrockdataautomation#ImageExtractionCategoryTypes" + } + }, + "traits": { + "smithy.api#documentation": "Category of Image Extraction" + } + }, + "com.amazonaws.bedrockdataautomation#ImageExtractionCategoryType": { + "type": "enum", + "members": { + "CONTENT_MODERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTENT_MODERATION" + } + }, + "TEXT_DETECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_DETECTION" + } + }, + "LOGOS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOGOS" + } + } + } + }, + "com.amazonaws.bedrockdataautomation#ImageExtractionCategoryTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#ImageExtractionCategoryType" + }, + "traits": { + "smithy.api#documentation": "List of Image Extraction Category" + } + }, + "com.amazonaws.bedrockdataautomation#ImageOverrideConfiguration": { + "type": "structure", + "members": { + "modalityProcessing": { + "target": "com.amazonaws.bedrockdataautomation#ModalityProcessingConfiguration" + }, + "sensitiveDataConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#SensitiveDataConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Override Configuration of Image" + } + }, + "com.amazonaws.bedrockdataautomation#ImageStandardExtraction": { + "type": "structure", + "members": { + "category": { + "target": "com.amazonaws.bedrockdataautomation#ImageExtractionCategory", + "traits": { + "smithy.api#required": {} + } + }, + "boundingBox": { + "target": "com.amazonaws.bedrockdataautomation#ImageBoundingBox", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Standard Extraction Configuration of Image" + } + }, + "com.amazonaws.bedrockdataautomation#ImageStandardGenerativeField": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State", + "traits": { + "smithy.api#required": {} + } + }, + "types": { + "target": "com.amazonaws.bedrockdataautomation#ImageStandardGenerativeFieldTypes" + } + }, + "traits": { + "smithy.api#documentation": "Standard Generative Field Configuration of Image" + } + }, + "com.amazonaws.bedrockdataautomation#ImageStandardGenerativeFieldType": { + "type": "enum", + "members": { + "IMAGE_SUMMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE_SUMMARY" + } + }, + "IAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAB" + } + } + } + }, + "com.amazonaws.bedrockdataautomation#ImageStandardGenerativeFieldTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#ImageStandardGenerativeFieldType" + }, + "traits": { + "smithy.api#documentation": "List of Image Standard Generative Field Type" + } + }, + "com.amazonaws.bedrockdataautomation#ImageStandardOutputConfiguration": { + "type": "structure", + "members": { + "extraction": { + "target": "com.amazonaws.bedrockdataautomation#ImageStandardExtraction" + }, + "generativeField": { + "target": "com.amazonaws.bedrockdataautomation#ImageStandardGenerativeField" + } + }, + "traits": { + "smithy.api#documentation": "Standard Output Configuration of Image" + } + }, + "com.amazonaws.bedrockdataautomation#InlinePayload": { + "type": "union", + "members": { + "upsertEntitiesInfo": { + "target": "com.amazonaws.bedrockdataautomation#UpsertEntitiesInfo" + }, + "deleteEntitiesInfo": { + "target": "com.amazonaws.bedrockdataautomation#DeleteEntitiesInfo" + } + }, + "traits": { + "smithy.api#documentation": "Input payload structure definition" + } + }, + "com.amazonaws.bedrockdataautomation#InputConfiguration": { + "type": "structure", + "members": { + "s3Object": { + "target": "com.amazonaws.bedrockdataautomation#S3Object", + "traits": { + "smithy.api#documentation": "S3 object" + } + }, + "inlinePayload": { + "target": "com.amazonaws.bedrockdataautomation#InlinePayload", + "traits": { + "smithy.api#documentation": "Input Payload" + } + } + }, + "traits": { + "smithy.api#documentation": "Input configuration for DataAutomationLibraryIngestionJob" + } + }, + "com.amazonaws.bedrockdataautomation#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockdataautomation#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown if there was an unexpected error during processing of request", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockdataautomation#InvokeBlueprintOptimizationAsync": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#InvokeBlueprintOptimizationAsyncRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#InvokeBlueprintOptimizationAsyncResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Invoke an async job to perform Blueprint Optimization", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/invokeBlueprintOptimizationAsync" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockdataautomation#InvokeBlueprintOptimizationAsyncRequest": { + "type": "structure", + "members": { + "blueprint": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationObject", + "traits": { + "smithy.api#documentation": "Blueprint to be optimized", + "smithy.api#required": {} + } + }, + "samples": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationSamples", + "traits": { + "smithy.api#documentation": "List of Blueprint Optimization Samples", + "smithy.api#required": {} + } + }, + "outputConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationOutputConfiguration", + "traits": { + "smithy.api#documentation": "Output configuration where the results should be placed", + "smithy.api#required": {} + } + }, + "dataAutomationProfileArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProfileArn", + "traits": { + "smithy.api#documentation": "Data automation profile ARN", + "smithy.api#required": {} + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "Encryption configuration." + } + }, + "tags": { + "target": "com.amazonaws.bedrockdataautomation#TagList", + "traits": { + "smithy.api#documentation": "List of tags." + } + } + }, + "traits": { + "smithy.api#documentation": "Invoke Blueprint Optimization Async Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#InvokeBlueprintOptimizationAsyncResponse": { + "type": "structure", + "members": { + "invocationArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationInvocationArn", + "traits": { + "smithy.api#documentation": "ARN of the blueprint optimization job", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Invoke Blueprint Optimization Async Response", + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockdataautomation#BlueprintOptimizationJobResource" + } + ] + } + }, + "com.amazonaws.bedrockdataautomation#InvokeDataAutomationLibraryIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#InvokeDataAutomationLibraryIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#InvokeDataAutomationLibraryIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ConflictException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Async API: Invoke data automation library ingestion job", + "smithy.api#http": { + "code": 201, + "method": "PUT", + "uri": "/data-automation-libraries/{libraryArn}/library-ingestion-jobs/" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockdataautomation#InvokeDataAutomationLibraryIngestionJobRequest": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a DataAutomationLibrary is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockdataautomation#ClientToken", + "traits": { + "smithy.api#documentation": "Idempotency token", + "smithy.api#idempotencyToken": {} + } + }, + "inputConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#InputConfiguration", + "traits": { + "smithy.api#documentation": "Input configuration of DataAutomationLibraryIngestionJob request", + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.bedrockdataautomation#EntityType", + "traits": { + "smithy.api#documentation": "The entity type for which DataAutomationLibraryIngestionJob is being run", + "smithy.api#required": {} + } + }, + "operationType": { + "target": "com.amazonaws.bedrockdataautomation#LibraryIngestionJobOperationType", + "traits": { + "smithy.api#documentation": "The operation to be performed by DataAutomationLibraryIngestionJob", + "smithy.api#required": {} + } + }, + "outputConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#OutputConfiguration", + "traits": { + "smithy.api#documentation": "Output configuration of DataAutomationLibraryIngestionJob", + "smithy.api#required": {} + } + }, + "notificationConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "Notification configuration." + } + }, + "tags": { + "target": "com.amazonaws.bedrockdataautomation#TagList", + "traits": { + "smithy.api#documentation": "List of tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Invoke DataAutomationLibraryIngestionJob Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#InvokeDataAutomationLibraryIngestionJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJobArn", + "traits": { + "smithy.api#documentation": "ARN of the DataAutomationLibraryIngestionJob" + } + } + }, + "traits": { + "smithy.api#documentation": "Invoke DataAutomationLibraryIngestionJob Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#KmsEncryptionContext": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockdataautomation#EncryptionContextKey" + }, + "value": { + "target": "com.amazonaws.bedrockdataautomation#EncryptionContextValue" + }, + "traits": { + "smithy.api#documentation": "KMS Encryption Context", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockdataautomation#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#documentation": "KMS Key Identifier", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]+$" + } + }, + "com.amazonaws.bedrockdataautomation#Language": { + "type": "enum", + "members": { + "EN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EN" + } + }, + "DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DE" + } + }, + "ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES" + } + }, + "FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FR" + } + }, + "IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT" + } + }, + "PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT" + } + }, + "JA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JA" + } + }, + "KO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KO" + } + }, + "CN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CN" + } + }, + "TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TW" + } + }, + "HK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HK" + } + } + }, + "traits": { + "smithy.api#documentation": "Supported input languages" + } + }, + "com.amazonaws.bedrockdataautomation#LibraryIngestionJobOperationType": { + "type": "enum", + "members": { + "UPSERT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPSERT" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + }, + "traits": { + "smithy.api#documentation": "DataAutomationLibraryIngestionJob operation type" + } + }, + "com.amazonaws.bedrockdataautomation#LibraryIngestionJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "COMPLETED_WITH_ERRORS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED_WITH_ERRORS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "Status of DataAutomationLibraryIngestionJob" + } + }, + "com.amazonaws.bedrockdataautomation#ListBlueprints": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#ListBlueprintsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#ListBlueprintsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all existing Amazon Bedrock Data Automation Blueprints", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/blueprints/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "blueprints" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListBlueprintsRequest": { + "type": "structure", + "members": { + "blueprintArn": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintArn" + }, + "resourceOwner": { + "target": "com.amazonaws.bedrockdataautomation#ResourceOwner" + }, + "blueprintStageFilter": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintStageFilter" + }, + "maxResults": { + "target": "com.amazonaws.bedrockdataautomation#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockdataautomation#NextToken" + }, + "projectFilter": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectFilter" + } + }, + "traits": { + "smithy.api#documentation": "List Blueprint Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListBlueprintsResponse": { + "type": "structure", + "members": { + "blueprints": { + "target": "com.amazonaws.bedrockdataautomation#Blueprints", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockdataautomation#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List Blueprint Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraries": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#ListDataAutomationLibrariesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#ListDataAutomationLibrariesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all existing Amazon Bedrock Data Automation Libraries", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/data-automation-libraries/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "libraries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListDataAutomationLibrariesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockdataautomation#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockdataautomation#NextToken" + }, + "projectFilter": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectFilter" + } + }, + "traits": { + "smithy.api#documentation": "List DataAutomationLibraries Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListDataAutomationLibrariesResponse": { + "type": "structure", + "members": { + "libraries": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibrarySummaries" + }, + "nextToken": { + "target": "com.amazonaws.bedrockdataautomation#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List DataAutomationLibraries Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraryEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraryEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraryEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all stored entities in the library", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/data-automation-libraries/{libraryArn}/entityType/{entityType}/entities/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "entities" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraryEntitiesRequest": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a DataAutomationLibrary is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.bedrockdataautomation#EntityType", + "traits": { + "smithy.api#documentation": "The entity type for which the entity list is requested", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockdataautomation#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockdataautomation#NextToken", + "traits": { + "smithy.api#documentation": "Pagination token for retrieving the next set of results" + } + } + }, + "traits": { + "smithy.api#documentation": "List DataAutomationLibraryEntities Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraryEntitiesResponse": { + "type": "structure", + "members": { + "entities": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryEntitySummaries", + "traits": { + "smithy.api#documentation": "List of entities" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockdataautomation#NextToken", + "traits": { + "smithy.api#documentation": "Pagination token for retrieving the next set of results" + } + } + }, + "traits": { + "smithy.api#documentation": "List DataAutomationLibraryEntities Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraryIngestionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraryIngestionJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraryIngestionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all data automation library ingestion jobs", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/data-automation-libraries/{libraryArn}/library-ingestion-jobs/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraryIngestionJobsRequest": { + "type": "structure", + "members": { + "libraryArn": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryArn", + "traits": { + "smithy.api#documentation": "ARN generated at the server side when a DataAutomationLibrary is created", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockdataautomation#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockdataautomation#NextToken", + "traits": { + "smithy.api#documentation": "Pagination token for retrieving the next set of results" + } + } + }, + "traits": { + "smithy.api#documentation": "List DataAutomationLibraryIngestionJobs Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListDataAutomationLibraryIngestionJobsResponse": { + "type": "structure", + "members": { + "jobs": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryIngestionJobSummaries", + "traits": { + "smithy.api#documentation": "List of data automation library ingestion jobs" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockdataautomation#NextToken", + "traits": { + "smithy.api#documentation": "Pagination token for retrieving the next set of results" + } + } + }, + "traits": { + "smithy.api#documentation": "List DataAutomationLibraryIngestionJobs Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListDataAutomationProjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#ListDataAutomationProjectsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#ListDataAutomationProjectsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all existing Amazon Bedrock Data Automation Projects", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/data-automation-projects/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "projects" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListDataAutomationProjectsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockdataautomation#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.bedrockdataautomation#NextToken" + }, + "projectStageFilter": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectStageFilter" + }, + "blueprintFilter": { + "target": "com.amazonaws.bedrockdataautomation#BlueprintFilter" + }, + "resourceOwner": { + "target": "com.amazonaws.bedrockdataautomation#ResourceOwner" + }, + "libraryFilter": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationLibraryFilter" + } + }, + "traits": { + "smithy.api#documentation": "List DataAutomationProject Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListDataAutomationProjectsResponse": { + "type": "structure", + "members": { + "projects": { + "target": "com.amazonaws.bedrockdataautomation#DataAutomationProjectSummaries", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockdataautomation#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "List DataAutomationProject Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List tags for an Amazon Bedrock Data Automation resource", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/listTagsForResource" + } + } + }, + "com.amazonaws.bedrockdataautomation#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.bedrockdataautomation#TaggableResourceArn", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.bedrockdataautomation#TagList" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Max Results", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockdataautomation#ModalityProcessingConfiguration": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State" + } + }, + "traits": { + "smithy.api#documentation": "Configuration to enable/disable processing of modality" + } + }, + "com.amazonaws.bedrockdataautomation#ModalityRoutingConfiguration": { + "type": "structure", + "members": { + "jpeg": { + "target": "com.amazonaws.bedrockdataautomation#DesiredModality" + }, + "png": { + "target": "com.amazonaws.bedrockdataautomation#DesiredModality" + }, + "mp4": { + "target": "com.amazonaws.bedrockdataautomation#DesiredModality" + }, + "mov": { + "target": "com.amazonaws.bedrockdataautomation#DesiredModality" + } + }, + "traits": { + "smithy.api#documentation": "Configuration for routing file type to desired modality" + } + }, + "com.amazonaws.bedrockdataautomation#NextToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "Pagination token", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockdataautomation#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Non Blank String", + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.bedrockdataautomation#NotificationConfiguration": { + "type": "structure", + "members": { + "eventBridgeConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#EventBridgeConfiguration", + "traits": { + "smithy.api#documentation": "Event bridge configuration.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Notification configuration." + } + }, + "com.amazonaws.bedrockdataautomation#OutputConfiguration": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrockdataautomation#S3Uri", + "traits": { + "smithy.api#documentation": "S3 Uri", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Output configuration for DataAutomationLibraryIngestionJob" + } + }, + "com.amazonaws.bedrockdataautomation#OverrideConfiguration": { + "type": "structure", + "members": { + "document": { + "target": "com.amazonaws.bedrockdataautomation#DocumentOverrideConfiguration" + }, + "image": { + "target": "com.amazonaws.bedrockdataautomation#ImageOverrideConfiguration" + }, + "video": { + "target": "com.amazonaws.bedrockdataautomation#VideoOverrideConfiguration" + }, + "audio": { + "target": "com.amazonaws.bedrockdataautomation#AudioOverrideConfiguration" + }, + "modalityRouting": { + "target": "com.amazonaws.bedrockdataautomation#ModalityRoutingConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Override configuration" + } + }, + "com.amazonaws.bedrockdataautomation#PIIEntitiesConfiguration": { + "type": "structure", + "members": { + "piiEntityTypes": { + "target": "com.amazonaws.bedrockdataautomation#PIIEntityTypes", + "traits": { + "smithy.api#documentation": "Types of PII entities to detect" + } + }, + "redactionMaskMode": { + "target": "com.amazonaws.bedrockdataautomation#PIIRedactionMaskMode", + "traits": { + "smithy.api#documentation": "Mode for redacting detected PII" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for PII entities detection and redaction" + } + }, + "com.amazonaws.bedrockdataautomation#PIIEntityType": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "All supported PII entity types", + "smithy.api#enumValue": "ALL" + } + }, + "ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A physical address, such as '100 Main Street, Anytown, USA' or 'Suite #12, Building 123'", + "smithy.api#enumValue": "ADDRESS" + } + }, + "AGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "An individual's age, including the quantity and unit of time", + "smithy.api#enumValue": "AGE" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "An individual's name. Does not include titles such as Dr., Mr., Mrs., or Miss", + "smithy.api#enumValue": "NAME" + } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "An email address, such as marymajor@email.com", + "smithy.api#enumValue": "EMAIL" + } + }, + "PHONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A phone number. Also includes fax and pager numbers", + "smithy.api#enumValue": "PHONE" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A user name that identifies an account, such as a login name, screen name, nick name, or handle", + "smithy.api#enumValue": "USERNAME" + } + }, + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "An alphanumeric string that is used as a password", + "smithy.api#enumValue": "PASSWORD" + } + }, + "DRIVER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "The number assigned to a driver's license", + "smithy.api#enumValue": "DRIVER_ID" + } + }, + "LICENSE_PLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A license plate for a vehicle issued by the state or country where the vehicle is registered", + "smithy.api#enumValue": "LICENSE_PLATE" + } + }, + "VEHICLE_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A Vehicle Identification Number (VIN) that uniquely identifies a vehicle", + "smithy.api#enumValue": "VEHICLE_IDENTIFICATION_NUMBER" + } + }, + "CREDIT_DEBIT_CARD_CVV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A three-digit card verification code (CVV) for VISA, MasterCard, and Discover cards, or four-digit for American Express", + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_CVV" + } + }, + "CREDIT_DEBIT_CARD_EXPIRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "The expiration date for a credit or debit card", + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_EXPIRY" + } + }, + "CREDIT_DEBIT_CARD_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "The number for a credit or debit card", + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_NUMBER" + } + }, + "PIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A four-digit personal identification number (PIN)", + "smithy.api#enumValue": "PIN" + } + }, + "INTERNATIONAL_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "An International Bank Account Number with specific formats for each country", + "smithy.api#enumValue": "INTERNATIONAL_BANK_ACCOUNT_NUMBER" + } + }, + "SWIFT_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A SWIFT code - standard format of Bank Identifier Code (BIC)", + "smithy.api#enumValue": "SWIFT_CODE" + } + }, + "IP_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "An IPv4 address, such as 198.51.100.0", + "smithy.api#enumValue": "IP_ADDRESS" + } + }, + "MAC_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A media access control (MAC) address - unique identifier for network interface controller", + "smithy.api#enumValue": "MAC_ADDRESS" + } + }, + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A web address, such as www.example.com", + "smithy.api#enumValue": "URL" + } + }, + "AWS_ACCESS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A unique identifier associated with AWS secret access key", + "smithy.api#enumValue": "AWS_ACCESS_KEY" + } + }, + "AWS_SECRET_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A unique identifier associated with AWS access key for signing programmatic requests", + "smithy.api#enumValue": "AWS_SECRET_KEY" + } + }, + "US_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A US bank account number, typically 10 to 12 digits long", + "smithy.api#enumValue": "US_BANK_ACCOUNT_NUMBER" + } + }, + "US_BANK_ROUTING_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A US bank account routing number, typically nine digits long", + "smithy.api#enumValue": "US_BANK_ROUTING_NUMBER" + } + }, + "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A US Individual Taxpayer Identification Number (ITIN)", + "smithy.api#enumValue": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" + } + }, + "US_PASSPORT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A US passport number, ranging from six to nine alphanumeric characters", + "smithy.api#enumValue": "US_PASSPORT_NUMBER" + } + }, + "US_SOCIAL_SECURITY_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A US Social Security Number (SSN) - nine-digit number for US citizens and residents", + "smithy.api#enumValue": "US_SOCIAL_SECURITY_NUMBER" + } + }, + "CA_HEALTH_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A Canadian Health Service Number - 10-digit unique identifier for healthcare benefits", + "smithy.api#enumValue": "CA_HEALTH_NUMBER" + } + }, + "CA_SOCIAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A Canadian Social Insurance Number (SIN) - nine-digit unique identifier", + "smithy.api#enumValue": "CA_SOCIAL_INSURANCE_NUMBER" + } + }, + "UK_NATIONAL_HEALTH_SERVICE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A UK National Health Service Number - 10-17 digit number", + "smithy.api#enumValue": "UK_NATIONAL_HEALTH_SERVICE_NUMBER" + } + }, + "UK_NATIONAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A UK National Insurance Number (NINO) for accessing National Insurance benefits", + "smithy.api#enumValue": "UK_NATIONAL_INSURANCE_NUMBER" + } + }, + "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "A UK Unique Taxpayer Reference (UTR) - 10-digit number identifying taxpayer or business", + "smithy.api#enumValue": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" + } + } + }, + "traits": { + "smithy.api#documentation": "Types of PII entities that can be detected, we will support every types that Guardrails can support" + } + }, + "com.amazonaws.bedrockdataautomation#PIIEntityTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#PIIEntityType" + }, + "traits": { + "smithy.api#documentation": "List of PII entity types", + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.bedrockdataautomation#PIIRedactionMaskMode": { + "type": "enum", + "members": { + "PII": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Replace with generic PII marker [PII]", + "smithy.api#enumValue": "PII" + } + }, + "ENTITY_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Replace with specific entity type marker, e.g. [NAME]/[SSN] etc.", + "smithy.api#enumValue": "ENTITY_TYPE" + } + } + }, + "traits": { + "smithy.api#documentation": "Mode for redacting detected PII" + } + }, + "com.amazonaws.bedrockdataautomation#Phrase": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockdataautomation#PhraseText", + "traits": { + "smithy.api#required": {} + } + }, + "displayAsText": { + "target": "com.amazonaws.bedrockdataautomation#PhraseDisplayAsText" + } + }, + "traits": { + "smithy.api#documentation": "Phrase structure for vocabulary" + } + }, + "com.amazonaws.bedrockdataautomation#PhraseDisplayAsText": { + "type": "string", + "traits": { + "smithy.api#documentation": "Text to configure how phrase is displayed in Transcript", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".+", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockdataautomation#PhraseList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#Phrase" + }, + "traits": { + "smithy.api#documentation": "List of phrases", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockdataautomation#PhraseText": { + "type": "string", + "traits": { + "smithy.api#documentation": "Text content of the phrase", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".+", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockdataautomation#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockdataautomation#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a resource referenced by the operation does not exist", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrockdataautomation#ResourceOwner": { + "type": "enum", + "members": { + "SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE" + } + }, + "ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT" + } + } + }, + "traits": { + "smithy.api#documentation": "Resource Owner" + } + }, + "com.amazonaws.bedrockdataautomation#S3Object": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrockdataautomation#S3Uri", + "traits": { + "smithy.api#documentation": "S3 uri.", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockdataautomation#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "S3 object version." + } + } + }, + "traits": { + "smithy.api#documentation": "S3 object" + } + }, + "com.amazonaws.bedrockdataautomation#S3ObjectVersion": { + "type": "string", + "traits": { + "smithy.api#documentation": "S3 object version.", + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.bedrockdataautomation#S3Uri": { + "type": "string", + "traits": { + "smithy.api#documentation": "A path in S3", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" + } + }, + "com.amazonaws.bedrockdataautomation#SensitiveDataConfiguration": { + "type": "structure", + "members": { + "detectionMode": { + "target": "com.amazonaws.bedrockdataautomation#SensitiveDataDetectionMode", + "traits": { + "smithy.api#documentation": "Mode for sensitive data detection", + "smithy.api#required": {} + } + }, + "detectionScope": { + "target": "com.amazonaws.bedrockdataautomation#SensitiveDataDetectionScope", + "traits": { + "smithy.api#documentation": "Scope of detection - what types of sensitive data to detect" + } + }, + "piiEntitiesConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#PIIEntitiesConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for PII entities detection and redaction" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for sensitive data detection and redaction" + } + }, + "com.amazonaws.bedrockdataautomation#SensitiveDataDetectionMode": { + "type": "enum", + "members": { + "DETECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Only detect sensitive data without redaction", + "smithy.api#enumValue": "DETECTION" + } + }, + "DETECTION_AND_REDACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Detect and redact sensitive data", + "smithy.api#enumValue": "DETECTION_AND_REDACTION" + } + } + }, + "traits": { + "smithy.api#documentation": "Mode for sensitive data detection" + } + }, + "com.amazonaws.bedrockdataautomation#SensitiveDataDetectionScope": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#SensitiveDataDetectionScopeType" + }, + "traits": { + "smithy.api#documentation": "Scope of sensitive data detection", + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrockdataautomation#SensitiveDataDetectionScopeType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Standard PII detection", + "smithy.api#enumValue": "STANDARD" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Custom PII detection", + "smithy.api#enumValue": "CUSTOM" + } + } + }, + "traits": { + "smithy.api#documentation": "Types of sensitive data detection scope" + } + }, + "com.amazonaws.bedrockdataautomation#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockdataautomation#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when a request is made beyond the service quota", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.bedrockdataautomation#SpeakerLabelingConfiguration": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Speaker labeling configuration" + } + }, + "com.amazonaws.bedrockdataautomation#SplitterConfiguration": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State" + } + }, + "traits": { + "smithy.api#documentation": "Configuration of Splitter" + } + }, + "com.amazonaws.bedrockdataautomation#StandardOutputConfiguration": { + "type": "structure", + "members": { + "document": { + "target": "com.amazonaws.bedrockdataautomation#DocumentStandardOutputConfiguration" + }, + "image": { + "target": "com.amazonaws.bedrockdataautomation#ImageStandardOutputConfiguration" + }, + "video": { + "target": "com.amazonaws.bedrockdataautomation#VideoStandardOutputConfiguration" + }, + "audio": { + "target": "com.amazonaws.bedrockdataautomation#AudioStandardOutputConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Standard output configuration" + } + }, + "com.amazonaws.bedrockdataautomation#State": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "State" + } + }, + "com.amazonaws.bedrockdataautomation#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrockdataautomation#TagKey", + "traits": { + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrockdataautomation#TagValue", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Key value pair of a tag" + } + }, + "com.amazonaws.bedrockdataautomation#TagKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "Defines the context of the tag.", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.bedrockdataautomation#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#TagKey" + }, + "traits": { + "smithy.api#documentation": "List of tag keys", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrockdataautomation#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomation#Tag" + }, + "traits": { + "smithy.api#documentation": "List of tags", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrockdataautomation#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomation#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomation#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomation#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomation#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Tag an Amazon Bedrock Data Automation resource", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/tagResource" + } + } + }, + "com.amazonaws.bedrockdataautomation#TagResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.bedrockdataautomation#TaggableResourceArn", + "traits": { + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockdataautomation#TagList", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomation#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomation#TagValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "Defines the value within the context. e.g.Search result to include in the message.
" } + }, + "toolAddition": { + "target": "com.amazonaws.bedrockruntime#ToolAdditionBlock" + }, + "toolRemoval": { + "target": "com.amazonaws.bedrockruntime#ToolRemovalBlock" } }, "traits": { @@ -7168,6 +7174,15 @@ "traits": { "smithy.api#documentation": "Structured output parameters to control the model's text response.
" } + }, + "effort": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The effort level for the model to use when generating a response. Higher effort levels allow the model to spend more time reasoning before responding. Supported values are low, medium, high, xhigh, and max.
When extended thinking is disabled, the effort level is capped at high. Use effort high or below, or enable thinking to use higher effort levels.
Information about a tool that you can use with the Converse API. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.
" } }, + "com.amazonaws.bedrockruntime#ToolAdditionBlock": { + "type": "structure", + "members": { + "tool": { + "target": "com.amazonaws.bedrockruntime#ToolReference", + "traits": { + "smithy.api#documentation": "A reference to the tool to add to the available tool set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A content block for adding a tool to the available tool set mid-conversation. Each block references a single tool via its tool field. Use within a system role message to make a tool available without re-sending the full tool configuration.
The type of tool reference.
", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the tool. Must match the name of a tool declared in the top-level tool configuration.
", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "serverName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the MCP server that provides the tool. Required when referencing an MCP tool.
", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to a tool in the tool configuration. Used with ToolAdditionBlock and ToolRemovalBlock to identify which tool to add or remove mid-conversation.
A reference to the tool to remove from the available tool set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A content block for removing a tool from the available tool set mid-conversation. Each block references a single tool via its tool field. Use within a system role message to remove a tool without re-sending the full tool configuration.
The request is denied because of missing access permissions.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bedrock#AccountEnforcedGuardrailConfigurationId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]+$" + } + }, + "com.amazonaws.bedrock#AccountEnforcedGuardrailInferenceInputConfiguration": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "Identifier for the guardrail, could be the ID or the ARN.
", + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", + "traits": { + "smithy.api#documentation": "Numerical guardrail version.
", + "smithy.api#required": {} + } + }, + "selectiveContentGuarding": { + "target": "com.amazonaws.bedrock#SelectiveContentGuarding", + "traits": { + "smithy.api#documentation": "Selective content guarding controls for enforced guardrails.
" + } + }, + "modelEnforcement": { + "target": "com.amazonaws.bedrock#ModelEnforcement", + "traits": { + "smithy.api#documentation": "Model-specific information for the enforced guardrail configuration. If not present, the configuration is enforced on all models
" + } + } + }, + "traits": { + "smithy.api#documentation": "Account-level enforced guardrail input configuration.
" + } + }, + "com.amazonaws.bedrock#AccountEnforcedGuardrailOutputConfiguration": { + "type": "structure", + "members": { + "configId": { + "target": "com.amazonaws.bedrock#AccountEnforcedGuardrailConfigurationId", + "traits": { + "smithy.api#documentation": "Unique ID for the account enforced configuration.
" + } + }, + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", + "traits": { + "smithy.api#documentation": "ARN representation for the guardrail.
" + } + }, + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "Unique ID for the guardrail.
" + } + }, + "inputTags": { + "target": "com.amazonaws.bedrock#InputTags", + "traits": { + "smithy.api#deprecated": { + "message": "This field is being deprecated and will be removed once customers transition their existing policies to the new schema.", + "since": "2026-04-03" + }, + "smithy.api#documentation": "Whether to honor or ignore input tags at runtime.
" + } + }, + "selectiveContentGuarding": { + "target": "com.amazonaws.bedrock#SelectiveContentGuarding", + "traits": { + "smithy.api#documentation": "Selective content guarding controls for enforced guardrails.
" + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", + "traits": { + "smithy.api#documentation": "Numerical guardrail version.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp.
" + } + }, + "createdBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the role used to update the configuration.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp.
" + } + }, + "updatedBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the role used to update the configuration.
" + } + }, + "owner": { + "target": "com.amazonaws.bedrock#ConfigurationOwner", + "traits": { + "smithy.api#documentation": "Configuration owner type.
" + } + }, + "modelEnforcement": { + "target": "com.amazonaws.bedrock#ModelEnforcement", + "traits": { + "smithy.api#documentation": "Model-specific information for the enforced guardrail configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Account enforced guardrail output configuration.
" + } + }, + "com.amazonaws.bedrock#AccountEnforcedGuardrailsOutputConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AccountEnforcedGuardrailOutputConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#AccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.bedrock#AcknowledgementFormDataBody": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 16384 + } + } + }, + "com.amazonaws.bedrock#AdditionalModelRequestFields": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrock#AdditionalModelRequestFieldsKey" + }, + "value": { + "target": "com.amazonaws.bedrock#AdditionalModelRequestFieldsValue" + } + }, + "com.amazonaws.bedrock#AdditionalModelRequestFieldsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrock#AdditionalModelRequestFieldsValue": { + "type": "document" + }, + "com.amazonaws.bedrock#AdvancedPromptOptimizationInputConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI of the JSONL input file containing prompt templates and evaluation samples.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the input data configuration for an advanced prompt optimization job.
" + } + }, + "com.amazonaws.bedrock#AdvancedPromptOptimizationJobArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an advanced prompt optimization job.
", + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:advanced-prompt-optimization-job/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#AdvancedPromptOptimizationJobDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "The description of an advanced prompt optimization job.
", + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.bedrock#AdvancedPromptOptimizationJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#documentation": "The ARN or ID of an advanced prompt optimization job.
", + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^((arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:advanced-prompt-optimization-job/)?[a-z0-9]{12})$" + } + }, + "com.amazonaws.bedrock#AdvancedPromptOptimizationJobIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobIdentifier" + }, + "traits": { + "smithy.api#documentation": "A list of advanced prompt optimization job identifiers.
", + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bedrock#AdvancedPromptOptimizationJobName": { + "type": "string", + "traits": { + "smithy.api#documentation": "The name of an advanced prompt optimization job.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9.+-]*$" + } + }, + "com.amazonaws.bedrock#AdvancedPromptOptimizationJobResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJob" + }, + { + "target": "com.amazonaws.bedrock#CreateAdvancedPromptOptimizationJob" + }, + { + "target": "com.amazonaws.bedrock#GetAdvancedPromptOptimizationJob" + }, + { + "target": "com.amazonaws.bedrock#ListAdvancedPromptOptimizationJobs" + }, + { + "target": "com.amazonaws.bedrock#StopAdvancedPromptOptimizationJob" + } + ] + }, + "com.amazonaws.bedrock#AdvancedPromptOptimizationJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "PARTIALLY_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PartiallyCompleted" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of an advanced prompt optimization job.
" + } + }, + "com.amazonaws.bedrock#AdvancedPromptOptimizationJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobSummary" + }, + "traits": { + "smithy.api#documentation": "A list of advanced prompt optimization job summaries.
" + } + }, + "com.amazonaws.bedrock#AdvancedPromptOptimizationJobSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobName", + "traits": { + "smithy.api#documentation": "The name of the job.
", + "smithy.api#required": {} + } + }, + "jobStatus": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobStatus", + "traits": { + "smithy.api#documentation": "The status of the job.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the job was created.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the job was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a summary of an advanced prompt optimization job.
" + } + }, + "com.amazonaws.bedrock#AdvancedPromptOptimizationOutputConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3UriFolder", + "traits": { + "smithy.api#documentation": "The S3 URI prefix where the optimization results will be written.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the output data configuration for an advanced prompt optimization job.
" + } + }, + "com.amazonaws.bedrock#AgreementAvailability": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#AgreementStatus", + "traits": { + "smithy.api#documentation": "Status of the agreement.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Error message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the agreement availability
" + } + }, + "com.amazonaws.bedrock#AgreementStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_AVAILABLE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, + "com.amazonaws.bedrock#AllowlistResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#GetUseCaseForModelAccess" + }, + { + "target": "com.amazonaws.bedrock#PutUseCaseForModelAccess" + } + ] + }, + "com.amazonaws.bedrock#AmazonBedrockControlPlaneService": { + "type": "service", + "version": "2023-04-20", + "resources": [ + { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobResource" + }, + { + "target": "com.amazonaws.bedrock#AllowlistResource" + }, + { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + }, + { + "target": "com.amazonaws.bedrock#BedrockMarketplaceResource" + }, + { + "target": "com.amazonaws.bedrock#CustomModelDeploymentResource" + }, + { + "target": "com.amazonaws.bedrock#CustomModelResource" + }, + { + "target": "com.amazonaws.bedrock#DataRetentionResource" + }, + { + "target": "com.amazonaws.bedrock#EnforcedGuardrailConfigurationResource" + }, + { + "target": "com.amazonaws.bedrock#EvaluationJobResource" + }, + { + "target": "com.amazonaws.bedrock#GuardrailsResource" + }, + { + "target": "com.amazonaws.bedrock#InferenceProfileResource" + }, + { + "target": "com.amazonaws.bedrock#LoggingResource" + }, + { + "target": "com.amazonaws.bedrock#ModelCopyResource" + }, + { + "target": "com.amazonaws.bedrock#ModelImportResource" + }, + { + "target": "com.amazonaws.bedrock#ModelInvocationJobResource" + }, + { + "target": "com.amazonaws.bedrock#ModelResource" + }, + { + "target": "com.amazonaws.bedrock#PromptRouterResource" + }, + { + "target": "com.amazonaws.bedrock#ProvisionedModelThroughputResource" + }, + { + "target": "com.amazonaws.bedrock#ResourcePolicyResource" + }, + { + "target": "com.amazonaws.bedrock#SubscriptionResource" + }, + { + "target": "com.amazonaws.bedrock#TaggingResource" + }, + { + "target": "com.amazonaws.bedrock#TrainingResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Bedrock", + "endpointPrefix": "bedrock" + }, + "aws.auth#sigv4": { + "name": "bedrock" + }, + "aws.protocols#restJson1": {}, + "smithy.api#auth": [ + "aws.auth#sigv4", + "smithy.api#httpBearerAuth" + ], + "smithy.api#documentation": "Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.
", + "smithy.api#httpBearerAuth": {}, + "smithy.api#title": "Amazon Bedrock", + "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 + ] + } + ], + "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://bedrock-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://bedrock-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://bedrock.{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://bedrock.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 13, + "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" + }, + "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": [], + "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" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-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://bedrock-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://bedrock.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-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://bedrock-fips.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://bedrock.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://bedrock.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 enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-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://bedrock.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.bedrock#ApplicationType": { + "type": "enum", + "members": { + "MODEL_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ModelEvaluation" + } + }, + "RAG_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RagEvaluation" + } + } + } + }, + "com.amazonaws.bedrock#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrock#AttributeType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + }, + "STRING_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING_LIST" + } + } + } + }, + "com.amazonaws.bedrock#AuthorizationStatus": { + "type": "enum", + "members": { + "AUTHORIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZED" + } + }, + "NOT_AUTHORIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_AUTHORIZED" + } + } + } + }, + "com.amazonaws.bedrock#AutomatedEvaluationConfig": { + "type": "structure", + "members": { + "datasetMetricConfigs": { + "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs", + "traits": { + "smithy.api#documentation": "Configuration details of the prompt datasets and metrics you want to use for your evaluation job.
", + "smithy.api#required": {} + } + }, + "evaluatorModelConfig": { + "target": "com.amazonaws.bedrock#EvaluatorModelConfig", + "traits": { + "smithy.api#documentation": "Contains the evaluator model configuration details. EvaluatorModelConfig is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.
Defines the configuration of custom metrics to be used in an evaluation job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details of an automated evaluation job. The EvaluationDatasetMetricConfig object is used to specify the prompt datasets, task type, and metric names.
Defines a list of custom metrics to be used in an Amazon Bedrock evaluation job.
", + "smithy.api#required": {} + } + }, + "evaluatorModelConfig": { + "target": "com.amazonaws.bedrock#CustomMetricEvaluatorModelConfig", + "traits": { + "smithy.api#documentation": "Configuration of the evaluator model you want to use to evaluate custom metrics in an Amazon Bedrock evaluation job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the configuration of custom metrics to be used in an evaluation job. To learn more about using custom metrics in Amazon Bedrock evaluation jobs, see Create a prompt for a custom metrics (LLM-as-a-judge model evaluations) and Create a prompt for a custom metrics (RAG evaluations).
" + } + }, + "com.amazonaws.bedrock#AutomatedEvaluationCustomMetricSource": { + "type": "union", + "members": { + "customMetricDefinition": { + "target": "com.amazonaws.bedrock#CustomMetricDefinition", + "traits": { + "smithy.api#documentation": "The definition of a custom metric for use in an Amazon Bedrock evaluation job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An array item definining a single custom metric for use in an Amazon Bedrock evaluation job.
" + } + }, + "com.amazonaws.bedrock#AutomatedEvaluationCustomMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedEvaluationCustomMetricSource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckDifferenceScenarioList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckScenario" + }, + "traits": { + "smithy.api#length": { + "max": 2 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckFinding": { + "type": "union", + "members": { + "valid": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckValidFinding", + "traits": { + "smithy.api#documentation": "Indicates that the claims are true. The claims are implied by the premises and the Automated Reasoning policy. Given the Automated Reasoning policy and premises, it is not possible for these claims to be false.
" + } + }, + "invalid": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckInvalidFinding", + "traits": { + "smithy.api#documentation": "Indicates that the claims are false. The claims are not implied by the premises and Automated Reasoning policy. Furthermore, there exist different claims that are consistent with the premises and Automated Reasoning policy.
" + } + }, + "satisfiable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckSatisfiableFinding", + "traits": { + "smithy.api#documentation": "Indicates that the claims can be true or false. It depends on what assumptions are made for the claim to be implied from the premises and Automated Reasoning policy rules. In this situation, different assumptions can make input claims false and alternative claims true.
" + } + }, + "impossible": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckImpossibleFinding", + "traits": { + "smithy.api#documentation": "Indicates that Automated Reasoning cannot make a statement about the claims. This can happen if the premises are logically incorrect, or if there is a conflict within the Automated Reasoning policy itself.
" + } + }, + "translationAmbiguous": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationAmbiguousFinding", + "traits": { + "smithy.api#documentation": "Indicates that an ambiguity was detected in the translation, making it unsound to continue with validity checking. Additional context or follow-up questions might be needed to get translation to succeed.
" + } + }, + "tooComplex": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTooComplexFinding", + "traits": { + "smithy.api#documentation": "Indicates that the input contains too much information for Automated Reasoning to process within its latency limits.
" + } + }, + "noTranslations": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckNoTranslationsFinding", + "traits": { + "smithy.api#documentation": "Identifies that some or all of the input prompt wasn't translated into logic. This can happen if the input isn't relevant to the Automated Reasoning policy, or if the policy doesn't have variables to model relevant input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the result of an Automated Reasoning validation check, indicating whether the content is logically valid, invalid, or falls into other categories based on the policy rules.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckFindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckFinding" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckImpossibleFinding": { + "type": "structure", + "members": { + "translation": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslation", + "traits": { + "smithy.api#documentation": "The logical translation of the input that this finding evaluates.
" + } + }, + "contradictingRules": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckRuleList", + "traits": { + "smithy.api#documentation": "The automated reasoning policy rules that contradict the claims and/or premises in the input.
" + } + }, + "logicWarning": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarning", + "traits": { + "smithy.api#documentation": "Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates that no valid claims can be made due to logical contradictions in the premises or rules.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckInputTextReference": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrock#AutomatedReasoningNaturalLanguageStatementContent", + "traits": { + "smithy.api#documentation": "The specific text from the original input that this reference points to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "References a portion of the original input text that corresponds to logical elements.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckInputTextReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckInputTextReference" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckInvalidFinding": { + "type": "structure", + "members": { + "translation": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslation", + "traits": { + "smithy.api#documentation": "The logical translation of the input that this finding invalidates.
" + } + }, + "contradictingRules": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckRuleList", + "traits": { + "smithy.api#documentation": "The automated reasoning policy rules that contradict the claims in the input.
" + } + }, + "logicWarning": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarning", + "traits": { + "smithy.api#documentation": "Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates that the claims are logically false and contradictory to the established rules or premises.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarning": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarningType", + "traits": { + "smithy.api#documentation": "The category of the detected logical issue, such as statements that are always true or always false.
" + } + }, + "premises": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatementList", + "traits": { + "smithy.api#documentation": "The logical statements that serve as premises under which the claims are validated.
" + } + }, + "claims": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatementList", + "traits": { + "smithy.api#documentation": "The logical statements that are validated while assuming the policy and premises.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Identifies logical issues in the translated statements that exist independent of any policy rules, such as statements that are always true or always false.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarningType": { + "type": "enum", + "members": { + "ALWAYS_TRUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS_TRUE" + } + }, + "ALWAYS_FALSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS_FALSE" + } + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckNoTranslationsFinding": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Indicates that no relevant logical information could be extracted from the input for validation.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckResult": { + "type": "enum", + "members": { + "VALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALID" + } + }, + "INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID" + } + }, + "SATISFIABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SATISFIABLE" + } + }, + "IMPOSSIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPOSSIBLE" + } + }, + "TRANSLATION_AMBIGUOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSLATION_AMBIGUOUS" + } + }, + "TOO_COMPLEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOO_COMPLEX" + } + }, + "NO_TRANSLATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_TRANSLATION" + } + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckRule": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the automated reasoning rule.
" + } + }, + "policyVersionArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The ARN of the automated reasoning policy version that contains this rule.
" + } + } + }, + "traits": { + "smithy.api#documentation": "References a specific automated reasoning policy rule that was applied during evaluation.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckRule" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckSatisfiableFinding": { + "type": "structure", + "members": { + "translation": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslation", + "traits": { + "smithy.api#documentation": "The logical translation of the input that this finding evaluates.
" + } + }, + "claimsTrueScenario": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckScenario", + "traits": { + "smithy.api#documentation": "An example scenario demonstrating how the claims could be logically true.
" + } + }, + "claimsFalseScenario": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckScenario", + "traits": { + "smithy.api#documentation": "An example scenario demonstrating how the claims could be logically false.
" + } + }, + "logicWarning": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarning", + "traits": { + "smithy.api#documentation": "Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates that the claims could be either true or false depending on additional assumptions not provided in the input.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckScenario": { + "type": "structure", + "members": { + "statements": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatementList", + "traits": { + "smithy.api#documentation": "List of logical assignments and statements that define this scenario.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a logical scenario where claims can be evaluated as true or false, containing specific logical assignments.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckTooComplexFinding": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Indicates that the input exceeds the processing capacity due to the volume or complexity of the logical information.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckTranslation": { + "type": "structure", + "members": { + "premises": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatementList", + "traits": { + "smithy.api#documentation": "The logical statements that serve as the foundation or assumptions for the claims.
" + } + }, + "claims": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatementList", + "traits": { + "smithy.api#documentation": "The logical statements that are being validated against the premises and policy rules.
", + "smithy.api#required": {} + } + }, + "untranslatedPremises": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckInputTextReferenceList", + "traits": { + "smithy.api#documentation": "References to portions of the original input text that correspond to the premises but could not be fully translated.
" + } + }, + "untranslatedClaims": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckInputTextReferenceList", + "traits": { + "smithy.api#documentation": "References to portions of the original input text that correspond to the claims but could not be fully translated.
" + } + }, + "confidence": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationConfidence", + "traits": { + "smithy.api#documentation": "A confidence score between 0 and 1 indicating how certain the system is about the logical translation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the logical translation of natural language input into formal logical statements, including premises, claims, and confidence scores.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationAmbiguousFinding": { + "type": "structure", + "members": { + "options": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationOptionList", + "traits": { + "smithy.api#documentation": "Different logical interpretations that were detected during translation of the input.
" + } + }, + "differenceScenarios": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckDifferenceScenarioList", + "traits": { + "smithy.api#documentation": "Scenarios showing how the different translation options differ in meaning.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates that the input has multiple valid logical interpretations, requiring additional context or clarification.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationConfidence": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslation" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationOption": { + "type": "structure", + "members": { + "translations": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationList", + "traits": { + "smithy.api#documentation": "Different logical interpretations that were detected during translation of the input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents one possible logical interpretation of ambiguous input content.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationOption" + }, + "traits": { + "smithy.api#length": { + "max": 2 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckValidFinding": { + "type": "structure", + "members": { + "translation": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslation", + "traits": { + "smithy.api#documentation": "The logical translation of the input that this finding validates.
" + } + }, + "claimsTrueScenario": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckScenario", + "traits": { + "smithy.api#documentation": "An example scenario demonstrating how the claims are logically true.
" + } + }, + "supportingRules": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckRuleList", + "traits": { + "smithy.api#documentation": "The automated reasoning policy rules that support why this result is considered valid.
" + } + }, + "logicWarning": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarning", + "traits": { + "smithy.api#documentation": "Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates that the claims are definitively true and logically implied by the premises, with no possible alternative interpretations.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningConfidenceFilterThreshold": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningLogicStatement": { + "type": "structure", + "members": { + "logic": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatementContent", + "traits": { + "smithy.api#documentation": "The formal logic representation of the statement using mathematical notation and logical operators.
", + "smithy.api#required": {} + } + }, + "naturalLanguage": { + "target": "com.amazonaws.bedrock#AutomatedReasoningNaturalLanguageStatementContent", + "traits": { + "smithy.api#documentation": "The natural language representation of the logical statement, providing a human-readable interpretation of the formal logic.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a logical statement that can be expressed both in formal logic notation and natural language, providing dual representations for better understanding and validation.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningLogicStatementContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningLogicStatementList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatement" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningNaturalLanguageStatementContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAccuracyScore": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0.0, + "max": 1.0 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddRuleAnnotation": { + "type": "structure", + "members": { + "expression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleExpression", + "traits": { + "smithy.api#documentation": "The formal logical expression that defines the rule, using mathematical notation and referencing policy variables and types.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for adding a new rule to an Automated Reasoning policy using a formal logical expression.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation": { + "type": "structure", + "members": { + "naturalLanguage": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationRuleNaturalLanguage", + "traits": { + "smithy.api#documentation": "The natural language description of the rule that should be converted into a formal logical expression.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for adding a new rule to the policy by converting a natural language description into a formal logical expression.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddRuleMutation": { + "type": "structure", + "members": { + "rule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule", + "traits": { + "smithy.api#documentation": "The rule definition that specifies the formal logical expression and metadata for the new rule being added to the policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mutation operation that adds a new rule to the policy definition during the build process.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddTypeAnnotation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", + "traits": { + "smithy.api#documentation": "The name of the new custom type. This name will be used to reference the type in variable definitions and rules.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeDescription", + "traits": { + "smithy.api#documentation": "A description of what the custom type represents and how it should be used in the policy.
", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueList", + "traits": { + "smithy.api#documentation": "The list of possible values that variables of this type can take, each with its own description and identifier.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for adding a new custom type to an Automated Reasoning policy, defining a set of possible values for variables.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddTypeMutation": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType", + "traits": { + "smithy.api#documentation": "The type definition that specifies the name, description, and possible values for the new custom type being added to the policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mutation operation that adds a new custom type to the policy definition during the build process.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddTypeValue": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName", + "traits": { + "smithy.api#documentation": "The identifier or name of the new value to add to the type.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueDescription", + "traits": { + "smithy.api#documentation": "A description of what this new type value represents and when it should be used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a single value that can be added to an existing custom type in the policy.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddVariableAnnotation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", + "traits": { + "smithy.api#documentation": "The name of the new variable. This name will be used to reference the variable in rule expressions.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", + "traits": { + "smithy.api#documentation": "The type of the variable, which can be a built-in type (like string or number) or a custom type defined in the policy.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableDescription", + "traits": { + "smithy.api#documentation": "A description of what the variable represents and how it should be used in rules.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for adding a new variable to an Automated Reasoning policy, which can be used in rule expressions.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddVariableMutation": { + "type": "structure", + "members": { + "variable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable", + "traits": { + "smithy.api#documentation": "The variable definition that specifies the name, type, and description for the new variable being added to the policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mutation operation that adds a new variable to the policy definition during the build process.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotatedChunk": { + "type": "structure", + "members": { + "pageNumber": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The page number where this chunk begins, if the document is divided into pages.
" + } + }, + "content": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotatedContentList", + "traits": { + "smithy.api#documentation": "The lines of text contained within this chunk, each annotated with its line number.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a portion of a source document with line number annotations. Chunks help organize document content for easier navigation and reference.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotatedChunkList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotatedChunk" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotatedContent": { + "type": "union", + "members": { + "line": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotatedLine", + "traits": { + "smithy.api#documentation": "An annotated line of text from the source document, including both the line number and the text content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a content element within an annotated chunk. This union type allows for different types of content elements to be included in document chunks, such as individual lines of text with their line numbers.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotatedContentList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotatedContent" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotatedLine": { + "type": "structure", + "members": { + "lineNumber": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The line number of this text within the source document.
" + } + }, + "lineText": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyLineText", + "traits": { + "smithy.api#documentation": "The actual text content of this line from the source document.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a single line of text from a source document, annotated with its line number for precise referencing.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotation": { + "type": "union", + "members": { + "addType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddTypeAnnotation", + "traits": { + "smithy.api#documentation": "An operation to add a new custom type to the policy, defining a set of possible values for policy variables.
" + } + }, + "updateType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateTypeAnnotation", + "traits": { + "smithy.api#documentation": "An operation to modify an existing custom type in the policy, such as changing its name, description, or allowed values.
" + } + }, + "deleteType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteTypeAnnotation", + "traits": { + "smithy.api#documentation": "An operation to remove a custom type from the policy. The type must not be referenced by any variables or rules.
" + } + }, + "addVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddVariableAnnotation", + "traits": { + "smithy.api#documentation": "An operation to add a new variable to the policy, which can be used in rule expressions to represent dynamic values.
" + } + }, + "updateVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateVariableAnnotation", + "traits": { + "smithy.api#documentation": "An operation to modify an existing variable in the policy, such as changing its name, type, or description.
" + } + }, + "deleteVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteVariableAnnotation", + "traits": { + "smithy.api#documentation": "An operation to remove a variable from the policy. The variable must not be referenced by any rules.
" + } + }, + "addRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddRuleAnnotation", + "traits": { + "smithy.api#documentation": "An operation to add a new logical rule to the policy using formal mathematical expressions.
" + } + }, + "updateRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateRuleAnnotation", + "traits": { + "smithy.api#documentation": "An operation to modify an existing rule in the policy, such as changing its logical expression or conditions.
" + } + }, + "deleteRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteRuleAnnotation", + "traits": { + "smithy.api#documentation": "An operation to remove a rule from the policy.
" + } + }, + "addRuleFromNaturalLanguage": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation", + "traits": { + "smithy.api#documentation": "An operation to add a new rule by converting natural language descriptions into formal logical expressions.
" + } + }, + "updateFromRulesFeedback": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation", + "traits": { + "smithy.api#documentation": "An operation to update the policy based on feedback about how specific rules performed during testing or validation.
" + } + }, + "updateFromScenarioFeedback": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation", + "traits": { + "smithy.api#documentation": "An operation to update the policy based on feedback about how it performed on specific test scenarios.
" + } + }, + "ingestContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyIngestContentAnnotation", + "traits": { + "smithy.api#documentation": "An operation to process and incorporate new content into the policy, extracting additional rules and concepts.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the various operations that can be performed on an Automated Reasoning policy, including adding, updating, and deleting rules, variables, and types.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationFeedbackNaturalLanguage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationIngestContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 4096 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationRuleNaturalLanguage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationStatus": { + "type": "enum", + "members": { + "APPLIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLIED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAtomicStatement": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyStatementId", + "traits": { + "smithy.api#documentation": "A unique identifier for this atomic statement within the fidelity report.
", + "smithy.api#required": {} + } + }, + "text": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyStatementText", + "traits": { + "smithy.api#documentation": "The actual text content of the atomic statement as extracted from the source document.
", + "smithy.api#required": {} + } + }, + "location": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyStatementLocation", + "traits": { + "smithy.api#documentation": "Information about where this statement appears in the source document, including line numbers.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a single, indivisible statement extracted from a source document. Atomic statements are the fundamental units used to ground policy rules and variables to their source material.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAtomicStatementList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAtomicStatement" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentContentType": { + "type": "enum", + "members": { + "PDF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pdf" + } + }, + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "txt" + } + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 4000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildFeedback": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 4000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildLog": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildLogEntryList", + "traits": { + "smithy.api#documentation": "A list of log entries documenting each step in the policy build process, including timestamps, status, and detailed messages.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains detailed logging information about the policy build process, including steps taken, decisions made, and any issues encountered.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildLogEntry": { + "type": "structure", + "members": { + "annotation": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotation", + "traits": { + "smithy.api#documentation": "The annotation or operation that was being processed when this log entry was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationStatus", + "traits": { + "smithy.api#documentation": "The status of the build step (e.g., SUCCESS, FAILED, IN_PROGRESS).
", + "smithy.api#required": {} + } + }, + "buildSteps": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepList", + "traits": { + "smithy.api#documentation": "Detailed information about the specific build steps that were executed, including any sub-operations or transformations.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a single entry in the policy build log, containing information about a specific step or event in the build process.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildLogEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildLogEntry" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildMessageType": { + "type": "enum", + "members": { + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARNING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-fA-F\\-]+$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetManifest": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetManifestList", + "traits": { + "smithy.api#documentation": "The list of asset entries in the manifest, each describing an available artifact that can be retrieved.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A catalog of all artifacts produced by a build workflow, providing a comprehensive list of available assets including their types and identifiers.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetManifestEntry": { + "type": "structure", + "members": { + "assetType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetType", + "traits": { + "smithy.api#documentation": "The type of asset (e.g., BUILD_LOG, QUALITY_REPORT, POLICY_DEFINITION, GENERATED_TEST_CASES, POLICY_SCENARIOS, FIDELITY_REPORT, ASSET_MANIFEST, SOURCE_DOCUMENT).
", + "smithy.api#required": {} + } + }, + "assetName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetName", + "traits": { + "smithy.api#documentation": "A human-readable name for the asset, if applicable. This helps identify specific documents or reports within the workflow results.
" + } + }, + "assetId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetId", + "traits": { + "smithy.api#documentation": "A unique identifier for the asset, if applicable. Use this ID when requesting specific assets through the API.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a single entry in the asset manifest, describing one artifact produced by the build workflow.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetManifestList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetManifestEntry" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetType": { + "type": "enum", + "members": { + "BUILD_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUILD_LOG" + } + }, + "QUALITY_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUALITY_REPORT" + } + }, + "POLICY_DEFINITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLICY_DEFINITION" + } + }, + "GENERATED_TEST_CASES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERATED_TEST_CASES" + } + }, + "POLICY_SCENARIOS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLICY_SCENARIOS" + } + }, + "FIDELITY_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIDELITY_REPORT" + } + }, + "ASSET_MANIFEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSET_MANIFEST" + } + }, + "SOURCE_DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_DOCUMENT" + } + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssets": { + "type": "union", + "members": { + "policyDefinition": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition", + "traits": { + "smithy.api#documentation": "The complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents.
" + } + }, + "qualityReport": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionQualityReport", + "traits": { + "smithy.api#documentation": "A comprehensive report analyzing the quality of the generated policy, including metrics about rule coverage, potential conflicts, and unused elements.
" + } + }, + "buildLog": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildLog", + "traits": { + "smithy.api#documentation": "The complete build log containing detailed information about each step in the policy generation process.
" + } + }, + "generatedTestCases": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyGeneratedTestCases", + "traits": { + "smithy.api#documentation": "A comprehensive test suite generated by the build workflow, providing validation capabilities for automated reasoning policies.
" + } + }, + "policyScenarios": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarios", + "traits": { + "smithy.api#documentation": "An entity encompassing all the policy scenarios generated by the build workflow, which can be used to validate an Automated Reasoning policy.
" + } + }, + "assetManifest": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetManifest", + "traits": { + "smithy.api#documentation": "A manifest listing all available artifacts produced by the build workflow. This provides a catalog of all assets that can be retrieved, including their types, names, and identifiers.
" + } + }, + "document": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicySourceDocument", + "traits": { + "smithy.api#documentation": "A source document that was used as input during the build workflow. This allows you to retrieve the original documents that were processed to generate the policy.
" + } + }, + "fidelityReport": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyFidelityReport", + "traits": { + "smithy.api#documentation": "A comprehensive fidelity report that measures how accurately the generated policy represents the source documents. The report includes coverage and accuracy scores, along with detailed grounding information for rules and variables.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the various assets generated during a policy build workflow, including logs, quality reports, test cases, and the final policy definition.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStep": { + "type": "structure", + "members": { + "context": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepContext", + "traits": { + "smithy.api#documentation": "Contextual information about what was being processed during this build step, such as the type of operation or the source material being analyzed.
", + "smithy.api#required": {} + } + }, + "priorElement": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionElement", + "traits": { + "smithy.api#documentation": "Reference to the previous element or step in the build process, helping to trace the sequence of operations.
" + } + }, + "messages": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepMessageList", + "traits": { + "smithy.api#documentation": "A list of messages generated during this build step, including informational messages, warnings, and error details.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a single step in the policy build process, containing context about what was being processed and any messages or results.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepContext": { + "type": "union", + "members": { + "planning": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyPlanning", + "traits": { + "smithy.api#documentation": "Indicates that this build step was part of the planning phase, where the system determines what operations to perform.
" + } + }, + "mutation": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyMutation", + "traits": { + "smithy.api#documentation": "Indicates that this build step involved modifying the policy structure, such as adding or updating rules, variables, or types.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides context about what type of operation was being performed during a build step.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStep" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepMessage": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The content of the message, describing what occurred during the build step.
", + "smithy.api#required": {} + } + }, + "messageType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildMessageType", + "traits": { + "smithy.api#documentation": "The type of message (e.g., INFO, WARNING, ERROR) indicating its severity and purpose.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a message generated during a build step, providing information about what happened or any issues encountered.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepMessageList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepMessage" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowDocument": { + "type": "structure", + "members": { + "document": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentBlob", + "traits": { + "smithy.api#documentation": "The actual content of the source document that will be analyzed to extract policy rules and concepts.
", + "smithy.api#required": {} + } + }, + "documentContentType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentContentType", + "traits": { + "smithy.api#documentation": "The MIME type of the document content (e.g., text/plain, application/pdf, text/markdown).
", + "smithy.api#required": {} + } + }, + "documentName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentName", + "traits": { + "smithy.api#documentation": "A descriptive name for the document that helps identify its purpose and content.
", + "smithy.api#required": {} + } + }, + "documentDescription": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentDescription", + "traits": { + "smithy.api#documentation": "A detailed description of the document's content and how it should be used in the policy generation process.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a source document used in the policy build workflow, containing the content and metadata needed for policy generation.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowDocumentList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowDocument" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowRepairContent": { + "type": "structure", + "members": { + "annotations": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationList", + "traits": { + "smithy.api#documentation": "Specific annotations or modifications to apply during the policy repair process, such as rule corrections or variable updates.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains content and instructions for repairing or improving an existing Automated Reasoning policy.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowSource": { + "type": "structure", + "members": { + "policyDefinition": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition", + "traits": { + "smithy.api#documentation": "An existing policy definition that serves as the starting point for the build workflow, typically used in policy repair or update scenarios.
" + } + }, + "workflowContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyWorkflowTypeContent", + "traits": { + "smithy.api#documentation": "The actual content to be processed in the build workflow, such as documents to analyze or repair instructions to apply.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the source content for a policy build workflow, which can include documents, repair instructions, or other input materials.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowStatus": { + "type": "enum", + "members": { + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } + }, + "CANCEL_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL_REQUESTED" + } + }, + "PREPROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPROCESSING" + } + }, + "BUILDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUILDING" + } + }, + "TESTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TESTING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowSummary": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy associated with this build workflow.
", + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowStatus", + "traits": { + "smithy.api#documentation": "The current status of the build workflow (e.g., RUNNING, COMPLETED, FAILED, CANCELLED).
", + "smithy.api#required": {} + } + }, + "buildWorkflowType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowType", + "traits": { + "smithy.api#documentation": "The type of build workflow (e.g., DOCUMENT_INGESTION, POLICY_REPAIR).
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the build workflow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the build workflow was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary of a policy build workflow, including its current status, timing information, and key identifiers.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowType": { + "type": "enum", + "members": { + "INGEST_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INGEST_CONTENT" + } + }, + "REFINE_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REFINE_POLICY" + } + }, + "IMPORT_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_POLICY" + } + }, + "GENERATE_FIDELITY_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERATE_FIDELITY_REPORT" + } + }, + "GENERATE_POLICY_SCENARIOS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERATE_POLICY_SCENARIOS" + } + }, + "RESOLVE_POLICY_AMBIGUITIES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOLVE_POLICY_AMBIGUITIES" + } + }, + "ITERATIVELY_REFINE_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ITERATIVELY_REFINE_POLICY" + } + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyConflictedRuleIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyCoverageScore": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0.0, + "max": 1.0 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition": { + "type": "structure", + "members": { + "version": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyFormatVersion", + "traits": { + "smithy.api#default": "1", + "smithy.api#documentation": "The version of the policy definition format.
" + } + }, + "types": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeList", + "traits": { + "smithy.api#documentation": "The custom user-defined vairable types used in the policy. Types are enum-based variable types that provide additional context beyond the predefined variable types.
" + } + }, + "rules": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleList", + "traits": { + "smithy.api#documentation": "The formal logic rules extracted from the source document. Rules define the logical constraints that determine whether model responses are valid, invalid, or satisfiable.
" + } + }, + "variables": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableList", + "traits": { + "smithy.api#documentation": "The variables that represent concepts in the policy. Variables can have values assigned when translating natural language into formal logic. Their descriptions are crucial for accurate translation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the formal logic rules, variables, and custom variable types that define an Automated Reasoning policy. The policy definition specifies the constraints used to validate foundation model responses for accuracy and logical consistency.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionElement": { + "type": "union", + "members": { + "policyDefinitionVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable", + "traits": { + "smithy.api#documentation": "A variable element within the policy definition that represents a concept used in logical expressions and rules.
" + } + }, + "policyDefinitionType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType", + "traits": { + "smithy.api#documentation": "A custom type element within the policy definition that defines a set of possible values for variables.
" + } + }, + "policyDefinitionRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule", + "traits": { + "smithy.api#documentation": "A rule element within the policy definition that contains a formal logical expression used for validation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a single element in an Automated Reasoning policy definition, such as a rule, variable, or type definition.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionQualityReport": { + "type": "structure", + "members": { + "typeCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of custom types defined in the policy.
", + "smithy.api#required": {} + } + }, + "variableCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of variables defined in the policy.
", + "smithy.api#required": {} + } + }, + "ruleCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of rules defined in the policy.
", + "smithy.api#required": {} + } + }, + "unusedTypes": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeNameList", + "traits": { + "smithy.api#documentation": "A list of custom types that are defined but not referenced by any variables or rules, suggesting they may be unnecessary.
", + "smithy.api#required": {} + } + }, + "unusedTypeValues": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValuePairList", + "traits": { + "smithy.api#documentation": "A list of type values that are defined but never used in any rules, indicating potential cleanup opportunities.
", + "smithy.api#required": {} + } + }, + "unusedVariables": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableNameList", + "traits": { + "smithy.api#documentation": "A list of variables that are defined but not referenced by any rules, suggesting they may be unnecessary.
", + "smithy.api#required": {} + } + }, + "conflictingRules": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyConflictedRuleIdList", + "traits": { + "smithy.api#documentation": "A list of rules that may conflict with each other, potentially leading to inconsistent policy behavior.
", + "smithy.api#required": {} + } + }, + "disjointRuleSets": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDisjointRuleSetList", + "traits": { + "smithy.api#documentation": "Groups of rules that operate on completely separate sets of variables, indicating the policy may be addressing multiple unrelated concerns.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a comprehensive analysis of the quality and completeness of an Automated Reasoning policy definition, highlighting potential issues and optimization opportunities.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the rule within the policy.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleExpression", + "traits": { + "smithy.api#documentation": "The formal logic expression of the rule.
", + "smithy.api#required": {} + } + }, + "alternateExpression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleAlternateExpression", + "traits": { + "smithy.api#documentation": "The human-readable form of the rule expression, often in natural language or simplified notation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a formal logic rule in an Automated Reasoning policy. For example, rules can be expressed as if-then statements that define logical constraints.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleAlternateExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[A-Z][0-9A-Z]{11}$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1500 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", + "traits": { + "smithy.api#documentation": "The name of the custom type.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeDescription", + "traits": { + "smithy.api#documentation": "The description of what the custom type represents.
" + } + }, + "values": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueList", + "traits": { + "smithy.api#documentation": "The possible values for this enum-based type, each with its own description.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a custom user-defined viarble type in an Automated Reasoning policy. Types are enum-based and provide additional context beyond predefined variable types.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValue": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName", + "traits": { + "smithy.api#documentation": "The actual value or identifier for this type value.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueDescription", + "traits": { + "smithy.api#documentation": "A human-readable description explaining what this type value represents and when it should be used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a single value within a custom type definition, including its identifier and description.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 150 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_]*$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValuePair": { + "type": "structure", + "members": { + "typeName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", + "traits": { + "smithy.api#documentation": "The name of the custom type that contains the referenced value.
", + "smithy.api#required": {} + } + }, + "valueName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName", + "traits": { + "smithy.api#documentation": "The name of the specific value within the type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Associates a type name with a specific value name, used for referencing type values in rules and other policy elements.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValuePairList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValuePair" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 22500 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", + "traits": { + "smithy.api#documentation": "The name of the variable. Use descriptive names that clearly indicate the concept being represented.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", + "traits": { + "smithy.api#documentation": "The data type of the variable. Valid types include bool, int, real, enum, and custom types that you can provide.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableDescription", + "traits": { + "smithy.api#documentation": "The description of the variable that explains what it represents and how users might refer to it. Clear and comprehensive descriptions are essential for accurate natural language translation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a variable in an Automated Reasoning policy. Variables represent concepts that can have values assigned during natural language translation.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 600 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 600 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteRuleAnnotation": { + "type": "structure", + "members": { + "ruleId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the rule to delete from the policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for removing a rule from an Automated Reasoning policy.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteRuleMutation": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the rule to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mutation operation that removes a rule from the policy definition during the build process.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteTypeAnnotation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", + "traits": { + "smithy.api#documentation": "The name of the custom type to delete from the policy. The type must not be referenced by any variables or rules.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for removing a custom type from an Automated Reasoning policy.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteTypeMutation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", + "traits": { + "smithy.api#documentation": "The name of the custom type to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mutation operation that removes a custom type from the policy definition during the build process.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteTypeValue": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName", + "traits": { + "smithy.api#documentation": "The identifier or name of the value to remove from the type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a value to be removed from an existing custom type in the policy.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteVariableAnnotation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", + "traits": { + "smithy.api#documentation": "The name of the variable to delete from the policy. The variable must not be referenced by any rules.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for removing a variable from an Automated Reasoning policy.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteVariableMutation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", + "traits": { + "smithy.api#documentation": "The name of the variable to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mutation operation that removes a variable from the policy definition during the build process.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDisjointRuleSet": { + "type": "structure", + "members": { + "variables": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableNameList", + "traits": { + "smithy.api#documentation": "The set of variables that are used by the rules in this disjoint set.
", + "smithy.api#required": {} + } + }, + "rules": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDisjointedRuleIdList", + "traits": { + "smithy.api#documentation": "The list of rules that form this disjoint set, all operating on the same set of variables.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a set of rules that operate on completely separate variables, indicating they address different concerns or domains within the policy.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDisjointRuleSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDisjointRuleSet" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDisjointedRuleIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDocumentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 8 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDocumentSha256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 64, + "max": 64 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyFidelityReport": { + "type": "structure", + "members": { + "coverageScore": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyCoverageScore", + "traits": { + "smithy.api#documentation": "A score from 0.0 to 1.0 indicating how well the policy covers the statements in the source documents. A higher score means more of the source content is represented in the policy.
", + "smithy.api#required": {} + } + }, + "accuracyScore": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAccuracyScore", + "traits": { + "smithy.api#documentation": "A score from 0.0 to 1.0 indicating how accurate the policy rules are relative to the source documents. A higher score means the policy rules more faithfully represent the source material.
", + "smithy.api#required": {} + } + }, + "ruleReports": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyRuleReportMap", + "traits": { + "smithy.api#documentation": "A mapping from rule identifiers to detailed fidelity reports for each rule, showing which source statements ground each rule and how accurate it is.
", + "smithy.api#required": {} + } + }, + "variableReports": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyVariableReportMap", + "traits": { + "smithy.api#documentation": "A mapping from variable names to detailed fidelity reports for each variable, showing which source statements ground each variable and how accurate it is.
", + "smithy.api#required": {} + } + }, + "documentSources": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyReportSourceDocumentList", + "traits": { + "smithy.api#documentation": "A list of source documents with their content broken down into atomic statements and annotated with line numbers for precise referencing.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A comprehensive analysis report that measures how accurately a generated policy represents the source documents. The report includes coverage and accuracy scores, detailed grounding information linking policy elements to source statements, and annotated document content.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyFormatVersion": { + "type": "string" + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyGenerateFidelityReportContent": { + "type": "union", + "members": { + "documents": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyGenerateFidelityReportDocumentList", + "traits": { + "smithy.api#documentation": "Source documents to analyze for generating a new fidelity report. The documents will be processed to create atomic statements and grounding information.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for generating a fidelity report, which can either analyze new documents or update an existing fidelity report with a new policy definition.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyGenerateFidelityReportDocumentList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowDocument" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyGeneratedTestCase": { + "type": "structure", + "members": { + "queryContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestQueryContent", + "traits": { + "smithy.api#documentation": "The input query or prompt that generated the content. This provides context for the validation.
", + "smithy.api#required": {} + } + }, + "guardContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestGuardContent", + "traits": { + "smithy.api#documentation": "The output content that's validated by the Automated Reasoning policy. This represents the foundation model response that will be checked for accuracy.
", + "smithy.api#required": {} + } + }, + "expectedAggregatedFindingsResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckResult", + "traits": { + "smithy.api#documentation": "The expected results of the generated test case. Possible values include:
VALID - The claims are true. The claims are implied by the premises and the Automated Reasoning policy. Given the Automated Reasoning policy and premises, it is not possible for these claims to be false. In other words, there are no alternative answers that are true that contradict the claims.
INVALID - The claims are false. The claims are not implied by the premises and Automated Reasoning policy. Furthermore, there exists different claims that are consistent with the premises and Automated Reasoning policy.
SATISFIABLE - The claims can be true or false. It depends on what assumptions are made for the claim to be implied from the premises and Automated Reasoning policy rules. In this situation, different assumptions can make input claims false and alternative claims true.
IMPOSSIBLE - Automated Reasoning can’t make a statement about the claims. This can happen if the premises are logically incorrect, or if there is a conflict within the Automated Reasoning policy itself.
Represents a generated test case, consisting of query content, guard content, and expected results.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyGeneratedTestCaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyGeneratedTestCase" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyGeneratedTestCases": { + "type": "structure", + "members": { + "generatedTestCases": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyGeneratedTestCaseList", + "traits": { + "smithy.api#documentation": "Represents a collection of generated test cases.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a comprehensive test suite generated by the build workflow, providing validation capabilities for automated reasoning policies.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyHash": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 128, + "max": 128 + }, + "smithy.api#pattern": "^[0-9a-z]{128}$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyIngestContentAnnotation": { + "type": "structure", + "members": { + "content": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationIngestContent", + "traits": { + "smithy.api#documentation": "The new content to be analyzed and incorporated into the policy, such as additional documents or rule descriptions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for processing and incorporating new content into an Automated Reasoning policy.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyIterativeRefinementContent": { + "type": "structure", + "members": { + "documents": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyIterativeRefinementDocumentList", + "traits": { + "smithy.api#documentation": "Source documents used for iterative policy refinement. These documents provide context for refining the policy definition.
", + "smithy.api#required": {} + } + }, + "feedback": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildFeedback", + "traits": { + "smithy.api#documentation": "Optional feedback to guide the iterative refinement workflow. Provide specific instructions or constraints for policy refinement.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for an iterative policy refinement workflow, including source documents to process and optional feedback to guide the refinement.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyIterativeRefinementDocumentList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowDocument" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyJustificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyJustificationText" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyJustificationText": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyLineNumberList": { + "type": "list", + "member": { + "target": "smithy.api#Integer" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyLineText": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyMutation": { + "type": "union", + "members": { + "addType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddTypeMutation", + "traits": { + "smithy.api#documentation": "A mutation to add a new custom type to the policy.
" + } + }, + "updateType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateTypeMutation", + "traits": { + "smithy.api#documentation": "A mutation to modify an existing custom type in the policy.
" + } + }, + "deleteType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteTypeMutation", + "traits": { + "smithy.api#documentation": "A mutation to remove a custom type from the policy.
" + } + }, + "addVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddVariableMutation", + "traits": { + "smithy.api#documentation": "A mutation to add a new variable to the policy.
" + } + }, + "updateVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateVariableMutation", + "traits": { + "smithy.api#documentation": "A mutation to modify an existing variable in the policy.
" + } + }, + "deleteVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteVariableMutation", + "traits": { + "smithy.api#documentation": "A mutation to remove a variable from the policy.
" + } + }, + "addRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddRuleMutation", + "traits": { + "smithy.api#documentation": "A mutation to add a new rule to the policy.
" + } + }, + "updateRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateRuleMutation", + "traits": { + "smithy.api#documentation": "A mutation to modify an existing rule in the policy.
" + } + }, + "deleteRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteRuleMutation", + "traits": { + "smithy.api#documentation": "A mutation to remove a rule from the policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A container for various mutation operations that can be applied to an Automated Reasoning policy, including adding, updating, and deleting policy elements.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_ ]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyPlanning": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Represents the planning phase of policy build workflow, where the system analyzes source content and determines what operations to perform.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyReportSourceDocument": { + "type": "structure", + "members": { + "documentName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentName", + "traits": { + "smithy.api#documentation": "The name of the source document that was analyzed.
", + "smithy.api#required": {} + } + }, + "documentHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDocumentSha256", + "traits": { + "smithy.api#documentation": "A SHA-256 hash of the document content, used for verification and ensuring the document hasn't changed since analysis.
", + "smithy.api#required": {} + } + }, + "documentId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDocumentId", + "traits": { + "smithy.api#documentation": "A unique identifier for this document within the fidelity report.
", + "smithy.api#required": {} + } + }, + "atomicStatements": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAtomicStatementList", + "traits": { + "smithy.api#documentation": "The list of atomic statements extracted from this document, representing the fundamental units of meaning used for grounding.
", + "smithy.api#required": {} + } + }, + "documentContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotatedChunkList", + "traits": { + "smithy.api#documentation": "The document's content organized into annotated chunks with line number information for precise referencing.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a source document that was analyzed during fidelity report generation, including the document's metadata and its content broken down into atomic statements.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyReportSourceDocumentList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyReportSourceDocument" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyResource": { + "type": "resource", + "identifiers": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn" + } + }, + "create": { + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicy" + }, + "read": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicy" + }, + "update": { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicy" + }, + "delete": { + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicy" + }, + "list": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicies" + }, + "operations": [ + { + "target": "com.amazonaws.bedrock#CancelAutomatedReasoningPolicyBuildWorkflow" + }, + { + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyTestCase" + }, + { + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyVersion" + }, + { + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyBuildWorkflow" + }, + { + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyTestCase" + }, + { + "target": "com.amazonaws.bedrock#ExportAutomatedReasoningPolicyVersion" + }, + { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyAnnotations" + }, + { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflow" + }, + { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResultAssets" + }, + { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyNextScenario" + }, + { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestCase" + }, + { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestResult" + }, + { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyBuildWorkflows" + }, + { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestCases" + }, + { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestResults" + }, + { + "target": "com.amazonaws.bedrock#StartAutomatedReasoningPolicyBuildWorkflow" + }, + { + "target": "com.amazonaws.bedrock#StartAutomatedReasoningPolicyTestWorkflow" + }, + { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyAnnotations" + }, + { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyTestCase" + } + ] + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyRuleReport": { + "type": "structure", + "members": { + "rule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId", + "traits": { + "smithy.api#documentation": "The identifier of the policy rule being analyzed in this report.
", + "smithy.api#required": {} + } + }, + "groundingStatements": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyStatementReferenceList", + "traits": { + "smithy.api#documentation": "References to statements from the source documents that provide the basis or justification for this rule.
" + } + }, + "groundingJustifications": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyJustificationList", + "traits": { + "smithy.api#documentation": "Explanations describing how the source statements support and justify this specific rule.
" + } + }, + "accuracyScore": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAccuracyScore", + "traits": { + "smithy.api#documentation": "A score from 0.0 to 1.0 indicating how accurately this rule represents the source material.
" + } + }, + "accuracyJustification": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyJustificationText", + "traits": { + "smithy.api#documentation": "A textual explanation of the accuracy score, describing why the rule received this particular accuracy rating.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides detailed fidelity analysis for a specific policy rule, including which source document statements support it and how accurate the rule is.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyRuleReportMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId" + }, + "value": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyRuleReport" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyScenario": { + "type": "structure", + "members": { + "expression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarioExpression", + "traits": { + "smithy.api#documentation": "The logical expression or condition that defines this test scenario.
", + "smithy.api#required": {} + } + }, + "alternateExpression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarioAlternateExpression", + "traits": { + "smithy.api#documentation": "An alternative way to express the same test scenario, used for validation and comparison purposes.
", + "smithy.api#required": {} + } + }, + "expectedResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckResult", + "traits": { + "smithy.api#documentation": "The expected outcome when this scenario is evaluated against the policy (e.g., PASS, FAIL, VIOLATION).
", + "smithy.api#required": {} + } + }, + "ruleIds": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleIdList", + "traits": { + "smithy.api#documentation": "The list of rule identifiers that are expected to be triggered or evaluated by this test scenario.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a test scenario used to validate an Automated Reasoning policy, including the test conditions and expected outcomes.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarioAlternateExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarioExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarioList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyScenario" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarios": { + "type": "structure", + "members": { + "policyScenarios": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarioList", + "traits": { + "smithy.api#documentation": "Represents a collection of generated policy scenarios.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a comprehensive entity encompassing all the scenarios generated by the build workflow, which can be used to validate an Automated Reasoning policy.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicySourceDocument": { + "type": "structure", + "members": { + "document": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentBlob", + "traits": { + "smithy.api#documentation": "The raw content of the source document as a binary blob.
", + "smithy.api#required": {} + } + }, + "documentContentType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentContentType", + "traits": { + "smithy.api#documentation": "The MIME type of the document (e.g., application/pdf, text/plain).
", + "smithy.api#required": {} + } + }, + "documentName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentName", + "traits": { + "smithy.api#documentation": "The name of the source document for identification purposes.
", + "smithy.api#required": {} + } + }, + "documentDescription": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentDescription", + "traits": { + "smithy.api#documentation": "An optional description providing context about the document's content and purpose.
" + } + }, + "documentHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDocumentSha256", + "traits": { + "smithy.api#documentation": "A SHA-256 hash of the document content, used for verification and integrity checking.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a source document that was processed during a build workflow. Contains the document content, metadata, and a hash for verification.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyStatementId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 8 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyStatementLocation": { + "type": "structure", + "members": { + "lines": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyLineNumberList", + "traits": { + "smithy.api#documentation": "The line numbers in the source document where this statement appears.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the location of a statement within a source document using line numbers.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyStatementReference": { + "type": "structure", + "members": { + "documentId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDocumentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the document containing the referenced statement.
", + "smithy.api#required": {} + } + }, + "statementId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyStatementId", + "traits": { + "smithy.api#documentation": "The unique identifier of the specific atomic statement being referenced.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "References a specific atomic statement within a source document, used to link policy elements back to their source material.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyStatementReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyStatementReference" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyStatementText": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicySummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicySummary": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", + "traits": { + "smithy.api#documentation": "The name of the policy.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription", + "traits": { + "smithy.api#documentation": "The description of the policy.
" + } + }, + "version": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyVersion", + "traits": { + "smithy.api#documentation": "The version of the policy.
", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about an Automated Reasoning policy, including metadata and timestamps.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCase": { + "type": "structure", + "members": { + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the test.
", + "smithy.api#required": {} + } + }, + "guardContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestGuardContent", + "traits": { + "smithy.api#documentation": "The output content to be validated by the policy, typically representing a foundation model response.
", + "smithy.api#required": {} + } + }, + "queryContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestQueryContent", + "traits": { + "smithy.api#documentation": "The input query or prompt that generated the content. This provides context for the validation.
" + } + }, + "expectedAggregatedFindingsResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckResult", + "traits": { + "smithy.api#documentation": "The expected result of the Automated Reasoning check for this test.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the test was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the test was last updated.
", + "smithy.api#required": {} + } + }, + "confidenceThreshold": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationConfidence", + "traits": { + "smithy.api#documentation": "The minimum confidence level for logic validation. Content meeting this threshold is considered high-confidence and can be validated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a test for validating an Automated Reasoning policy. tests contain sample inputs and expected outcomes to verify policy behavior.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 12 + }, + "smithy.api#pattern": "^[0-9A-Z]{12}$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCase" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestGuardContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestResult" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestQueryContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestResult": { + "type": "structure", + "members": { + "testCase": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCase", + "traits": { + "smithy.api#documentation": "The test case that was executed, including the input content, expected results, and configuration parameters used during validation.
", + "smithy.api#required": {} + } + }, + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy that was tested.
", + "smithy.api#required": {} + } + }, + "testRunStatus": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestRunStatus", + "traits": { + "smithy.api#documentation": "The overall status of the test run (e.g., COMPLETED, FAILED, IN_PROGRESS).
", + "smithy.api#required": {} + } + }, + "testFindings": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckFindingList", + "traits": { + "smithy.api#documentation": "Detailed findings from the test run, including any issues, violations, or unexpected behaviors discovered.
" + } + }, + "testRunResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestRunResult", + "traits": { + "smithy.api#documentation": "The overall result of the test run, indicating whether the policy passed or failed validation.
" + } + }, + "aggregatedTestFindingsResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckResult", + "traits": { + "smithy.api#documentation": "A summary of all test findings, aggregated to provide an overall assessment of policy quality and correctness.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the test results were last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the results of testing an Automated Reasoning policy against various scenarios and validation checks.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestRunResult": { + "type": "enum", + "members": { + "PASSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestRunStatus": { + "type": "enum", + "members": { + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_STARTED" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTypeValueAnnotation": { + "type": "union", + "members": { + "addTypeValue": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddTypeValue", + "traits": { + "smithy.api#documentation": "An operation to add a new value to an existing custom type.
" + } + }, + "updateTypeValue": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateTypeValue", + "traits": { + "smithy.api#documentation": "An operation to modify an existing value within a custom type.
" + } + }, + "deleteTypeValue": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteTypeValue", + "traits": { + "smithy.api#documentation": "An operation to remove a value from an existing custom type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for managing values within custom types, including adding, updating, or removing specific type values.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTypeValueAnnotationList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTypeValueAnnotation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation": { + "type": "structure", + "members": { + "ruleIds": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleIdList", + "traits": { + "smithy.api#documentation": "The list of rule identifiers that the feedback applies to.
" + } + }, + "feedback": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationFeedbackNaturalLanguage", + "traits": { + "smithy.api#documentation": "The feedback information about rule performance, including suggestions for improvements or corrections.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for updating the policy based on feedback about how specific rules performed during testing or real-world usage.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation": { + "type": "structure", + "members": { + "ruleIds": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleIdList", + "traits": { + "smithy.api#documentation": "The list of rule identifiers that were involved in the scenario being evaluated.
" + } + }, + "scenarioExpression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarioExpression", + "traits": { + "smithy.api#documentation": "The logical expression that defines the test scenario that generated this feedback.
", + "smithy.api#required": {} + } + }, + "feedback": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationFeedbackNaturalLanguage", + "traits": { + "smithy.api#documentation": "The feedback information about scenario performance, including any issues or improvements identified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for updating the policy based on feedback about how it performed on specific test scenarios.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateRuleAnnotation": { + "type": "structure", + "members": { + "ruleId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the rule to update.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleExpression", + "traits": { + "smithy.api#documentation": "The new formal logical expression for the rule, replacing the previous expression.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for modifying an existing rule in an Automated Reasoning policy.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateRuleMutation": { + "type": "structure", + "members": { + "rule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule", + "traits": { + "smithy.api#documentation": "The updated rule definition containing the modified formal logical expression and any changed metadata for the existing rule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mutation operation that modifies an existing rule in the policy definition during the build process.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateTypeAnnotation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", + "traits": { + "smithy.api#documentation": "The current name of the custom type to update.
", + "smithy.api#required": {} + } + }, + "newName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", + "traits": { + "smithy.api#documentation": "The new name for the custom type, if you want to rename it. If not provided, the name remains unchanged.
" + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeDescription", + "traits": { + "smithy.api#documentation": "The new description for the custom type, replacing the previous description.
" + } + }, + "values": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTypeValueAnnotationList", + "traits": { + "smithy.api#documentation": "The updated list of values for the custom type, which can include additions, modifications, or removals.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for modifying an existing custom type in an Automated Reasoning policy.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateTypeMutation": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType", + "traits": { + "smithy.api#documentation": "The updated type definition containing the modified name, description, or values for the existing custom type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mutation operation that modifies an existing custom type in the policy definition during the build process.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateTypeValue": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName", + "traits": { + "smithy.api#documentation": "The current identifier or name of the type value to update.
", + "smithy.api#required": {} + } + }, + "newValue": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName", + "traits": { + "smithy.api#documentation": "The new identifier or name for the type value, if you want to rename it.
" + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueDescription", + "traits": { + "smithy.api#documentation": "The new description for the type value, replacing the previous description.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a modification to a value within an existing custom type.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateVariableAnnotation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", + "traits": { + "smithy.api#documentation": "The current name of the variable to update.
", + "smithy.api#required": {} + } + }, + "newName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", + "traits": { + "smithy.api#documentation": "The new name for the variable, if you want to rename it. If not provided, the name remains unchanged.
" + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableDescription", + "traits": { + "smithy.api#documentation": "The new description for the variable, replacing the previous description.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An annotation for modifying an existing variable in an Automated Reasoning policy.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateVariableMutation": { + "type": "structure", + "members": { + "variable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable", + "traits": { + "smithy.api#documentation": "The updated variable definition containing the modified name, type, or description for the existing variable.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A mutation operation that modifies an existing variable in the policy definition during the build process.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyVariableReport": { + "type": "structure", + "members": { + "policyVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", + "traits": { + "smithy.api#documentation": "The name of the policy variable being analyzed in this report.
", + "smithy.api#required": {} + } + }, + "groundingStatements": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyStatementReferenceList", + "traits": { + "smithy.api#documentation": "References to statements from the source documents that provide the basis or justification for this variable.
" + } + }, + "groundingJustifications": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyJustificationList", + "traits": { + "smithy.api#documentation": "Explanations describing how the source statements support and justify this specific variable definition.
" + } + }, + "accuracyScore": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAccuracyScore", + "traits": { + "smithy.api#documentation": "A score from 0.0 to 1.0 indicating how accurately this variable represents concepts from the source material.
" + } + }, + "accuracyJustification": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyJustificationText", + "traits": { + "smithy.api#documentation": "A textual explanation of the accuracy score, describing why the variable received this particular accuracy rating.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides detailed fidelity analysis for a specific policy variable, including which source document statements support it and how accurate the variable definition is.
" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyVariableReportMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName" + }, + "value": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyVariableReport" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 12 + }, + "smithy.api#pattern": "^([1-9][0-9]{0,11})$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyWorkflowTypeContent": { + "type": "union", + "members": { + "documents": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowDocumentList", + "traits": { + "smithy.api#documentation": "The list of documents to be processed in a document ingestion workflow.
" + } + }, + "policyRepairAssets": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowRepairContent", + "traits": { + "smithy.api#documentation": "The assets and instructions needed for a policy repair workflow, including repair annotations and guidance.
" + } + }, + "generateFidelityReportContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyGenerateFidelityReportContent", + "traits": { + "smithy.api#documentation": "The content configuration for generating a fidelity report workflow. This can include source documents to analyze or an existing fidelity report to update with a new policy definition.
" + } + }, + "iterativeRefinementContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyIterativeRefinementContent", + "traits": { + "smithy.api#documentation": "Content configuration to start an iterative policy refinement workflow that uses generative AI to automatically make changes to the policy based on test results and the optional feedback provided.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the content and configuration for different types of policy build workflows.
" + } + }, + "com.amazonaws.bedrock#BaseModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes one or more advanced prompt optimization jobs.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/advanced-prompt-optimization-job/batch-delete" + } + } + }, + "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJobError": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the job that could not be deleted.
", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error code for the deletion failure.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A message describing the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an error that occurred when deleting an advanced prompt optimization job.
" + } + }, + "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJobErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJobError" + }, + "traits": { + "smithy.api#documentation": "A list of errors from a batch delete operation on advanced prompt optimization jobs.
", + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJobItem": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the deleted job.
", + "smithy.api#required": {} + } + }, + "jobStatus": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobStatus", + "traits": { + "smithy.api#documentation": "The status of the deleted job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a successfully deleted advanced prompt optimization job.
" + } + }, + "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJobItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJobItem" + }, + "traits": { + "smithy.api#documentation": "A list of successfully deleted advanced prompt optimization jobs.
", + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJobRequest": { + "type": "structure", + "members": { + "jobIdentifiers": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobIdentifiers", + "traits": { + "smithy.api#documentation": "A list of advanced prompt optimization job identifiers (ARNs or IDs) to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Batch Delete Advanced Prompt Optimization Jobs Request
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJobResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJobErrors", + "traits": { + "smithy.api#documentation": "A list of errors encountered during batch deletion.
", + "smithy.api#required": {} + } + }, + "advancedPromptOptimizationJobs": { + "target": "com.amazonaws.bedrock#BatchDeleteAdvancedPromptOptimizationJobItems", + "traits": { + "smithy.api#documentation": "A list of successfully deleted advanced prompt optimization jobs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Batch Delete Advanced Prompt Optimization Jobs Response
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a batch of evaluation jobs. An evaluation job can only be deleted if it has following status FAILED, COMPLETED, and STOPPED. You can request up to 25 model evaluation jobs be deleted in a single request.
The ARN of the evaluation job being deleted.
", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A HTTP status code of the evaluation job being deleted.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A status message about the evaluation job deletion.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A JSON array that provides the status of the evaluation jobs being deleted.
" + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJobErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobError" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJobItem": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the evaluation job for deletion.
", + "smithy.api#required": {} + } + }, + "jobStatus": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "The status of the evaluation job for deletion.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An evaluation job for deletion, and it’s current status.
" + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJobItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobItem" + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJobRequest": { + "type": "structure", + "members": { + "jobIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifiers", + "traits": { + "smithy.api#documentation": "A list of one or more evaluation job Amazon Resource Names (ARNs) you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJobResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobErrors", + "traits": { + "smithy.api#documentation": "A JSON object containing the HTTP status codes and the ARNs of evaluation jobs that failed to be deleted.
", + "smithy.api#required": {} + } + }, + "evaluationJobs": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobItems", + "traits": { + "smithy.api#documentation": "The list of evaluation jobs for deletion.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#BedrockEvaluatorModel": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#EvaluatorModelIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the evaluator model used used in knowledge base evaluation job or in model evaluation job that use a model as judge.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The evaluator model used in knowledge base evaluation job or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.
" + } + }, + "com.amazonaws.bedrock#BedrockEvaluatorModels": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#BedrockEvaluatorModel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#BedrockMarketplaceResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateMarketplaceModelEndpoint" + }, + { + "target": "com.amazonaws.bedrock#DeleteMarketplaceModelEndpoint" + }, + { + "target": "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpoint" + }, + { + "target": "com.amazonaws.bedrock#GetMarketplaceModelEndpoint" + }, + { + "target": "com.amazonaws.bedrock#ListMarketplaceModelEndpoints" + }, + { + "target": "com.amazonaws.bedrock#RegisterMarketplaceModelEndpoint" + }, + { + "target": "com.amazonaws.bedrock#UpdateMarketplaceModelEndpoint" + } + ] + }, + "com.amazonaws.bedrock#BedrockModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" + } + }, + "com.amazonaws.bedrock#BedrockModelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 140 + }, + "smithy.api#pattern": "^[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)$" + } + }, + "com.amazonaws.bedrock#BedrockRerankingModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$" + } + }, + "com.amazonaws.bedrock#BrandedName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrock#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, + "com.amazonaws.bedrock#ByteContentBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10485760 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#ByteContentDoc": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.bedrock#Identifier", + "traits": { + "smithy.api#documentation": "The file name of the document contained in the wrapper object.
", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.bedrock#ContentType", + "traits": { + "smithy.api#documentation": "The MIME type of the document contained in the wrapper object.
", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.bedrock#ByteContentBlob", + "traits": { + "smithy.api#documentation": "The byte value of the file to upload, encoded as a Base-64 string.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the document contained in the wrapper object, along with its attributes/fields.
" + } + }, + "com.amazonaws.bedrock#CancelAutomatedReasoningPolicyBuildWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CancelAutomatedReasoningPolicyBuildWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CancelAutomatedReasoningPolicyBuildWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Cancels a running Automated Reasoning policy build workflow. This stops the policy generation process and prevents further processing of the source documents.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/cancel" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CancelAutomatedReasoningPolicyBuildWorkflowRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow you want to cancel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow to cancel. You can get this ID from the StartAutomatedReasoningPolicyBuildWorkflow response or by listing build workflows.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#CancelAutomatedReasoningPolicyBuildWorkflowResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CloudWatchConfig": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.bedrock#LogGroupName", + "traits": { + "smithy.api#documentation": "The log group name.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "The role Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "largeDataDeliveryS3Config": { + "target": "com.amazonaws.bedrock#S3Config", + "traits": { + "smithy.api#documentation": "S3 configuration for delivering a large amount of data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "CloudWatch logging configuration.
" + } + }, + "com.amazonaws.bedrock#CommitmentDuration": { + "type": "enum", + "members": { + "ONE_MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OneMonth" + } + }, + "SIX_MONTHS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SixMonths" + } + } + } + }, + "com.amazonaws.bedrock#ConfigurationOwner": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACCOUNT", + "name": "ACCOUNT", + "documentation": "Configuration owned by the account" + } + ] + } + }, + "com.amazonaws.bedrock#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "Error occurred because of a conflict while performing an operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrock#ContentType": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-z]{1,20}/.{1,20}" + } + }, + "com.amazonaws.bedrock#CreateAdvancedPromptOptimizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateAdvancedPromptOptimizationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateAdvancedPromptOptimizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an advanced prompt optimization job. The job optimizes your prompt templates for specific models using your evaluation dataset and criteria.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/advanced-prompt-optimization-jobs" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateAdvancedPromptOptimizationJobRequest": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobName", + "traits": { + "smithy.api#documentation": "A name for the advanced prompt optimization job.
", + "smithy.api#required": {} + } + }, + "jobDescription": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobDescription", + "traits": { + "smithy.api#documentation": "A description of the advanced prompt optimization job.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "inputConfig": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationInputConfig", + "traits": { + "smithy.api#documentation": "Specifies the S3 location of your JSONL input file containing prompt templates and evaluation samples.
", + "smithy.api#required": {} + } + }, + "outputConfig": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationOutputConfig", + "traits": { + "smithy.api#documentation": "Specifies the S3 location where optimization results will be stored.
", + "smithy.api#required": {} + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used for encrypting the output data. If not specified, the output is encrypted with an Amazon-owned KMS key.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to associate with the advanced prompt optimization job.
" + } + }, + "modelConfigurations": { + "target": "com.amazonaws.bedrock#ModelConfigurations", + "traits": { + "smithy.api#documentation": "A list of model configurations specifying the target models for prompt optimization. You can specify up to 5 models.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Create Advanced Prompt Optimization Job Request
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateAdvancedPromptOptimizationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created advanced prompt optimization job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Create Advanced Prompt Optimization Job Response
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Automated Reasoning policy for Amazon Bedrock Guardrails. Automated Reasoning policies use mathematical techniques to detect hallucinations, suggest corrections, and highlight unstated assumptions in the responses of your GenAI application.
To create a policy, you upload a source document that describes the rules that you're encoding. Automated Reasoning extracts important concepts from the source document that will become variables in the policy and infers policy rules.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/automated-reasoning-policies" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", + "traits": { + "smithy.api#documentation": "A unique name for the Automated Reasoning policy. The name must be between 1 and 63 characters and can contain letters, numbers, hyphens, and underscores.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription", + "traits": { + "smithy.api#documentation": "A description of the Automated Reasoning policy. Use this to provide context about the policy's purpose and the types of validations it performs.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "policyDefinition": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition", + "traits": { + "smithy.api#documentation": "The policy definition that contains the formal logic rules, variables, and custom variable types used to validate foundation model responses in your application.
" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "The identifier of the KMS key to use for encrypting the automated reasoning policy and its associated artifacts. If you don't specify a KMS key, Amazon Bedrock uses an KMS managed key for encryption. For enhanced security and control, you can specify a customer managed KMS key.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "A list of tags to associate with the Automated Reasoning policy. Tags help you organize and manage your policies.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy that you created.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyVersion", + "traits": { + "smithy.api#documentation": "The version number of the newly created Automated Reasoning policy. The initial version is always DRAFT.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", + "traits": { + "smithy.api#documentation": "The name of the Automated Reasoning policy.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription", + "traits": { + "smithy.api#documentation": "The description of the Automated Reasoning policy.
" + } + }, + "definitionHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "The hash of the policy definition. This is used as a concurrency token for creating policy versions that you can use in your application.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyTestCase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyTestCaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyTestCaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a test for an Automated Reasoning policy. Tests validate that your policy works as expected by providing sample inputs and expected outcomes. Use tests to verify policy behavior before deploying to production.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/automated-reasoning-policies/{policyArn}/test-cases" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyTestCaseRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to create the test.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "guardContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestGuardContent", + "traits": { + "smithy.api#documentation": "The output content that's validated by the Automated Reasoning policy. This represents the foundation model response that will be checked for accuracy.
", + "smithy.api#required": {} + } + }, + "queryContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestQueryContent", + "traits": { + "smithy.api#documentation": "The input query or prompt that generated the content. This provides context for the validation.
" + } + }, + "expectedAggregatedFindingsResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckResult", + "traits": { + "smithy.api#documentation": "The expected result of the Automated Reasoning check. Valid values include: , TOO_COMPLEX, and NO_TRANSLATIONS.
VALID - The claims are true. The claims are implied by the premises and the Automated Reasoning policy. Given the Automated Reasoning policy and premises, it is not possible for these claims to be false. In other words, there are no alternative answers that are true that contradict the claims.
INVALID - The claims are false. The claims are not implied by the premises and Automated Reasoning policy. Furthermore, there exists different claims that are consistent with the premises and Automated Reasoning policy.
SATISFIABLE - The claims can be true or false. It depends on what assumptions are made for the claim to be implied from the premises and Automated Reasoning policy rules. In this situation, different assumptions can make input claims false and alternative claims true.
IMPOSSIBLE - Automated Reasoning can’t make a statement about the claims. This can happen if the premises are logically incorrect, or if there is a conflict within the Automated Reasoning policy itself.
TRANSLATION_AMBIGUOUS - Detected an ambiguity in the translation meant it would be unsound to continue with validity checking. Additional context or follow-up questions might be needed to get translation to succeed.
TOO_COMPLEX - The input contains too much information for Automated Reasoning to process within its latency limits.
NO_TRANSLATIONS - Identifies that some or all of the input prompt wasn't translated into logic. This can happen if the input isn't relevant to the Automated Reasoning policy, or if the policy doesn't have variables to model relevant input. If Automated Reasoning can't translate anything, you get a single NO_TRANSLATIONS finding. You might also see a NO_TRANSLATIONS (along with other findings) if some part of the validation isn't translated.
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "confidenceThreshold": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationConfidence", + "traits": { + "smithy.api#documentation": "The minimum confidence level for logic validation. Content that meets the threshold is considered a high-confidence finding that can be validated.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyTestCaseResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy for which the test was created.
", + "smithy.api#required": {} + } + }, + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the created test.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new version of an existing Automated Reasoning policy. This allows you to iterate on your policy rules while maintaining previous versions for rollback or comparison purposes.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/automated-reasoning-policies/{policyArn}/versions" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyVersionRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to create a version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "lastUpdatedDefinitionHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "The hash of the current policy definition used as a concurrency token to ensure the policy hasn't been modified since you last retrieved it.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "A list of tags to associate with the policy version.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyVersionResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The versioned Amazon Resource Name (ARN) of the policy version.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyVersion", + "traits": { + "smithy.api#documentation": "The version number of the policy version.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", + "traits": { + "smithy.api#documentation": "The name of the policy version.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription", + "traits": { + "smithy.api#documentation": "The description of the policy version.
" + } + }, + "definitionHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "The hash of the policy definition for this version.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy version was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateCustomModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateCustomModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateCustomModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new custom model in Amazon Bedrock. After the model is active, you can use it for inference.
You can provide the model data source in one of the following ways:
customModelDataSource — Specify a SageMaker AI model package ARN. Amazon Bedrock resolves the model package to retrieve the model artifacts. This is the preferred method for new SageMaker AI training outputs.
modelSourceConfig — Specify an Amazon S3 URI pointing to the Amazon-managed Amazon S3 bucket containing your model artifacts.
To use the model for inference, you must purchase Provisioned Throughput for it. You can't use On-demand inference with these custom models. For more information about Provisioned Throughput, see Provisioned Throughput.
The model appears in ListCustomModels with a customizationType of imported. To track the status of the new model, you use the GetCustomModel API operation. The model can be in the following states:
Creating - Initial state during validation and registration
Active - Model is ready for use in inference
Failed - Creation process encountered an error
Related APIs
", + "smithy.api#examples": [ + { + "title": "Successful CreateCustomModel API call", + "input": { + "modelName": "SampleModel", + "modelSourceConfig": { + "s3DataSource": { + "s3Uri": "s3://my-bucket/folder" + } + }, + "roleArn": "arn:aws:iam::123456789012:role/SampleRole", + "modelKmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "modelTags": [ + { + "key": "foo", + "value": "foo" + }, + { + "key": "foo", + "value": "foo" + } + ], + "clientRequestToken": "foo" + }, + "output": { + "modelArn": "arn:aws:bedrock:us-east-1:123456789012:custom-model/imported/abcdef123456" + } + } + ], + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/custom-models/create-custom-model" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateCustomModelDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateCustomModelDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateCustomModelDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deploys a custom model for on-demand inference in Amazon Bedrock. After you deploy your custom model, you use the deployment's Amazon Resource Name (ARN) as the modelId parameter when you submit prompts and generate responses with model inference.
For more information about setting up on-demand inference for custom models, see Set up inference for a custom model.
The following actions are related to the CreateCustomModelDeployment operation:
The name for the custom model deployment. The name must be unique within your Amazon Web Services account and Region.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom model to deploy for on-demand inference. The custom model must be in the Active state.
A description for the custom model deployment to help you identify its purpose.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to assign to the custom model deployment. You can use tags to organize and track your Amazon Web Services resources for cost allocation and management purposes.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateCustomModelDeploymentResponse": { + "type": "structure", + "members": { + "customModelDeploymentArn": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom model deployment. Use this ARN as the modelId parameter when invoking the model with the InvokeModel or Converse operations.
A unique name for the custom model.
", + "smithy.api#required": {} + } + }, + "modelSourceConfig": { + "target": "com.amazonaws.bedrock#ModelDataSource", + "traits": { + "smithy.api#documentation": "The data source for the model. The Amazon S3 URI in the model source must be for the Amazon-managed Amazon S3 bucket containing your model artifacts.
" + } + }, + "customModelDataSource": { + "target": "com.amazonaws.bedrock#CustomModelDataSource", + "traits": { + "smithy.api#documentation": "The data source for the custom model. Use this field to specify a SageMaker AI model package ARN as the source for your custom model. Amazon Bedrock resolves the model package to retrieve the model artifacts.
You can specify either customModelDataSource or modelSourceConfig, but not both.
The Amazon Resource Name (ARN) of the customer managed KMS key to encrypt the custom model. If you don't provide a KMS key, Amazon Bedrock uses an Amazon Web Services-managed KMS key to encrypt the model.
If you provide a customer managed KMS key, your Amazon Bedrock service role must have permissions to use it. For more information see Encryption of imported models.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock assumes to perform tasks on your behalf. This role must have permissions to access the Amazon S3 bucket containing your model artifacts and the KMS key (if specified). For more information, see Setting up an IAM service role for importing models in the Amazon Bedrock User Guide.
This field is required when you use modelSourceConfig with an Amazon S3 data source. It is not required when you use customModelDataSource with a model package ARN, because Amazon Bedrock uses its own credentials to access the model artifacts.
A list of key-value pairs to associate with the custom model resource. You can use these tags to organize and identify your resources.
For more information, see Tagging resources in the Amazon Bedrock User Guide.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateCustomModelResponse": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new custom model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateEvaluationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an evaluation job.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/evaluation-jobs" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateEvaluationJobRequest": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.
", + "smithy.api#required": {} + } + }, + "jobDescription": { + "target": "com.amazonaws.bedrock#EvaluationJobDescription", + "traits": { + "smithy.api#documentation": "A description of the evaluation job.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see Required permissions for model evaluations.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.
" + } + }, + "jobTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to attach to the model evaluation job.
" + } + }, + "applicationType": { + "target": "com.amazonaws.bedrock#ApplicationType", + "traits": { + "smithy.api#documentation": "Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
" + } + }, + "evaluationConfig": { + "target": "com.amazonaws.bedrock#EvaluationConfig", + "traits": { + "smithy.api#documentation": "Contains the configuration details of either an automated or human-based evaluation job.
", + "smithy.api#required": {} + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", + "traits": { + "smithy.api#documentation": "Contains the configuration details of the inference model for the evaluation job.
For model evaluation jobs, automated jobs support a single model or inference profile, and jobs that use human workers support two models or inference profiles.
", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", + "traits": { + "smithy.api#documentation": "Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateEvaluationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#EvaluationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the evaluation job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateFoundationModelAgreement": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateFoundationModelAgreementRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateFoundationModelAgreementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Request a model access agreement for the specified model.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/create-foundation-model-agreement" + } + } + }, + "com.amazonaws.bedrock#CreateFoundationModelAgreementRequest": { + "type": "structure", + "members": { + "offerToken": { + "target": "com.amazonaws.bedrock#OfferToken", + "traits": { + "smithy.api#documentation": "An offer token encapsulates the information for an offer.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "Model Id of the model for the access request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateFoundationModelAgreementResponse": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "Model Id of the model for the access request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateGuardrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.
Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.
Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.
Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.
Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.
In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.
For more information, see Amazon Bedrock Guardrails in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/guardrails" + } + } + }, + "com.amazonaws.bedrock#CreateGuardrailRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", + "traits": { + "smithy.api#documentation": "The name to give the guardrail.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "A description of the guardrail.
" + } + }, + "topicPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailTopicPolicyConfig", + "traits": { + "smithy.api#documentation": "The topic policies to configure for the guardrail.
" + } + }, + "contentPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContentPolicyConfig", + "traits": { + "smithy.api#documentation": "The content filter policies to configure for the guardrail.
" + } + }, + "wordPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailWordPolicyConfig", + "traits": { + "smithy.api#documentation": "The word policy you configure for the guardrail.
" + } + }, + "sensitiveInformationPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig", + "traits": { + "smithy.api#documentation": "The sensitive information policy to configure for the guardrail.
" + } + }, + "contextualGroundingPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig", + "traits": { + "smithy.api#documentation": "The contextual grounding policy configuration used to create a guardrail.
" + } + }, + "automatedReasoningPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailAutomatedReasoningPolicyConfig", + "traits": { + "smithy.api#documentation": "Optional configuration for integrating Automated Reasoning policies with the new guardrail.
" + } + }, + "crossRegionConfig": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionConfig", + "traits": { + "smithy.api#documentation": "The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
For more information, see the Amazon Bedrock User Guide.
" + } + }, + "blockedInputMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "The message to return when the guardrail blocks a prompt.
", + "smithy.api#required": {} + } + }, + "blockedOutputsMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "The message to return when the guardrail blocks a model response.
", + "smithy.api#required": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key that you use to encrypt the guardrail.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "The tags that you want to attach to the guardrail.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateGuardrailResponse": { + "type": "structure", + "members": { + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail that was created.
", + "smithy.api#required": {} + } + }, + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", + "traits": { + "smithy.api#documentation": "The ARN of the guardrail.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailDraftVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail that was created. This value will always be DRAFT.
The time at which the guardrail was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateGuardrailVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateGuardrailVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateGuardrailVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/guardrails/{guardrailIdentifier}" + } + } + }, + "com.amazonaws.bedrock#CreateGuardrailVersionRequest": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail. This can be an ID or the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "A description of the guardrail version.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateGuardrailVersionResponse": { + "type": "structure", + "members": { + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", + "traits": { + "smithy.api#documentation": "The number of the version of the guardrail.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateInferenceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateInferenceProfileRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateInferenceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an application inference profile to track metrics and costs when invoking a model. To create an application inference profile for a foundation model in one region, specify the ARN of the model in that region. To create an application inference profile for a foundation model across multiple regions, specify the ARN of the system-defined inference profile that contains the regions that you want to route requests to. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/inference-profiles" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateInferenceProfileRequest": { + "type": "structure", + "members": { + "inferenceProfileName": { + "target": "com.amazonaws.bedrock#InferenceProfileName", + "traits": { + "smithy.api#documentation": "A name for the inference profile.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#InferenceProfileDescription", + "traits": { + "smithy.api#documentation": "A description for the inference profile.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "modelSource": { + "target": "com.amazonaws.bedrock#InferenceProfileModelSource", + "traits": { + "smithy.api#documentation": "The foundation model or system-defined inference profile that the inference profile will track metrics and costs for.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "An array of objects, each of which contains a tag and its value. For more information, see Tagging resources in the Amazon Bedrock User Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateInferenceProfileResponse": { + "type": "structure", + "members": { + "inferenceProfileArn": { + "target": "com.amazonaws.bedrock#InferenceProfileArn", + "traits": { + "smithy.api#documentation": "The ARN of the inference profile that you created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#InferenceProfileStatus", + "traits": { + "smithy.api#documentation": "The status of the inference profile. ACTIVE means that the inference profile is ready to be used.
Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/marketplace-model/endpoints" + } + } + }, + "com.amazonaws.bedrock#CreateMarketplaceModelEndpointRequest": { + "type": "structure", + "members": { + "modelSourceIdentifier": { + "target": "com.amazonaws.bedrock#ModelSourceIdentifier", + "traits": { + "smithy.api#documentation": "The ARN of the model from Amazon Bedrock Marketplace that you want to deploy to the endpoint.
", + "smithy.api#required": {} + } + }, + "endpointConfig": { + "target": "com.amazonaws.bedrock#EndpointConfig", + "traits": { + "smithy.api#documentation": "The configuration for the endpoint, including the number and type of instances to use.
", + "smithy.api#required": {} + } + }, + "acceptEula": { + "target": "com.amazonaws.bedrock#AcceptEula", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether you accept the end-user license agreement (EULA) for the model. Set to true to accept the EULA.
The name of the endpoint. This name must be unique within your Amazon Web Services account and region.
", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because Amazon Web Services SDKs automatically generate it for you and set this parameter. If you're not using the Amazon Web Services SDK or the CLI, you must provide this token or the action will fail.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs to apply to the underlying Amazon SageMaker endpoint. You can use these tags to organize and identify your Amazon Web Services resources.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateMarketplaceModelEndpointResponse": { + "type": "structure", + "members": { + "marketplaceModelEndpoint": { + "target": "com.amazonaws.bedrock#MarketplaceModelEndpoint", + "traits": { + "smithy.api#documentation": "Details about the created endpoint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateModelCopyJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelCopyJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateModelCopyJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/model-copy-jobs" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateModelCopyJobRequest": { + "type": "structure", + "members": { + "sourceModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model to be copied.
", + "smithy.api#required": {} + } + }, + "targetModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "A name for the copied model.
", + "smithy.api#required": {} + } + }, + "modelKmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key that you use to encrypt the model copy.
" + } + }, + "targetModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to associate with the target model. For more information, see Tag resources in the Amazon Bedrock User Guide.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateModelCopyJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model copy job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateModelCustomizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelCustomizationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateModelCustomizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a fine-tuning job to customize a base model.
You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.
For information on the format of training and validation data, see Prepare the datasets.
Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.
For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/model-customization-jobs" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateModelCustomizationJobRequest": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "A name for the fine-tuning job.
", + "smithy.api#required": {} + } + }, + "customModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "A name for the resulting custom model.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "baseModelIdentifier": { + "target": "com.amazonaws.bedrock#BaseModelIdentifier", + "traits": { + "smithy.api#documentation": "Name of the base model.
", + "smithy.api#required": {} + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "The customization type.
" + } + }, + "customModelKmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "The custom model is encrypted at rest using this key.
" + } + }, + "jobTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to attach to the job.
" + } + }, + "customModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to attach to the resulting custom model.
" + } + }, + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", + "traits": { + "smithy.api#documentation": "Information about the training dataset.
", + "smithy.api#required": {} + } + }, + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", + "traits": { + "smithy.api#documentation": "Information about the validation dataset.
" + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", + "traits": { + "smithy.api#documentation": "S3 location for the output data.
", + "smithy.api#required": {} + } + }, + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "traits": { + "smithy.api#documentation": "Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters.
" + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "The configuration of the Virtual Private Cloud (VPC) that contains the resources that you're using for this job. For more information, see Protect your model customization jobs using a VPC.
" + } + }, + "customizationConfig": { + "target": "com.amazonaws.bedrock#CustomizationConfig", + "traits": { + "smithy.api#documentation": "The customization configuration for the model customization job.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateModelCustomizationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the fine tuning job
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateModelImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelImportJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateModelImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker. For more information, see Import a customized model
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/model-import-jobs" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateModelImportJobRequest": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "The name of the import job.
", + "smithy.api#required": {} + } + }, + "importedModelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "The name of the imported model.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model import job.
", + "smithy.api#required": {} + } + }, + "modelDataSource": { + "target": "com.amazonaws.bedrock#ModelDataSource", + "traits": { + "smithy.api#documentation": "The data source for the imported model.
", + "smithy.api#required": {} + } + }, + "jobTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to attach to this import job.
" + } + }, + "importedModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to attach to the imported model.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "VPC configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for the import job.
" + } + }, + "importedModelKmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "The imported model is encrypted at rest using this key.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateModelImportJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelImportJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model import job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateModelInvocationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelInvocationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateModelInvocationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference.
The response returns a jobArn that you can use to stop or get details about the job.
A name to give the batch inference job.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.
", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#ModelId", + "traits": { + "smithy.api#documentation": "The unique identifier of the foundation model to use for the batch inference job.
", + "smithy.api#required": {} + } + }, + "inputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", + "traits": { + "smithy.api#documentation": "Details about the location of the input to the batch inference job.
", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", + "traits": { + "smithy.api#documentation": "Details about the location of the output of the batch inference job.
", + "smithy.api#required": {} + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.
" + } + }, + "timeoutDurationInHours": { + "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", + "traits": { + "smithy.api#documentation": "The number of hours after which to force the batch inference job to time out.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.
" + } + }, + "modelInvocationType": { + "target": "com.amazonaws.bedrock#ModelInvocationType", + "traits": { + "smithy.api#default": "InvokeModel", + "smithy.api#documentation": "The invocation endpoint for ModelInvocationJob
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateModelInvocationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelInvocationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the batch inference job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreatePromptRouter": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreatePromptRouterRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreatePromptRouterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/prompt-routers" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreatePromptRouterRequest": { + "type": "structure", + "members": { + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure idempotency of your requests. If not specified, the Amazon Web Services SDK automatically generates one for you.
", + "smithy.api#idempotencyToken": {} + } + }, + "promptRouterName": { + "target": "com.amazonaws.bedrock#PromptRouterName", + "traits": { + "smithy.api#documentation": "The name of the prompt router. The name must be unique within your Amazon Web Services account in the current region.
", + "smithy.api#required": {} + } + }, + "models": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModels", + "traits": { + "smithy.api#documentation": "A list of foundation models that the prompt router can route requests to. At least one model must be specified.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#PromptRouterDescription", + "traits": { + "smithy.api#documentation": "An optional description of the prompt router to help identify its purpose.
" + } + }, + "routingCriteria": { + "target": "com.amazonaws.bedrock#RoutingCriteria", + "traits": { + "smithy.api#documentation": "The criteria, which is the response quality difference, used to determine how incoming requests are routed to different models.
", + "smithy.api#required": {} + } + }, + "fallbackModel": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModel", + "traits": { + "smithy.api#documentation": "The default model to use when the routing criteria is not met.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "An array of key-value pairs to apply to this resource as tags. You can use tags to categorize and manage your Amazon Web Services resources.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreatePromptRouterResponse": { + "type": "structure", + "members": { + "promptRouterArn": { + "target": "com.amazonaws.bedrock#PromptRouterArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the prompt router.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/provisioned-model-throughput" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.
", + "smithy.api#idempotencyToken": {} + } + }, + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs.
For model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.
For more information about what an MU specifies, contact your Amazon Web Services account manager.
", + "smithy.api#required": {} + } + }, + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "The name for this Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", + "traits": { + "smithy.api#documentation": "The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.
Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide
" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to associate with this Provisioned Throughput.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse": { + "type": "structure", + "members": { + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for this Provisioned Throughput.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModel": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#EvaluatorModelIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the evaluator model for custom metrics. For a list of supported evaluator models, see Evaluate model performance using another LLM as a judge and Evaluate the performance of RAG sources using Amazon Bedrock evaluations.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the model you want to evaluate custom metrics in an Amazon Bedrock evaluation job.
" + } + }, + "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModels": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#CustomMetricDefinition": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#MetricName", + "traits": { + "smithy.api#documentation": "The name for a custom metric. Names must be unique in your Amazon Web Services region.
", + "smithy.api#required": {} + } + }, + "instructions": { + "target": "com.amazonaws.bedrock#CustomMetricInstructions", + "traits": { + "smithy.api#documentation": "The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.
", + "smithy.api#required": {} + } + }, + "ratingScale": { + "target": "com.amazonaws.bedrock#RatingScale", + "traits": { + "smithy.api#documentation": "Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).
" + } + } + }, + "traits": { + "smithy.api#documentation": "The definition of a custom metric for use in an Amazon Bedrock evaluation job. A custom metric definition includes a metric name, prompt (instructions) and optionally, a rating scale. Your prompt must include a task description and input variables. The required input variables are different for model-as-a-judge and RAG evaluations.
For more information about how to define a custom metric in Amazon Bedrock, see Create a prompt for a custom metrics (LLM-as-a-judge model evaluations) and Create a prompt for a custom metrics (RAG evaluations).
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#CustomMetricEvaluatorModelConfig": { + "type": "structure", + "members": { + "bedrockEvaluatorModels": { + "target": "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModels", + "traits": { + "smithy.api#documentation": "Defines the model you want to evaluate custom metrics in an Amazon Bedrock evaluation job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration of the evaluator model you want to use to evaluate custom metrics in an Amazon Bedrock evaluation job.
" + } + }, + "com.amazonaws.bedrock#CustomMetricInstructions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + } + } + }, + "com.amazonaws.bedrock#CustomModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#CustomModelDataSource": { + "type": "union", + "members": { + "modelPackageArnDataSource": { + "target": "com.amazonaws.bedrock#ModelPackageArnDataSource", + "traits": { + "smithy.api#documentation": "A SageMaker AI model package ARN as the data source for the custom model. When you specify a model package ARN, Amazon Bedrock resolves the model package to retrieve the model artifacts.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The data source for a custom model. This is a union type that supports the following member:
modelPackageArnDataSource — Specifies a SageMaker AI model package as the data source.
The Amazon Resource Name (ARN) of the custom model deployment.
", + "smithy.api#required": {} + } + }, + "customModelDeploymentName": { + "target": "com.amazonaws.bedrock#ModelDeploymentName", + "traits": { + "smithy.api#documentation": "The name of the custom model deployment.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom model associated with this deployment.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the custom model deployment was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentStatus", + "traits": { + "smithy.api#documentation": "The status of the custom model deployment. Possible values are CREATING, ACTIVE, and FAILED.
The date and time when the custom model deployment was last modified.
" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "If the deployment status is FAILED, this field contains a message describing the failure reason.
Contains summary information about a custom model deployment, including its ARN, name, status, and associated custom model.
" + } + }, + "com.amazonaws.bedrock#CustomModelDeploymentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentSummary" + } + }, + "com.amazonaws.bedrock#CustomModelDeploymentUpdateDetails": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "ARN of the new custom model being deployed as part of the update.
", + "smithy.api#required": {} + } + }, + "updateStatus": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentUpdateStatus", + "traits": { + "smithy.api#documentation": "Current status of the deployment update.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an update to a custom model deployment, including the new custom model resource ARN and current update status.
" + } + }, + "com.amazonaws.bedrock#CustomModelDeploymentUpdateStatus": { + "type": "enum", + "members": { + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "UPDATE_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateCompleted" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + } + } + }, + "com.amazonaws.bedrock#CustomModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,63}$" + } + }, + "com.amazonaws.bedrock#CustomModelResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateCustomModel" + }, + { + "target": "com.amazonaws.bedrock#DeleteCustomModel" + }, + { + "target": "com.amazonaws.bedrock#GetCustomModel" + }, + { + "target": "com.amazonaws.bedrock#ListCustomModels" + } + ] + }, + "com.amazonaws.bedrock#CustomModelSummary": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom model.
", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "The name of the custom model.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Creation time of the model.
", + "smithy.api#required": {} + } + }, + "baseModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The base model Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "baseModelName": { + "target": "com.amazonaws.bedrock#ModelName", + "traits": { + "smithy.api#documentation": "The base model name.
", + "smithy.api#required": {} + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.
" + } + }, + "ownerAccountId": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "The unique identifier of the account that owns the model.
" + } + }, + "modelStatus": { + "target": "com.amazonaws.bedrock#ModelStatus", + "traits": { + "smithy.api#documentation": "The current status of the custom model. Possible values include:
Creating - The model is being created and validated.
Active - The model has been successfully created and is ready for use.
Failed - The model creation process failed.
Summary information for a custom model.
" + } + }, + "com.amazonaws.bedrock#CustomModelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#CustomModelSummary" + } + }, + "com.amazonaws.bedrock#CustomModelUnits": { + "type": "structure", + "members": { + "customModelUnitsPerModelCopy": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of custom model units used to host a model copy.
" + } + }, + "customModelUnitsVersion": { + "target": "com.amazonaws.bedrock#CustomModelUnitsVersion", + "traits": { + "smithy.api#documentation": "The version of the custom model unit. Use to determine the billing rate for the custom model unit.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A CustomModelUnit (CMU) is an abstract view of the hardware utilization that Amazon Bedrock needs to host a single copy of your custom model. A model copy represents a single instance of your imported model that is ready to serve inference requests. Amazon Bedrock determines the number of custom model units that a model copy needs when you import the custom model.
You can use CustomModelUnits to estimate the cost of running your custom model. For more information, see Calculate the cost of running a custom model in the Amazon Bedrock user guide.
The Distillation configuration for the custom model.
" + } + }, + "rftConfig": { + "target": "com.amazonaws.bedrock#RFTConfig", + "traits": { + "smithy.api#documentation": "Configuration settings for reinforcement fine-tuning (RFT) model customization, including grader configuration and hyperparameters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A model customization configuration
" + } + }, + "com.amazonaws.bedrock#CustomizationType": { + "type": "enum", + "members": { + "FINE_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINE_TUNING" + } + }, + "CONTINUED_PRE_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" + } + }, + "DISTILLATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTILLATION" + } + }, + "REINFORCEMENT_FINE_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REINFORCEMENT_FINE_TUNING" + } + }, + "IMPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORTED" + } + } + } + }, + "com.amazonaws.bedrock#DataProcessingDetails": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#JobStatusDetails", + "traits": { + "smithy.api#documentation": "The status of the data processing sub-task of the job.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the data processing sub-task of the job.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The latest update to the data processing sub-task of the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "For a Distillation job, the status details for the data processing sub-task of the job.
" + } + }, + "com.amazonaws.bedrock#DataRetentionMode": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + }, + "PROVIDER_DATA_SHARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provider_data_share" + } + }, + "INHERIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inherit" + } + } + }, + "traits": { + "smithy.api#documentation": "The data retention mode for the account. Valid values are:
default – The standard data handling for the model applies.
none – Zero data retention.
provider_data_share – Data may be shared with the model provider.
inherit – No data retention mode is set at this scope.
Deletes an Automated Reasoning policy or policy version. This operation is idempotent. If you delete a policy more than once, each call succeeds. Deleting a policy removes it permanently and cannot be undone.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/automated-reasoning-policies/{policyArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyBuildWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyBuildWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyBuildWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceInUseException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Automated Reasoning policy build workflow and its associated artifacts. This permanently removes the workflow history and any generated assets.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyBuildWorkflowRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the build workflow was last updated. This is used for optimistic concurrency control to prevent accidental deletion of workflows that have been modified.
", + "smithy.api#httpQuery": "updatedAt", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyBuildWorkflowResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "force": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether to force delete the automated reasoning policy even if it has active resources. When false, Amazon Bedrock validates if all artifacts have been deleted (e.g. policy version, test case, test result) for a policy before deletion. When true, Amazon Bedrock will delete the policy and all its artifacts without validation. Default is false.
Deletes an Automated Reasoning policy test. This operation is idempotent; if you delete a test more than once, each call succeeds.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/automated-reasoning-policies/{policyArn}/test-cases/{testCaseId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyTestCaseRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the test to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the test was last updated. This is used as a concurrency token to prevent conflicting modifications.
", + "smithy.api#httpQuery": "updatedAt", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyTestCaseResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteCustomModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteCustomModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteCustomModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/custom-models/{modelIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteCustomModelDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteCustomModelDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteCustomModelDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a custom model deployment. This operation stops the deployment and removes it from your account. After deletion, the deployment ARN can no longer be used for inference requests.
The following actions are related to the DeleteCustomModelDeployment operation:
The Amazon Resource Name (ARN) or name of the custom model deployment to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteCustomModelDeploymentResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteCustomModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "Name of the model to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteCustomModelResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteEnforcedGuardrailConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteEnforcedGuardrailConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteEnforcedGuardrailConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the account-level enforced guardrail configuration.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/enforcedGuardrailsConfiguration/{configId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteEnforcedGuardrailConfigurationRequest": { + "type": "structure", + "members": { + "configId": { + "target": "com.amazonaws.bedrock#AccountEnforcedGuardrailConfigurationId", + "traits": { + "smithy.api#documentation": "Unique ID for the account enforced configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteEnforcedGuardrailConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteFoundationModelAgreement": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteFoundationModelAgreementRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteFoundationModelAgreementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete the model access agreement for the specified model.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/delete-foundation-model-agreement" + } + } + }, + "com.amazonaws.bedrock#DeleteFoundationModelAgreementRequest": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "Model Id of the model access to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteFoundationModelAgreementResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteGuardrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceInUseException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a guardrail.
To delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier field. If you delete a guardrail, all of its versions will be deleted.
To delete a version of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field and the version in the guardrailVersion field.
The unique identifier of the guardrail. This can be an ID or the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#httpQuery": "guardrailVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteGuardrailResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteImportedModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteImportedModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteImportedModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/imported-models/{modelIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteImportedModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ImportedModelIdentifier", + "traits": { + "smithy.api#documentation": "Name of the imported model to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteImportedModelResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteInferenceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteInferenceProfileRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteInferenceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an application inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/inference-profiles/{inferenceProfileIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteInferenceProfileRequest": { + "type": "structure", + "members": { + "inferenceProfileIdentifier": { + "target": "com.amazonaws.bedrock#InferenceProfileIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) or ID of the application inference profile to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteInferenceProfileResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteMarketplaceModelEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteMarketplaceModelEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteMarketplaceModelEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an endpoint for a model from Amazon Bedrock Marketplace.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/marketplace-model/endpoints/{endpointArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteMarketplaceModelEndpointRequest": { + "type": "structure", + "members": { + "endpointArn": { + "target": "com.amazonaws.bedrock#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteMarketplaceModelEndpointResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Delete the invocation logging.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/logging/modelinvocations" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeletePromptRouter": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeletePromptRouterRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeletePromptRouterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a specified prompt router. This action cannot be undone.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/prompt-routers/{promptRouterArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeletePromptRouterRequest": { + "type": "structure", + "members": { + "promptRouterArn": { + "target": "com.amazonaws.bedrock#PromptRouterArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt router to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeletePromptRouterResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/provisioned-model-throughput/{provisionedModelId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) or name of the Provisioned Throughput.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a previously created Bedrock resource policy.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/resource-policy/{resourceArn}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "resource-policy" + ] + } + }, + "com.amazonaws.bedrock#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrock#ResourcePolicyResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the Bedrock resource to which this resource policy applies.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteResourcePolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/marketplace-model/endpoints/{endpointArn}/registration" + } + } + }, + "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpointRequest": { + "type": "structure", + "members": { + "endpointArn": { + "target": "com.amazonaws.bedrock#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint you want to deregister.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpointResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DimensionalPriceRate": { + "type": "structure", + "members": { + "dimension": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Dimension for the price rate.
" + } + }, + "price": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Single-dimensional rate information.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the price rate.
" + } + }, + "unit": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Unit associated with the price.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Dimensional price rate.
" + } + }, + "com.amazonaws.bedrock#DistillationConfig": { + "type": "structure", + "members": { + "teacherModelConfig": { + "target": "com.amazonaws.bedrock#TeacherModelConfig", + "traits": { + "smithy.api#documentation": "The teacher model configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for distilling a foundation model into a smaller and more efficient model.
" + } + }, + "com.amazonaws.bedrock#EndpointConfig": { + "type": "union", + "members": { + "sageMaker": { + "target": "com.amazonaws.bedrock#SageMakerEndpoint", + "traits": { + "smithy.api#documentation": "The configuration specific to Amazon SageMaker for the endpoint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the configuration for the endpoint.
" + } + }, + "com.amazonaws.bedrock#EndpointName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.bedrock#EnforcedGuardrailConfigurationResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#DeleteEnforcedGuardrailConfiguration" + }, + { + "target": "com.amazonaws.bedrock#ListEnforcedGuardrailsConfiguration" + }, + { + "target": "com.amazonaws.bedrock#PutEnforcedGuardrailConfiguration" + } + ] + }, + "com.amazonaws.bedrock#EntitlementAvailability": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_AVAILABLE" + } + } + } + }, + "com.amazonaws.bedrock#EpochCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.bedrock#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrock#ErrorMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ErrorMessage" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.bedrock#EvaluationBedrockKnowledgeBaseIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#KnowledgeBaseId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#EvaluationBedrockModel": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationBedrockModelIdentifier", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Bedrock model or inference profile specified.
", + "smithy.api#required": {} + } + }, + "inferenceParams": { + "target": "com.amazonaws.bedrock#EvaluationModelInferenceParams", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "{}", + "smithy.api#documentation": "Each Amazon Bedrock support different inference parameters that change how the model behaves during inference.
" + } + }, + "performanceConfig": { + "target": "com.amazonaws.bedrock#PerformanceConfiguration", + "traits": { + "smithy.api#documentation": "Specifies performance settings for the model or inference profile.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the ARN of the Amazon Bedrock model or inference profile specified in your evaluation job. Each Amazon Bedrock model supports different inferenceParams. To learn more about supported inference parameters for Amazon Bedrock models, see Inference parameters for foundation models.
The inferenceParams are specified using JSON. To successfully insert JSON as string make sure that all quotations are properly escaped. For example, \"temperature\":\"0.25\" key value pair would need to be formatted as \\\"temperature\\\":\\\"0.25\\\" to successfully accepted in the request.
Contains the configuration details of an automated evaluation job that computes metrics.
" + } + }, + "human": { + "target": "com.amazonaws.bedrock#HumanEvaluationConfig", + "traits": { + "smithy.api#documentation": "Contains the configuration details of an evaluation job that uses human workers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details of either an automated or human-based evaluation job.
" + } + }, + "com.amazonaws.bedrock#EvaluationDataset": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#EvaluationDatasetName", + "traits": { + "smithy.api#documentation": "Used to specify supported built-in prompt datasets. Valid values are Builtin.Bold, Builtin.BoolQ, Builtin.NaturalQuestions, Builtin.Gigaword, Builtin.RealToxicityPrompts, Builtin.TriviaQA, Builtin.T-Rex, Builtin.WomensEcommerceClothingReviews and Builtin.Wikitext2.
For custom prompt datasets, you must specify the location in Amazon S3 where the prompt dataset is saved.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Used to specify the name of a built-in prompt dataset and optionally, the Amazon S3 bucket where a custom prompt dataset is saved.
" + } + }, + "com.amazonaws.bedrock#EvaluationDatasetLocation": { + "type": "union", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI of the S3 bucket specified in the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location in Amazon S3 where your prompt dataset is stored.
" + } + }, + "com.amazonaws.bedrock#EvaluationDatasetMetricConfig": { + "type": "structure", + "members": { + "taskType": { + "target": "com.amazonaws.bedrock#EvaluationTaskType", + "traits": { + "smithy.api#documentation": "The the type of task you want to evaluate for your evaluation job. This applies only to model evaluation jobs and is ignored for knowledge base evaluation jobs.
", + "smithy.api#required": {} + } + }, + "dataset": { + "target": "com.amazonaws.bedrock#EvaluationDataset", + "traits": { + "smithy.api#documentation": "Specifies the prompt dataset.
", + "smithy.api#required": {} + } + }, + "metricNames": { + "target": "com.amazonaws.bedrock#EvaluationMetricNames", + "traits": { + "smithy.api#documentation": "The names of the metrics you want to use for your evaluation job.
For knowledge base evaluation jobs that evaluate retrieval only, valid values are \"Builtin.ContextRelevance\", \"Builtin.ContextCoverage\".
For knowledge base evaluation jobs that evaluate retrieval with response generation, valid values are \"Builtin.Correctness\", \"Builtin.Completeness\", \"Builtin.Helpfulness\", \"Builtin.LogicalCoherence\", \"Builtin.Faithfulness\", \"Builtin.Harmfulness\", \"Builtin.Stereotyping\", \"Builtin.Refusal\".
For automated model evaluation jobs, valid values are \"Builtin.Accuracy\", \"Builtin.Robustness\", and \"Builtin.Toxicity\". In model evaluation jobs that use a LLM as judge you can specify \"Builtin.Correctness\", \"Builtin.Completeness\", \"Builtin.Faithfulness\", \"Builtin.Helpfulness\", \"Builtin.Coherence\", \"Builtin.Relevance\", \"Builtin.FollowingInstructions\", \"Builtin.ProfessionalStyleAndTone\", You can also specify the following responsible AI related metrics only for model evaluation job that use a LLM as judge \"Builtin.Harmfulness\", \"Builtin.Stereotyping\", and \"Builtin.Refusal\".
For human-based model evaluation jobs, the list of strings must match the name parameter specified in HumanEvaluationCustomMetric.
Defines the prompt datasets, built-in metric names and custom metric names, and the task type.
" + } + }, + "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#EvaluationDatasetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationInferenceConfig": { + "type": "union", + "members": { + "models": { + "target": "com.amazonaws.bedrock#EvaluationModelConfigs", + "traits": { + "smithy.api#documentation": "Specifies the inference models.
" + } + }, + "ragConfigs": { + "target": "com.amazonaws.bedrock#RagConfigs", + "traits": { + "smithy.api#documentation": "Contains the configuration details of the inference for a knowledge base evaluation job, including either the retrieval only configuration or the retrieval with response generation configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details of the inference model for an evaluation job.
For automated model evaluation jobs, only a single model is supported.
For human-based model evaluation jobs, your annotator can compare the responses for up to two different models.
" + } + }, + "com.amazonaws.bedrock#EvaluationInferenceConfigSummary": { + "type": "structure", + "members": { + "modelConfigSummary": { + "target": "com.amazonaws.bedrock#EvaluationModelConfigSummary", + "traits": { + "smithy.api#documentation": "A summary of the models used in an Amazon Bedrock model evaluation job. These resources can be models in Amazon Bedrock or models outside of Amazon Bedrock that you use to generate your own inference response data.
" + } + }, + "ragConfigSummary": { + "target": "com.amazonaws.bedrock#EvaluationRagConfigSummary", + "traits": { + "smithy.api#documentation": "A summary of the RAG resources used in an Amazon Bedrock Knowledge Base evaluation job. These resources can be Knowledge Bases in Amazon Bedrock or RAG sources outside of Amazon Bedrock that you use to generate your own inference response data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.
" + } + }, + "com.amazonaws.bedrock#EvaluationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#EvaluationJobDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationJobIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bedrock#EvaluationJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9]){0,62}$" + } + }, + "com.amazonaws.bedrock#EvaluationJobResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJob" + }, + { + "target": "com.amazonaws.bedrock#CreateEvaluationJob" + }, + { + "target": "com.amazonaws.bedrock#GetEvaluationJob" + }, + { + "target": "com.amazonaws.bedrock#ListEvaluationJobs" + }, + { + "target": "com.amazonaws.bedrock#StopEvaluationJob" + } + ] + }, + "com.amazonaws.bedrock#EvaluationJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.bedrock#EvaluationJobType": { + "type": "enum", + "members": { + "HUMAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Human" + } + }, + "AUTOMATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Automated" + } + } + } + }, + "com.amazonaws.bedrock#EvaluationMetricDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^.+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationMetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationMetricNames": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationMetricName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bedrock#EvaluationModelConfig": { + "type": "union", + "members": { + "bedrockModel": { + "target": "com.amazonaws.bedrock#EvaluationBedrockModel", + "traits": { + "smithy.api#documentation": "Defines the Amazon Bedrock model or inference profile and inference parameters you want used.
" + } + }, + "precomputedInferenceSource": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSource", + "traits": { + "smithy.api#documentation": "Defines the model used to generate inference response data for a model evaluation job where you provide your own inference response data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the models used in the model evaluation job.
" + } + }, + "com.amazonaws.bedrock#EvaluationModelConfigSummary": { + "type": "structure", + "members": { + "bedrockModelIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationBedrockModelIdentifiers", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the models used for the evaluation job.
" + } + }, + "precomputedInferenceSourceIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifiers", + "traits": { + "smithy.api#documentation": "A label that identifies the models used for a model evaluation job where you provide your own inference response data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the models used in an Amazon Bedrock model evaluation job. These resources can be models in Amazon Bedrock or models outside of Amazon Bedrock that you use to generate your own inference response data.
" + } + }, + "com.amazonaws.bedrock#EvaluationModelConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationModelConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrock#EvaluationModelInferenceParams": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1023 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationOutputDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI where the results of the evaluation job are saved.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location where the results of your evaluation job are saved.
" + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSource": { + "type": "structure", + "members": { + "inferenceSourceIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifier", + "traits": { + "smithy.api#documentation": "A label that identifies a model used in a model evaluation job where you provide your own inference response data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of a model used for a model evaluation job where you provide your own inference response data.
" + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9._-]){0,255}$" + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceConfig": { + "type": "union", + "members": { + "retrieveSourceConfig": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRetrieveSourceConfig", + "traits": { + "smithy.api#documentation": "A summary of a RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.
" + } + }, + "retrieveAndGenerateSourceConfig": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRetrieveAndGenerateSourceConfig", + "traits": { + "smithy.api#documentation": "A summary of a RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of a RAG source used for a Knowledge Base evaluation job where you provide your own inference response data.
" + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9._-]){0,255}$" + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedRetrieveAndGenerateSourceConfig": { + "type": "structure", + "members": { + "ragSourceIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifier", + "traits": { + "smithy.api#documentation": "A label that identifies the RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of a RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.
" + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedRetrieveSourceConfig": { + "type": "structure", + "members": { + "ragSourceIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifier", + "traits": { + "smithy.api#documentation": "A label that identifies the RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of a RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.
" + } + }, + "com.amazonaws.bedrock#EvaluationRagConfigSummary": { + "type": "structure", + "members": { + "bedrockKnowledgeBaseIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationBedrockKnowledgeBaseIdentifiers", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the Knowledge Base resources used for a Knowledge Base evaluation job where Amazon Bedrock invokes the Knowledge Base for you.
" + } + }, + "precomputedRagSourceIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifiers", + "traits": { + "smithy.api#documentation": "A label that identifies the RAG sources used for a Knowledge Base evaluation job where you provide your own inference response data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the RAG resources used in an Amazon Bedrock Knowledge Base evaluation job. These resources can be Knowledge Bases in Amazon Bedrock or RAG sources outside of Amazon Bedrock that you use to generate your own inference response data.
" + } + }, + "com.amazonaws.bedrock#EvaluationRatingMethod": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_]+$" + } + }, + "com.amazonaws.bedrock#EvaluationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationSummary" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#EvaluationSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#EvaluationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the evaluation job.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "The name for the evaluation job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "The current status of the evaluation job.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time the evaluation job was created.
", + "smithy.api#required": {} + } + }, + "jobType": { + "target": "com.amazonaws.bedrock#EvaluationJobType", + "traits": { + "smithy.api#documentation": "Specifies whether the evaluation job is automated or human-based.
", + "smithy.api#required": {} + } + }, + "evaluationTaskTypes": { + "target": "com.amazonaws.bedrock#EvaluationTaskTypes", + "traits": { + "smithy.api#documentation": "The type of task for model evaluation.
", + "smithy.api#required": {} + } + }, + "modelIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationBedrockModelIdentifiers", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": [], + "smithy.api#deprecated": { + "since": "2025-03-07", + "message": "Inference identifiers should be retrieved from the inferenceConfigSummary" + }, + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.
" + } + }, + "ragIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationBedrockKnowledgeBaseIdentifiers", + "traits": { + "smithy.api#deprecated": { + "since": "2025-03-07", + "message": "Inference identifiers should be retrieved from the inferenceConfigSummary" + }, + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.
" + } + }, + "evaluatorModelIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluatorModelIdentifiers", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.
" + } + }, + "customMetricsEvaluatorModelIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluatorModelIdentifiers", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.
" + } + }, + "inferenceConfigSummary": { + "target": "com.amazonaws.bedrock#EvaluationInferenceConfigSummary", + "traits": { + "smithy.api#documentation": "Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.
" + } + }, + "applicationType": { + "target": "com.amazonaws.bedrock#ApplicationType", + "traits": { + "smithy.api#documentation": "Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information of an evaluation job.
" + } + }, + "com.amazonaws.bedrock#EvaluationTaskType": { + "type": "enum", + "members": { + "SUMMARIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Summarization" + } + }, + "CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Classification" + } + }, + "QUESTION_AND_ANSWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QuestionAndAnswer" + } + }, + "GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Generation" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Custom" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+$" + } + }, + "com.amazonaws.bedrock#EvaluationTaskTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationTaskType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#EvaluatorModelConfig": { + "type": "union", + "members": { + "bedrockEvaluatorModels": { + "target": "com.amazonaws.bedrock#BedrockEvaluatorModels", + "traits": { + "smithy.api#documentation": "The evaluator model used in knowledge base evaluation job or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the model configuration for the evaluator model. EvaluatorModelConfig is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.
Exports the policy definition for an Automated Reasoning policy version. Returns the complete policy definition including rules, variables, and custom variable types in a structured format.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/export" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ExportAutomatedReasoningPolicyVersionRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy to export. Can be either the unversioned ARN for the draft policy or a versioned ARN for a specific policy version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ExportAutomatedReasoningPolicyVersionResponse": { + "type": "structure", + "members": { + "policyDefinition": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition", + "traits": { + "smithy.api#documentation": "The exported policy definition containing the formal logic rules, variables, and custom variable types.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ExternalSource": { + "type": "structure", + "members": { + "sourceType": { + "target": "com.amazonaws.bedrock#ExternalSourceType", + "traits": { + "smithy.api#documentation": "The source type of the external source wrapper object.
", + "smithy.api#required": {} + } + }, + "s3Location": { + "target": "com.amazonaws.bedrock#S3ObjectDoc", + "traits": { + "smithy.api#documentation": "The S3 location of the external source wrapper object.
" + } + }, + "byteContent": { + "target": "com.amazonaws.bedrock#ByteContentDoc", + "traits": { + "smithy.api#documentation": "The identifier, content type, and data of the external source wrapper object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The unique external source of the content contained in the wrapper object.
" + } + }, + "com.amazonaws.bedrock#ExternalSourceType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "BYTE_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYTE_CONTENT" + } + } + } + }, + "com.amazonaws.bedrock#ExternalSources": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ExternalSource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#ExternalSourcesGenerationConfiguration": { + "type": "structure", + "members": { + "promptTemplate": { + "target": "com.amazonaws.bedrock#PromptTemplate", + "traits": { + "smithy.api#documentation": "Contains the template for the prompt for the external source wrapper object.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrock#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Configuration details for the guardrail.
" + } + }, + "kbInferenceConfig": { + "target": "com.amazonaws.bedrock#KbInferenceConfig", + "traits": { + "smithy.api#documentation": "Configuration details for inference when using RetrieveAndGenerate to generate responses while using an external source.
Additional model parameters and their corresponding values not included in the text inference configuration for an external source. Takes in custom model parameters specific to the language model being used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The response generation configuration of the external source wrapper object.
" + } + }, + "com.amazonaws.bedrock#ExternalSourcesRetrieveAndGenerateConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.
", + "smithy.api#required": {} + } + }, + "sources": { + "target": "com.amazonaws.bedrock#ExternalSources", + "traits": { + "smithy.api#documentation": "The document for the external source wrapper object in the retrieveAndGenerate function.
Contains configurations details for response generation based on retrieved text chunks.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the external source wrapper object in the retrieveAndGenerate function.
The name of the metadata field to be used during the reranking process.
", + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a field to be used during the reranking process in a Knowledge Base vector search. This structure identifies metadata fields that should be considered when reordering search results to improve relevance.
" + } + }, + "com.amazonaws.bedrock#FieldsForReranking": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#FieldForReranking" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#FilterAttribute": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrock#FilterKey", + "traits": { + "smithy.api#documentation": "The name of metadata attribute/field, which must match the name in your data source/document metadata.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrock#FilterValue", + "traits": { + "smithy.api#documentation": "The value of the metadata attribute/field.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the name of the metadata attribute/field to apply filters. You must match the name of the attribute/field in your data source/document metadata.
" + } + }, + "com.amazonaws.bedrock#FilterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrock#FilterValue": { + "type": "document" + }, + "com.amazonaws.bedrock#FineTuningJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.bedrock#FoundationModelArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$" + } + }, + "com.amazonaws.bedrock#FoundationModelDetails": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "The model Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "The model identifier.
", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "The model name.
" + } + }, + "providerName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "The model's provider name.
" + } + }, + "inputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "The input modalities that the model supports.
" + } + }, + "outputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "The output modalities that the model supports.
" + } + }, + "responseStreamingSupported": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the model supports streaming.
" + } + }, + "customizationsSupported": { + "target": "com.amazonaws.bedrock#ModelCustomizationList", + "traits": { + "smithy.api#documentation": "The customization that the model supports.
" + } + }, + "inferenceTypesSupported": { + "target": "com.amazonaws.bedrock#InferenceTypeList", + "traits": { + "smithy.api#documentation": "The inference types that the model supports.
" + } + }, + "modelLifecycle": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "traits": { + "smithy.api#documentation": "Contains details about whether a model version is available or deprecated
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a foundation model.
" + } + }, + "com.amazonaws.bedrock#FoundationModelLifecycle": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycleStatus", + "traits": { + "smithy.api#documentation": "Specifies whether a model version is available (ACTIVE) or deprecated (LEGACY.
Launch time when the model first becomes available
" + } + }, + "endOfLifeTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Time when the model is no longer available for use
" + } + }, + "legacyTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Time when the model enters legacy state. Models in legacy state can still be used, but users should plan to transition to an Active model before the end of life time
" + } + }, + "publicExtendedAccessTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Public extended access portion of the legacy period, when users should expect higher pricing
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about whether a model version is available or deprecated.
" + } + }, + "com.amazonaws.bedrock#FoundationModelLifecycleStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "LEGACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEGACY" + } + } + } + }, + "com.amazonaws.bedrock#FoundationModelSummary": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the foundation model.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "The model ID of the foundation model.
", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "The name of the model.
" + } + }, + "providerName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "The model's provider name.
" + } + }, + "inputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "The input modalities that the model supports.
" + } + }, + "outputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "The output modalities that the model supports.
" + } + }, + "responseStreamingSupported": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the model supports streaming.
" + } + }, + "customizationsSupported": { + "target": "com.amazonaws.bedrock#ModelCustomizationList", + "traits": { + "smithy.api#documentation": "Whether the model supports fine-tuning or continual pre-training.
" + } + }, + "inferenceTypesSupported": { + "target": "com.amazonaws.bedrock#InferenceTypeList", + "traits": { + "smithy.api#documentation": "The inference types that the model supports.
" + } + }, + "modelLifecycle": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "traits": { + "smithy.api#documentation": "Contains details about whether a model version is available or deprecated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information for a foundation model.
" + } + }, + "com.amazonaws.bedrock#FoundationModelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#FoundationModelSummary" + } + }, + "com.amazonaws.bedrock#GenerationConfiguration": { + "type": "structure", + "members": { + "promptTemplate": { + "target": "com.amazonaws.bedrock#PromptTemplate", + "traits": { + "smithy.api#documentation": "Contains the template for the prompt that's sent to the model for response generation.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrock#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Contains configuration details for the guardrail.
" + } + }, + "kbInferenceConfig": { + "target": "com.amazonaws.bedrock#KbInferenceConfig", + "traits": { + "smithy.api#documentation": "Contains configuration details for inference for knowledge base retrieval and response generation.
" + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrock#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows you to provide custom model parameters specific to the language model being used.
The configuration details for response generation based on retrieved text chunks.
" + } + }, + "com.amazonaws.bedrock#GetAccountDataRetention": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAccountDataRetentionRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAccountDataRetentionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the account-wide data retention mode for Amazon Bedrock.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/data-retention" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAccountDataRetentionRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetAccountDataRetentionResponse": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.bedrock#DataRetentionMode", + "traits": { + "smithy.api#documentation": "The data retention mode configured for the account.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the data retention mode was last updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetAdvancedPromptOptimizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAdvancedPromptOptimizationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAdvancedPromptOptimizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an advanced prompt optimization job.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/advanced-prompt-optimization-jobs/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAdvancedPromptOptimizationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobIdentifier", + "traits": { + "smithy.api#documentation": "The ARN or ID of the advanced prompt optimization job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Advanced Prompt Optimization Job Request
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetAdvancedPromptOptimizationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the advanced prompt optimization job.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobName", + "traits": { + "smithy.api#documentation": "The name of the advanced prompt optimization job.
", + "smithy.api#required": {} + } + }, + "jobDescription": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobDescription", + "traits": { + "smithy.api#documentation": "The description of the advanced prompt optimization job.
" + } + }, + "jobStatus": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobStatus", + "traits": { + "smithy.api#documentation": "The status of the advanced prompt optimization job.
", + "smithy.api#required": {} + } + }, + "inputConfig": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationInputConfig", + "traits": { + "smithy.api#documentation": "The input data configuration for the optimization job.
", + "smithy.api#required": {} + } + }, + "outputConfig": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationOutputConfig", + "traits": { + "smithy.api#documentation": "The output data configuration for the optimization job.
", + "smithy.api#required": {} + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the output data.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the advanced prompt optimization job was created.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the advanced prompt optimization job was last modified.
" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "If the job failed, a message describing the reason for the failure.
" + } + }, + "modelConfigurations": { + "target": "com.amazonaws.bedrock#ModelConfigurations", + "traits": { + "smithy.api#documentation": "The model configurations used in the optimization job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Get Advanced Prompt Optimization Job Response
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyAnnotations": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyAnnotationsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyAnnotationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the current annotations for an Automated Reasoning policy build workflow. Annotations contain corrections to the rules, variables and types to be applied to the policy.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/annotations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyAnnotationsRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy whose annotations you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow whose annotations you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyAnnotationsResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", + "traits": { + "smithy.api#documentation": "The name of the Automated Reasoning policy.
", + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow.
", + "smithy.api#required": {} + } + }, + "annotations": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationList", + "traits": { + "smithy.api#documentation": "The current set of annotations containing rules, variables, and types extracted from the source documents. These can be modified before finalizing the policy.
", + "smithy.api#required": {} + } + }, + "annotationSetHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "A hash value representing the current state of the annotations. This is used for optimistic concurrency control when updating annotations.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the annotations were last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy.
", + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowStatus", + "traits": { + "smithy.api#documentation": "The current status of the build workflow (e.g., RUNNING, COMPLETED, FAILED, CANCELLED).
", + "smithy.api#required": {} + } + }, + "buildWorkflowType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowType", + "traits": { + "smithy.api#documentation": "The type of build workflow being executed (e.g., DOCUMENT_INGESTION, POLICY_REPAIR).
", + "smithy.api#required": {} + } + }, + "documentName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentName", + "traits": { + "smithy.api#documentation": "The name of the source document used in the build workflow.
" + } + }, + "documentContentType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentContentType", + "traits": { + "smithy.api#documentation": "The content type of the source document (e.g., text/plain, application/pdf).
" + } + }, + "documentDescription": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentDescription", + "traits": { + "smithy.api#documentation": "A detailed description of the document's content and how it should be used in the policy generation process.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the build workflow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the build workflow was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResultAssets": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResultAssetsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResultAssetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/result-assets" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResultAssetsRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow assets you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow whose result assets you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assetType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetType", + "traits": { + "smithy.api#documentation": "The type of asset to retrieve (e.g., BUILD_LOG, QUALITY_REPORT, POLICY_DEFINITION, GENERATED_TEST_CASES, POLICY_SCENARIOS, FIDELITY_REPORT, ASSET_MANIFEST, SOURCE_DOCUMENT).
", + "smithy.api#httpQuery": "assetType", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the specific asset to retrieve when multiple assets of the same type exist. This is required when retrieving SOURCE_DOCUMENT assets, as multiple source documents may have been used in the workflow. The asset ID can be obtained from the asset manifest.
", + "smithy.api#httpQuery": "assetId" + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResultAssetsResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy.
", + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow.
", + "smithy.api#required": {} + } + }, + "buildWorkflowAssets": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssets", + "traits": { + "smithy.api#documentation": "The requested build workflow asset. This is a union type that returns only one of the available asset types (logs, reports, or generated artifacts) based on the specific asset type requested in the API call.
" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyNextScenario": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyNextScenarioRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyNextScenarioResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the next test scenario for validating an Automated Reasoning policy. This is used during the interactive policy refinement process to test policy behavior.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/scenarios" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyNextScenarioRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy for which you want to get the next test scenario.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow associated with the test scenarios.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyNextScenarioResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy.
", + "smithy.api#required": {} + } + }, + "scenario": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyScenario", + "traits": { + "smithy.api#documentation": "The next test scenario to validate, including the test expression and expected results.
" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy to retrieve. Can be either the unversioned ARN for the draft policy or an ARN for a specific policy version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", + "traits": { + "smithy.api#documentation": "The name of the policy.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyVersion", + "traits": { + "smithy.api#documentation": "The version of the policy.
", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription", + "traits": { + "smithy.api#documentation": "The description of the policy.
" + } + }, + "definitionHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "The hash of the policy definition used as a concurrency token.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the automated reasoning policy and its associated artifacts. If a KMS key is not provided during the initial CreateAutomatedReasoningPolicyRequest, the kmsKeyArn won't be included in the GetAutomatedReasoningPolicyResponse.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was created.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestCase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestCaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestCaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves details about a specific Automated Reasoning policy test.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/test-cases/{testCaseId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestCaseRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the test to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestCaseResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy that contains the test.
", + "smithy.api#required": {} + } + }, + "testCase": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCase", + "traits": { + "smithy.api#documentation": "The test details including the content, query, expected result, and metadata.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestResult": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestResultRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestResultResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the test result for a specific Automated Reasoning policy test. Returns detailed validation findings and execution status.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/test-cases/{testCaseId}/test-results" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestResultRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The build workflow identifier. The build workflow must display a COMPLETED status to get results.
The unique identifier of the test for which to retrieve results.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestResultResponse": { + "type": "structure", + "members": { + "testResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestResult", + "traits": { + "smithy.api#documentation": "The test result containing validation findings, execution status, and detailed analysis.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetCustomModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetCustomModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetCustomModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get the properties associated with a Amazon Bedrock custom model that you have created. For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/custom-models/{modelIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetCustomModelDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetCustomModelDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a custom model deployment, including its status, configuration, and metadata. Use this operation to monitor the deployment status and retrieve details needed for inference requests.
The following actions are related to the GetCustomModelDeployment operation:
The Amazon Resource Name (ARN) or name of the custom model deployment to retrieve information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelDeploymentResponse": { + "type": "structure", + "members": { + "customModelDeploymentArn": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom model deployment.
", + "smithy.api#required": {} + } + }, + "modelDeploymentName": { + "target": "com.amazonaws.bedrock#ModelDeploymentName", + "traits": { + "smithy.api#documentation": "The name of the custom model deployment.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom model associated with this deployment.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the custom model deployment was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentStatus", + "traits": { + "smithy.api#documentation": "The status of the custom model deployment. Possible values are:
CREATING - The deployment is being set up and prepared for inference.
ACTIVE - The deployment is ready and available for inference requests.
FAILED - The deployment failed to be created or became unavailable.
The description of the custom model deployment.
" + } + }, + "updateDetails": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentUpdateDetails", + "traits": { + "smithy.api#documentation": "Details about any pending or completed updates to the custom model deployment, including the new model ARN and update status.
" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "If the deployment status is FAILED, this field contains a message describing the failure reason.
The date and time when the custom model deployment was last updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "Name or Amazon Resource Name (ARN) of the custom model.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelResponse": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) associated with this model.
", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "Model name associated with this model.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "Job name associated with this model.
" + } + }, + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "traits": { + "smithy.api#documentation": "Job Amazon Resource Name (ARN) associated with this model. For models that you create with the CreateCustomModel API operation, this is NULL.
Amazon Resource Name (ARN) of the base model.
" + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "The type of model customization.
" + } + }, + "modelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The custom model is encrypted at rest using this key.
" + } + }, + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "traits": { + "smithy.api#documentation": "Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.
" + } + }, + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", + "traits": { + "smithy.api#documentation": "Contains information about the training dataset.
" + } + }, + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", + "traits": { + "smithy.api#documentation": "Contains information about the validation dataset.
" + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", + "traits": { + "smithy.api#documentation": "Output data configuration associated with this custom model.
" + } + }, + "trainingMetrics": { + "target": "com.amazonaws.bedrock#TrainingMetrics", + "traits": { + "smithy.api#documentation": "Contains training metrics from the job creation.
" + } + }, + "validationMetrics": { + "target": "com.amazonaws.bedrock#ValidationMetrics", + "traits": { + "smithy.api#documentation": "The validation metrics from the job creation.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Creation time of the model.
", + "smithy.api#required": {} + } + }, + "customizationConfig": { + "target": "com.amazonaws.bedrock#CustomizationConfig", + "traits": { + "smithy.api#documentation": "The customization configuration for the custom model.
" + } + }, + "modelStatus": { + "target": "com.amazonaws.bedrock#ModelStatus", + "traits": { + "smithy.api#documentation": "The current status of the custom model. Possible values include:
Creating - The model is being created and validated.
Active - The model has been successfully created and is ready for use.
Failed - The model creation process failed. Check the failureMessage field for details.
A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetEvaluationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an evaluation job, such as the status of the job.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/evaluation-jobs/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetEvaluationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the evaluation job you want get information on.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetEvaluationJobResponse": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "The name for the evaluation job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "The current status of the evaluation job.
", + "smithy.api#required": {} + } + }, + "jobArn": { + "target": "com.amazonaws.bedrock#EvaluationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the evaluation job.
", + "smithy.api#required": {} + } + }, + "jobDescription": { + "target": "com.amazonaws.bedrock#EvaluationJobDescription", + "traits": { + "smithy.api#documentation": "The description of the evaluation job.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role used in the evaluation job.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer managed encryption key specified when the evaluation job was created.
" + } + }, + "jobType": { + "target": "com.amazonaws.bedrock#EvaluationJobType", + "traits": { + "smithy.api#documentation": "Specifies whether the evaluation job is automated or human-based.
", + "smithy.api#required": {} + } + }, + "applicationType": { + "target": "com.amazonaws.bedrock#ApplicationType", + "traits": { + "smithy.api#documentation": "Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
" + } + }, + "evaluationConfig": { + "target": "com.amazonaws.bedrock#EvaluationConfig", + "traits": { + "smithy.api#documentation": "Contains the configuration details of either an automated or human-based evaluation job.
", + "smithy.api#required": {} + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", + "traits": { + "smithy.api#documentation": "Contains the configuration details of the inference model used for the evaluation job.
", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", + "traits": { + "smithy.api#documentation": "Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time the evaluation job was created.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time the evaluation job was last modified.
" + } + }, + "failureMessages": { + "target": "com.amazonaws.bedrock#ErrorMessages", + "traits": { + "smithy.api#documentation": "A list of strings that specify why the evaluation job failed to create.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetFoundationModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetFoundationModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get details about a Amazon Bedrock foundation model.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/foundation-models/{modelIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelAvailability": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetFoundationModelAvailabilityRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetFoundationModelAvailabilityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get information about the Foundation model availability.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/foundation-model-availability/{modelId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelAvailabilityRequest": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "The model Id of the foundation model.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelAvailabilityResponse": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "The model Id of the foundation model.
", + "smithy.api#required": {} + } + }, + "agreementAvailability": { + "target": "com.amazonaws.bedrock#AgreementAvailability", + "traits": { + "smithy.api#documentation": "Agreement availability.
", + "smithy.api#required": {} + } + }, + "authorizationStatus": { + "target": "com.amazonaws.bedrock#AuthorizationStatus", + "traits": { + "smithy.api#documentation": "Authorization status.
", + "smithy.api#required": {} + } + }, + "entitlementAvailability": { + "target": "com.amazonaws.bedrock#EntitlementAvailability", + "traits": { + "smithy.api#documentation": "Entitlement availability.
", + "smithy.api#required": {} + } + }, + "regionAvailability": { + "target": "com.amazonaws.bedrock#RegionAvailability", + "traits": { + "smithy.api#documentation": "Region availability.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})$" + } + }, + "com.amazonaws.bedrock#GetFoundationModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#GetFoundationModelIdentifier", + "traits": { + "smithy.api#documentation": "The model identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelResponse": { + "type": "structure", + "members": { + "modelDetails": { + "target": "com.amazonaws.bedrock#FoundationModelDetails", + "traits": { + "smithy.api#documentation": "Information about the foundation model.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetGuardrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.
The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrock#GuardrailVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the DRAFT version.
The name of the guardrail.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "The description of the guardrail.
" + } + }, + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail.
", + "smithy.api#required": {} + } + }, + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", + "traits": { + "smithy.api#documentation": "The ARN of the guardrail.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#GuardrailStatus", + "traits": { + "smithy.api#documentation": "The status of the guardrail.
", + "smithy.api#required": {} + } + }, + "topicPolicy": { + "target": "com.amazonaws.bedrock#GuardrailTopicPolicy", + "traits": { + "smithy.api#documentation": "The topic policy that was configured for the guardrail.
" + } + }, + "contentPolicy": { + "target": "com.amazonaws.bedrock#GuardrailContentPolicy", + "traits": { + "smithy.api#documentation": "The content policy that was configured for the guardrail.
" + } + }, + "wordPolicy": { + "target": "com.amazonaws.bedrock#GuardrailWordPolicy", + "traits": { + "smithy.api#documentation": "The word policy that was configured for the guardrail.
" + } + }, + "sensitiveInformationPolicy": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicy", + "traits": { + "smithy.api#documentation": "The sensitive information policy that was configured for the guardrail.
" + } + }, + "contextualGroundingPolicy": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicy", + "traits": { + "smithy.api#documentation": "The contextual grounding policy used in the guardrail.
" + } + }, + "automatedReasoningPolicy": { + "target": "com.amazonaws.bedrock#GuardrailAutomatedReasoningPolicy", + "traits": { + "smithy.api#documentation": "The current Automated Reasoning policy configuration for the guardrail, if any is configured.
" + } + }, + "crossRegionDetails": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionDetails", + "traits": { + "smithy.api#documentation": "Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the guardrail was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the guardrail was updated.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrock#GuardrailStatusReasons", + "traits": { + "smithy.api#documentation": "Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.
Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.
The message that the guardrail returns when it blocks a prompt.
", + "smithy.api#required": {} + } + }, + "blockedOutputsMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "The message that the guardrail returns when it blocks a model response.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key that encrypts the guardrail.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetImportedModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetImportedModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetImportedModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets properties associated with a customized model you imported.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/imported-models/{modelIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetImportedModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ImportedModelIdentifier", + "traits": { + "smithy.api#documentation": "Name or Amazon Resource Name (ARN) of the imported model.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetImportedModelResponse": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#ImportedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with this imported model.
" + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "The name of the imported model.
" + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "Job name associated with the imported model.
" + } + }, + "jobArn": { + "target": "com.amazonaws.bedrock#ModelImportJobArn", + "traits": { + "smithy.api#documentation": "Job Amazon Resource Name (ARN) associated with the imported model.
" + } + }, + "modelDataSource": { + "target": "com.amazonaws.bedrock#ModelDataSource", + "traits": { + "smithy.api#documentation": "The data source for this imported model.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Creation time of the imported model.
" + } + }, + "modelArchitecture": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The architecture of the imported model.
" + } + }, + "modelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The imported model is encrypted at rest using this key.
" + } + }, + "instructSupported": { + "target": "com.amazonaws.bedrock#InstructSupported", + "traits": { + "smithy.api#documentation": "Specifies if the imported model supports converse.
" + } + }, + "customModelUnits": { + "target": "com.amazonaws.bedrock#CustomModelUnits", + "traits": { + "smithy.api#documentation": "Information about the hardware utilization for a single copy of the model.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetInferenceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetInferenceProfileRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetInferenceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/inference-profiles/{inferenceProfileIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetInferenceProfileRequest": { + "type": "structure", + "members": { + "inferenceProfileIdentifier": { + "target": "com.amazonaws.bedrock#InferenceProfileIdentifier", + "traits": { + "smithy.api#documentation": "The ID or Amazon Resource Name (ARN) of the inference profile.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetInferenceProfileResponse": { + "type": "structure", + "members": { + "inferenceProfileName": { + "target": "com.amazonaws.bedrock#InferenceProfileName", + "traits": { + "smithy.api#documentation": "The name of the inference profile.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#InferenceProfileDescription", + "traits": { + "smithy.api#documentation": "The description of the inference profile.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the inference profile was created.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the inference profile was last updated.
" + } + }, + "inferenceProfileArn": { + "target": "com.amazonaws.bedrock#InferenceProfileArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference profile.
", + "smithy.api#required": {} + } + }, + "models": { + "target": "com.amazonaws.bedrock#InferenceProfileModels", + "traits": { + "smithy.api#documentation": "A list of information about each model in the inference profile.
", + "smithy.api#required": {} + } + }, + "inferenceProfileId": { + "target": "com.amazonaws.bedrock#InferenceProfileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the inference profile.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#InferenceProfileStatus", + "traits": { + "smithy.api#documentation": "The status of the inference profile. ACTIVE means that the inference profile is ready to be used.
The type of the inference profile. The following types are possible:
SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.
APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.
Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/marketplace-model/endpoints/{endpointArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetMarketplaceModelEndpointRequest": { + "type": "structure", + "members": { + "endpointArn": { + "target": "com.amazonaws.bedrock#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint you want to get information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetMarketplaceModelEndpointResponse": { + "type": "structure", + "members": { + "marketplaceModelEndpoint": { + "target": "com.amazonaws.bedrock#MarketplaceModelEndpoint", + "traits": { + "smithy.api#documentation": "Details about the requested endpoint.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelCopyJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelCopyJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelCopyJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-copy-jobs/{jobArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelCopyJobRequest": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model copy job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelCopyJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model copy job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCopyJobStatus", + "traits": { + "smithy.api#documentation": "The status of the model copy job.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the model copy job was created.
", + "smithy.api#required": {} + } + }, + "targetModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the copied model.
", + "smithy.api#required": {} + } + }, + "targetModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "The name of the copied model.
" + } + }, + "sourceAccountId": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "The unique identifier of the account that the model being copied originated from.
", + "smithy.api#required": {} + } + }, + "sourceModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the original model being copied.
", + "smithy.api#required": {} + } + }, + "targetModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key encrypting the copied model.
" + } + }, + "targetModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "The tags associated with the copied model.
" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "An error message for why the model copy job failed.
" + } + }, + "sourceModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "The name of the original model being copied.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelCustomizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelCustomizationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelCustomizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-customization-jobs/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelCustomizationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", + "traits": { + "smithy.api#documentation": "Identifier for the customization job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelCustomizationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customization job.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "The name of the customization job.
", + "smithy.api#required": {} + } + }, + "outputModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "The name of the output model.
", + "smithy.api#required": {} + } + }, + "outputModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the output model.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "The token that you specified in the CreateCustomizationJob request.
The Amazon Resource Name (ARN) of the IAM role.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", + "traits": { + "smithy.api#documentation": "The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.
" + } + }, + "statusDetails": { + "target": "com.amazonaws.bedrock#StatusDetails", + "traits": { + "smithy.api#documentation": "For a Distillation job, the details about the statuses of the sub-tasks of the customization job.
" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "Information about why the job failed.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Time that the resource was created.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Time that the resource was last modified.
" + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Time that the resource transitioned to terminal state.
" + } + }, + "baseModelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the base model.
", + "smithy.api#required": {} + } + }, + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "traits": { + "smithy.api#documentation": "The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.
" + } + }, + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", + "traits": { + "smithy.api#documentation": "Contains information about the training dataset.
", + "smithy.api#required": {} + } + }, + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", + "traits": { + "smithy.api#documentation": "Contains information about the validation dataset.
", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", + "traits": { + "smithy.api#documentation": "Output data configuration
", + "smithy.api#required": {} + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "The type of model customization.
" + } + }, + "outputModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The custom model is encrypted at rest using this key.
" + } + }, + "trainingMetrics": { + "target": "com.amazonaws.bedrock#TrainingMetrics", + "traits": { + "smithy.api#documentation": "Contains training metrics from the job creation.
" + } + }, + "validationMetrics": { + "target": "com.amazonaws.bedrock#ValidationMetrics", + "traits": { + "smithy.api#documentation": "The loss metric for each validator that you provided in the createjob request.
" + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "VPC configuration for the custom model job.
" + } + }, + "customizationConfig": { + "target": "com.amazonaws.bedrock#CustomizationConfig", + "traits": { + "smithy.api#documentation": "The customization configuration for the model customization job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelImportJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the properties associated with import model job, including the status of the job. For more information, see Import a customized model in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-import-jobs/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelImportJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelImportJobIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the import job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelImportJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelImportJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the import job.
" + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "The name of the import job.
" + } + }, + "importedModelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "The name of the imported model.
" + } + }, + "importedModelArn": { + "target": "com.amazonaws.bedrock#ImportedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the imported model.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with this job.
" + } + }, + "modelDataSource": { + "target": "com.amazonaws.bedrock#ModelDataSource", + "traits": { + "smithy.api#documentation": "The data source for the imported model.
" + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelImportJobStatus", + "traits": { + "smithy.api#documentation": "The status of the job. A successful job transitions from in-progress to completed when the imported model is ready to use. If the job failed, the failure message contains information about why the job failed.
" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "Information about why the import job failed.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time the resource was created.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Time the resource was last modified.
" + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Time that the resource transitioned to terminal state.
" + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "The Virtual Private Cloud (VPC) configuration of the import model job.
" + } + }, + "importedModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The imported model is encrypted at rest using this key.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelInvocationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelInvocationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets details about a batch inference job. For more information, see Monitor batch inference jobs
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-invocation-job/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelInvocationJobIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the batch inference job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelInvocationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the batch inference job.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#ModelInvocationJobName", + "traits": { + "smithy.api#documentation": "The name of the batch inference job.
" + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#ModelId", + "traits": { + "smithy.api#documentation": "The unique identifier of the foundation model used for model inference.
", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", + "traits": { + "smithy.api#documentation": "The status of the batch inference job.
The following statuses are possible:
Submitted – This job has been submitted to a queue for validation.
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
Your IAM service role has access to the Amazon S3 buckets containing your files.
Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the modelInput value matches the request body for the model.
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
InProgress – This job has begun. You can start viewing the results in the output S3 location.
Completed – This job has successfully completed. View the output files in the output S3 location.
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web Services Support Center.
Stopped – This job was stopped by a user.
Stopping – This job is being stopped by a user.
If the batch inference job failed, this field contains a message describing why the job failed.
" + } + }, + "submitTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the batch inference job was submitted.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the batch inference job was last modified.
" + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the batch inference job ended.
" + } + }, + "inputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", + "traits": { + "smithy.api#documentation": "Details about the location of the input to the batch inference job.
", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", + "traits": { + "smithy.api#documentation": "Details about the location of the output of the batch inference job.
", + "smithy.api#required": {} + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.
" + } + }, + "timeoutDurationInHours": { + "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", + "traits": { + "smithy.api#documentation": "The number of hours after which batch inference job was set to time out.
" + } + }, + "jobExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the batch inference job times or timed out.
" + } + }, + "modelInvocationType": { + "target": "com.amazonaws.bedrock#ModelInvocationType", + "traits": { + "smithy.api#documentation": "The invocation endpoint for ModelInvocationJob
" + } + }, + "totalRecordCount": { + "target": "com.amazonaws.bedrock#NonNegativeLong", + "traits": { + "smithy.api#documentation": "The total number of records in the batch inference job.
" + } + }, + "processedRecordCount": { + "target": "com.amazonaws.bedrock#NonNegativeLong", + "traits": { + "smithy.api#documentation": "The number of records that have been processed in the batch inference job.
" + } + }, + "successRecordCount": { + "target": "com.amazonaws.bedrock#NonNegativeLong", + "traits": { + "smithy.api#documentation": "The number of records that were successfully processed in the batch inference job.
" + } + }, + "errorRecordCount": { + "target": "com.amazonaws.bedrock#NonNegativeLong", + "traits": { + "smithy.api#documentation": "The number of records that failed to process in the batch inference job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Get the current configuration values for model invocation logging.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/logging/modelinvocations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse": { + "type": "structure", + "members": { + "loggingConfig": { + "target": "com.amazonaws.bedrock#LoggingConfig", + "traits": { + "smithy.api#documentation": "The current configuration values.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetPromptRouter": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetPromptRouterRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetPromptRouterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves details about a prompt router.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/prompt-routers/{promptRouterArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetPromptRouterRequest": { + "type": "structure", + "members": { + "promptRouterArn": { + "target": "com.amazonaws.bedrock#PromptRouterArn", + "traits": { + "smithy.api#documentation": "The prompt router's ARN
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetPromptRouterResponse": { + "type": "structure", + "members": { + "promptRouterName": { + "target": "com.amazonaws.bedrock#PromptRouterName", + "traits": { + "smithy.api#documentation": "The router's name.
", + "smithy.api#required": {} + } + }, + "routingCriteria": { + "target": "com.amazonaws.bedrock#RoutingCriteria", + "traits": { + "smithy.api#documentation": "The router's routing criteria.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#PromptRouterDescription", + "traits": { + "smithy.api#documentation": "The router's description.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "When the router was created.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "When the router was updated.
" + } + }, + "promptRouterArn": { + "target": "com.amazonaws.bedrock#PromptRouterArn", + "traits": { + "smithy.api#documentation": "The prompt router's ARN
", + "smithy.api#required": {} + } + }, + "models": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModels", + "traits": { + "smithy.api#documentation": "The router's models.
", + "smithy.api#required": {} + } + }, + "fallbackModel": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModel", + "traits": { + "smithy.api#documentation": "The router's fallback model.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#PromptRouterStatus", + "traits": { + "smithy.api#documentation": "The router's status.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrock#PromptRouterType", + "traits": { + "smithy.api#documentation": "The router's type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/provisioned-model-throughput/{provisionedModelId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) or name of the Provisioned Throughput.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse": { + "type": "structure", + "members": { + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "The number of model units allocated to this Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "desiredModelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "The number of model units that was requested for this Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "The name of the Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model associated with this Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "desiredModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.
The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "The status of the Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the creation time for this Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the last time that this Provisioned Throughput was modified.
", + "smithy.api#required": {} + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "A failure message for any issues that occurred during creation, updating, or deletion of the Provisioned Throughput.
" + } + }, + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", + "traits": { + "smithy.api#documentation": "Commitment duration of the Provisioned Throughput.
" + } + }, + "commitmentExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the commitment term for the Provisioned Throughput expires.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the resource policy document for a Bedrock resource
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/resource-policy/{resourceArn}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "resource-policy" + ] + } + }, + "com.amazonaws.bedrock#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrock#ResourcePolicyResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the Bedrock resource to which this resource policy applies.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "resourcePolicy": { + "target": "com.amazonaws.bedrock#ResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "The JSON string representing the Bedrock resource policy.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetUseCaseForModelAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetUseCaseForModelAccessRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetUseCaseForModelAccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get usecase for model access.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/use-case-for-model-access" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetUseCaseForModelAccessRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetUseCaseForModelAccessResponse": { + "type": "structure", + "members": { + "formData": { + "target": "com.amazonaws.bedrock#AcknowledgementFormDataBody", + "traits": { + "smithy.api#documentation": "Get customer profile Response.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GraderConfig": { + "type": "union", + "members": { + "lambdaGrader": { + "target": "com.amazonaws.bedrock#LambdaGraderConfig", + "traits": { + "smithy.api#documentation": "Configuration for using an AWS Lambda function as the grader for evaluating model responses and provide reward signals in reinforcement fine-tuning.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for the grader used in reinforcement fine-tuning to evaluate model responses and provide reward signals.
" + } + }, + "com.amazonaws.bedrock#GuardrailArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$" + } + }, + "com.amazonaws.bedrock#GuardrailAutomatedReasoningPolicy": { + "type": "structure", + "members": { + "policies": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArnList", + "traits": { + "smithy.api#documentation": "The list of Automated Reasoning policy ARNs that should be applied as part of this guardrail configuration.
", + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#required": {} + } + }, + "confidenceThreshold": { + "target": "com.amazonaws.bedrock#AutomatedReasoningConfidenceFilterThreshold", + "traits": { + "smithy.api#documentation": "The minimum confidence level required for Automated Reasoning policy violations to trigger guardrail actions. Values range from 0.0 to 1.0.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the configuration of Automated Reasoning policies within a Amazon Bedrock Guardrail, including the policies to apply and confidence thresholds.
" + } + }, + "com.amazonaws.bedrock#GuardrailAutomatedReasoningPolicyConfig": { + "type": "structure", + "members": { + "policies": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArnList", + "traits": { + "smithy.api#documentation": "The list of Automated Reasoning policy ARNs to include in the guardrail configuration.
", + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#required": {} + } + }, + "confidenceThreshold": { + "target": "com.amazonaws.bedrock#AutomatedReasoningConfidenceFilterThreshold", + "traits": { + "smithy.api#documentation": "The confidence threshold for triggering guardrail actions based on Automated Reasoning policy violations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.
" + } + }, + "com.amazonaws.bedrock#GuardrailBlockedMessaging": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailConfiguration": { + "type": "structure", + "members": { + "guardrailId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the guardrail.
", + "smithy.api#length": { + "max": 64 + }, + "smithy.api#pattern": "^[a-z0-9]+$", + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailContentFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterType", + "traits": { + "smithy.api#documentation": "The harmful category that the content filter is applied to.
", + "smithy.api#required": {} + } + }, + "inputStrength": { + "target": "com.amazonaws.bedrock#GuardrailFilterStrength", + "traits": { + "smithy.api#documentation": "The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
", + "smithy.api#required": {} + } + }, + "outputStrength": { + "target": "com.amazonaws.bedrock#GuardrailFilterStrength", + "traits": { + "smithy.api#documentation": "The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
", + "smithy.api#required": {} + } + }, + "inputModalities": { + "target": "com.amazonaws.bedrock#GuardrailModalities", + "traits": { + "smithy.api#documentation": "The input modalities selected for the guardrail content filter.
" + } + }, + "outputModalities": { + "target": "com.amazonaws.bedrock#GuardrailModalities", + "traits": { + "smithy.api#documentation": "The output modalities selected for the guardrail content filter.
" + } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterAction", + "traits": { + "smithy.api#documentation": "The action to take when harmful content is detected in the input. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
The action to take when harmful content is detected in the output. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + }, + "outputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
Hate – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
Insults – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
Sexual – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
Violence – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.
Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as Hate with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.
For more information, see Guardrails content filters.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrock#GuardrailContentFilterAction": { + "type": "enum", + "members": { + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailContentFilterConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterType", + "traits": { + "smithy.api#documentation": "The harmful category that the content filter is applied to.
", + "smithy.api#required": {} + } + }, + "inputStrength": { + "target": "com.amazonaws.bedrock#GuardrailFilterStrength", + "traits": { + "smithy.api#documentation": "The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
", + "smithy.api#required": {} + } + }, + "outputStrength": { + "target": "com.amazonaws.bedrock#GuardrailFilterStrength", + "traits": { + "smithy.api#documentation": "The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
", + "smithy.api#required": {} + } + }, + "inputModalities": { + "target": "com.amazonaws.bedrock#GuardrailModalities", + "traits": { + "smithy.api#documentation": "The input modalities selected for the guardrail content filter configuration.
" + } + }, + "outputModalities": { + "target": "com.amazonaws.bedrock#GuardrailModalities", + "traits": { + "smithy.api#documentation": "The output modalities selected for the guardrail content filter configuration.
" + } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterAction", + "traits": { + "smithy.api#documentation": "Specifies the action to take when harmful content is detected. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Specifies the action to take when harmful content is detected in the output. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + }, + "outputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
Hate – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
Insults – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
Sexual – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
Violence – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.
Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as Hate with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.
For more information, see Guardrails content filters.
" + } + }, + "com.amazonaws.bedrock#GuardrailContentFilterType": { + "type": "enum", + "members": { + "SEXUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEXUAL" + } + }, + "VIOLENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIOLENCE" + } + }, + "HATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HATE" + } + }, + "INSULTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSULTS" + } + }, + "MISCONDUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISCONDUCT" + } + }, + "PROMPT_ATTACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROMPT_ATTACK" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailContentFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailContentFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.bedrock#GuardrailContentFiltersConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.bedrock#GuardrailContentFiltersTier": { + "type": "structure", + "members": { + "tierName": { + "target": "com.amazonaws.bedrock#GuardrailContentFiltersTierName", + "traits": { + "smithy.api#documentation": "The tier that your guardrail uses for content filters. Valid values include:
CLASSIC tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
STANDARD tier – Provides a more robust solution than the CLASSIC tier and has more comprehensive language support. This tier requires that your guardrail use cross-Region inference.
The tier that your guardrail uses for content filters.
" + } + }, + "com.amazonaws.bedrock#GuardrailContentFiltersTierConfig": { + "type": "structure", + "members": { + "tierName": { + "target": "com.amazonaws.bedrock#GuardrailContentFiltersTierName", + "traits": { + "smithy.api#documentation": "The tier that your guardrail uses for content filters. Valid values include:
CLASSIC tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
STANDARD tier – Provides a more robust solution than the CLASSIC tier and has more comprehensive language support. This tier requires that your guardrail use cross-Region inference.
The tier that your guardrail uses for content filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.
" + } + }, + "com.amazonaws.bedrock#GuardrailContentFiltersTierName": { + "type": "enum", + "members": { + "CLASSIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLASSIC" + } + }, + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailContentPolicy": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrock#GuardrailContentFilters", + "traits": { + "smithy.api#documentation": "Contains the type of the content filter and how strongly it should apply to prompts and model responses.
" + } + }, + "tier": { + "target": "com.amazonaws.bedrock#GuardrailContentFiltersTier", + "traits": { + "smithy.api#documentation": "The tier that your guardrail uses for content filters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about how to handle harmful content.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrock#GuardrailContentPolicyConfig": { + "type": "structure", + "members": { + "filtersConfig": { + "target": "com.amazonaws.bedrock#GuardrailContentFiltersConfig", + "traits": { + "smithy.api#documentation": "Contains the type of the content filter and how strongly it should apply to prompts and model responses.
", + "smithy.api#required": {} + } + }, + "tierConfig": { + "target": "com.amazonaws.bedrock#GuardrailContentFiltersTierConfig", + "traits": { + "smithy.api#documentation": "The tier that your guardrail uses for content filters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about how to handle harmful content.
" + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingAction": { + "type": "enum", + "members": { + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilterType", + "traits": { + "smithy.api#documentation": "The filter type details for the guardrails contextual grounding filter.
", + "smithy.api#required": {} + } + }, + "threshold": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The threshold details for the guardrails contextual grounding filter.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingAction", + "traits": { + "smithy.api#documentation": "The action to take when content fails the contextual grounding evaluation. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Indicates whether contextual grounding is enabled for evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details for the guardrails contextual grounding filter.
" + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFilterConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilterType", + "traits": { + "smithy.api#documentation": "The filter details for the guardrails contextual grounding filter.
", + "smithy.api#required": {} + } + }, + "threshold": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The threshold details for the guardrails contextual grounding filter.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingAction", + "traits": { + "smithy.api#documentation": "Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Specifies whether to enable contextual grounding evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The filter configuration details for the guardrails contextual grounding filter.
" + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFilterType": { + "type": "enum", + "members": { + "GROUNDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUNDING" + } + }, + "RELEVANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELEVANCE" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFiltersConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilterConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingPolicy": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilters", + "traits": { + "smithy.api#documentation": "The filter details for the guardrails contextual grounding policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details for the guardrails contextual grounding policy.
" + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig": { + "type": "structure", + "members": { + "filtersConfig": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFiltersConfig", + "traits": { + "smithy.api#documentation": "The filter configuration details for the guardrails contextual grounding policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The policy configuration details for the guardrails contextual grounding policy.
" + } + }, + "com.amazonaws.bedrock#GuardrailCrossRegionConfig": { + "type": "structure", + "members": { + "guardrailProfileIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionGuardrailProfileIdentifier", + "traits": { + "smithy.api#documentation": "The ID or Amazon Resource Name (ARN) of the guardrail profile that your guardrail is using. Guardrail profile availability depends on your current Amazon Web Services Region. For more information, see the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.
For more information, see the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrock#GuardrailCrossRegionDetails": { + "type": "structure", + "members": { + "guardrailProfileId": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionGuardrailProfileId", + "traits": { + "smithy.api#documentation": "The ID of the guardrail profile that your guardrail is using. Profile availability depends on your current Amazon Web Services Region. For more information, see the Amazon Bedrock User Guide.
" + } + }, + "guardrailProfileArn": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionGuardrailProfileArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the guardrail profile that you're using with your guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the system-defined guardrail profile that you're using with your guardrail for cross-Region inference.
For more information, see the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrock#GuardrailCrossRegionGuardrailProfileArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+$" + } + }, + "com.amazonaws.bedrock#GuardrailCrossRegionGuardrailProfileId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 30 + }, + "smithy.api#pattern": "^[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+$" + } + }, + "com.amazonaws.bedrock#GuardrailCrossRegionGuardrailProfileIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 2048 + }, + "smithy.api#pattern": "^[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+|arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+$" + } + }, + "com.amazonaws.bedrock#GuardrailDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailDraftVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 5 + }, + "smithy.api#pattern": "^DRAFT$" + } + }, + "com.amazonaws.bedrock#GuardrailFailureRecommendation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailFailureRecommendations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailFailureRecommendation" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrock#GuardrailFilterStrength": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 64 + }, + "smithy.api#pattern": "^[a-z0-9]+$" + } + }, + "com.amazonaws.bedrock#GuardrailIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" + } + }, + "com.amazonaws.bedrock#GuardrailManagedWordLists": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailManagedWords" + } + }, + "com.amazonaws.bedrock#GuardrailManagedWordListsConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordsConfig" + } + }, + "com.amazonaws.bedrock#GuardrailManagedWords": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordsType", + "traits": { + "smithy.api#documentation": "ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)
", + "smithy.api#required": {} + } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailWordAction", + "traits": { + "smithy.api#documentation": "The action to take when harmful content is detected in the input. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
The action to take when harmful content is detected in the output. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + }, + "outputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The managed word list that was configured for the guardrail. (This is a list of words that are pre-defined and managed by guardrails only.)
" + } + }, + "com.amazonaws.bedrock#GuardrailManagedWordsConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordsType", + "traits": { + "smithy.api#documentation": "The managed word type to configure for the guardrail.
", + "smithy.api#required": {} + } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailWordAction", + "traits": { + "smithy.api#documentation": "Specifies the action to take when harmful content is detected in the input. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Specifies the action to take when harmful content is detected in the output. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + }, + "outputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The managed word list to configure for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailManagedWordsType": { + "type": "enum", + "members": { + "PROFANITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFANITY" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailModalities": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailModality" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrock#GuardrailModality": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailNumericalVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[1-9][0-9]{0,7}$" + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntity" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntitiesConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntityConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntity": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntityType", + "traits": { + "smithy.api#documentation": "The type of PII entity. For example, Social Security Number.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "The configured guardrail action when PII entity is detected.
", + "smithy.api#required": {} + } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "The action to take when harmful content is detected in the input. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
ANONYMIZE – Mask the content and replace it with identifier tags.
NONE – Take no action but return detection information in the trace response.
The action to take when harmful content is detected in the output. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
ANONYMIZE – Mask the content and replace it with identifier tags.
NONE – Take no action but return detection information in the trace response.
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + }, + "outputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The PII entity configured for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntityConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntityType", + "traits": { + "smithy.api#documentation": "Configure guardrail type when the PII entity is detected.
The following PIIs are used to block or mask sensitive information:
General
ADDRESS
A physical address, such as \"100 Main Street, Anytown, USA\" or \"Suite #12, Building 123\". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.
AGE
An individual's age, including the quantity and unit of time. For example, in the phrase \"I am 40 years old,\" Guardrails recognizes \"40 years\" as an age.
NAME
An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the \"John Doe Organization\" as an organization, and it recognizes \"Jane Doe Street\" as an address.
An email address, such as marymajor@email.com.
PHONE
A phone number. This entity type also includes fax and pager numbers.
USERNAME
A user name that identifies an account, such as a login name, screen name, nick name, or handle.
PASSWORD
An alphanumeric string that is used as a password, such as \"*very20special#pass*\".
DRIVER_ID
The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.
LICENSE_PLATE
A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.
VEHICLE_IDENTIFICATION_NUMBER
A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.
Finance
CREDIT_DEBIT_CARD_CVV
A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.
CREDIT_DEBIT_CARD_EXPIRY
The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY. Guardrails recognizes expiration dates such as 01/21, 01/2021, and Jan 2021.
CREDIT_DEBIT_CARD_NUMBER
The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.
PIN
A four-digit personal identification number (PIN) with which you can access your bank account.
INTERNATIONAL_BANK_ACCOUNT_NUMBER
An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure.
SWIFT_CODE
A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.
SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.
IT
IP_ADDRESS
An IPv4 address, such as 198.51.100.0.
MAC_ADDRESS
A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).
URL
A web address, such as www.example.com.
AWS_ACCESS_KEY
A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.
AWS_SECRET_KEY
A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.
USA specific
US_BANK_ACCOUNT_NUMBER
A US bank account number, which is typically 10 to 12 digits long.
US_BANK_ROUTING_NUMBER
A US bank account routing number. These are typically nine digits long,
US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a \"9\" and contain a \"7\" or \"8\" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.
US_PASSPORT_NUMBER
A US passport number. Passport numbers range from six to nine alphanumeric characters.
US_SOCIAL_SECURITY_NUMBER
A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.
Canada specific
CA_HEALTH_NUMBER
A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.
CA_SOCIAL_INSURANCE_NUMBER
A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.
The SIN is formatted as three groups of three digits, such as 123-456-789. A SIN can be validated through a simple check-digit process called the Luhn algorithm.
UK Specific
UK_NATIONAL_HEALTH_SERVICE_NUMBER
A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.
UK_NATIONAL_INSURANCE_NUMBER
A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.
The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.
UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.
Custom
Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..
Configure guardrail action when the PII entity is detected.
", + "smithy.api#required": {} + } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "Specifies the action to take when harmful content is detected in the input. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
ANONYMIZE – Mask the content and replace it with identifier tags.
NONE – Take no action but return detection information in the trace response.
Specifies the action to take when harmful content is detected in the output. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
ANONYMIZE – Mask the content and replace it with identifier tags.
NONE – Take no action but return detection information in the trace response.
Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + }, + "outputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The PII entity to configure for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntityType": { + "type": "enum", + "members": { + "ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDRESS" + } + }, + "AGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGE" + } + }, + "AWS_ACCESS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_ACCESS_KEY" + } + }, + "AWS_SECRET_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SECRET_KEY" + } + }, + "CA_HEALTH_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_HEALTH_NUMBER" + } + }, + "CA_SOCIAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_SOCIAL_INSURANCE_NUMBER" + } + }, + "CREDIT_DEBIT_CARD_CVV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_CVV" + } + }, + "CREDIT_DEBIT_CARD_EXPIRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_EXPIRY" + } + }, + "CREDIT_DEBIT_CARD_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_NUMBER" + } + }, + "DRIVER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRIVER_ID" + } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + }, + "INTERNATIONAL_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNATIONAL_BANK_ACCOUNT_NUMBER" + } + }, + "IP_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_ADDRESS" + } + }, + "LICENSE_PLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LICENSE_PLATE" + } + }, + "MAC_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAC_ADDRESS" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD" + } + }, + "PHONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE" + } + }, + "PIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PIN" + } + }, + "SWIFT_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SWIFT_CODE" + } + }, + "UK_NATIONAL_HEALTH_SERVICE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_HEALTH_SERVICE_NUMBER" + } + }, + "UK_NATIONAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_INSURANCE_NUMBER" + } + }, + "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" + } + }, + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USERNAME" + } + }, + "US_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_BANK_ACCOUNT_NUMBER" + } + }, + "US_BANK_ROUTING_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_BANK_ROUTING_NUMBER" + } + }, + "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" + } + }, + "US_PASSPORT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_PASSPORT_NUMBER" + } + }, + "US_SOCIAL_SECURITY_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_SOCIAL_SECURITY_NUMBER" + } + }, + "VEHICLE_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VEHICLE_IDENTIFICATION_NUMBER" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailRegex": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the regular expression for the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the regular expression for the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "pattern": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pattern of the regular expression configured for the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "The action taken when a match to the regular expression is detected.
", + "smithy.api#required": {} + } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "The action to take when harmful content is detected in the input. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
The action to take when harmful content is detected in the output. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + }, + "outputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The regular expression configured for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailRegexConfig": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the regular expression to configure for the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the regular expression to configure for the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "pattern": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The regular expression pattern to configure for the guardrail.
", + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "The guardrail action to configure when matching regular expression is detected.
", + "smithy.api#required": {} + } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "Specifies the action to take when harmful content is detected in the input. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Specifies the action to take when harmful content is detected in the output. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + }, + "outputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The regular expression to configure for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailRegexes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailRegex" + } + }, + "com.amazonaws.bedrock#GuardrailRegexesConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailRegexConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrock#GuardrailSensitiveInformationAction": { + "type": "enum", + "members": { + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "ANONYMIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANONYMIZE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicy": { + "type": "structure", + "members": { + "piiEntities": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntities", + "traits": { + "smithy.api#documentation": "The list of PII entities configured for the guardrail.
" + } + }, + "regexes": { + "target": "com.amazonaws.bedrock#GuardrailRegexes", + "traits": { + "smithy.api#documentation": "The list of regular expressions configured for the guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about PII entities and regular expressions configured for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig": { + "type": "structure", + "members": { + "piiEntitiesConfig": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntitiesConfig", + "traits": { + "smithy.api#documentation": "A list of PII entities to configure to the guardrail.
" + } + }, + "regexesConfig": { + "target": "com.amazonaws.bedrock#GuardrailRegexesConfig", + "traits": { + "smithy.api#documentation": "A list of regular expressions to configure to the guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about PII entities and regular expressions to configure for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "VERSIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSIONING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailStatusReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailStatusReason" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrock#GuardrailSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailSummary" + }, + "traits": { + "smithy.api#length": { + "max": 1000 + } + } + }, + "com.amazonaws.bedrock#GuardrailSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrock#GuardrailArn", + "traits": { + "smithy.api#documentation": "The ARN of the guardrail.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#GuardrailStatus", + "traits": { + "smithy.api#documentation": "The status of the guardrail.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", + "traits": { + "smithy.api#documentation": "The name of the guardrail.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "A description of the guardrail.
" + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the guardrail was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the guardrail was last updated.
", + "smithy.api#required": {} + } + }, + "crossRegionDetails": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionDetails", + "traits": { + "smithy.api#documentation": "Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a guardrail.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrock#GuardrailTopic": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#GuardrailTopicName", + "traits": { + "smithy.api#documentation": "The name of the topic to deny.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrock#GuardrailTopicDefinition", + "traits": { + "smithy.api#documentation": "A definition of the topic to deny.
", + "smithy.api#required": {} + } + }, + "examples": { + "target": "com.amazonaws.bedrock#GuardrailTopicExamples", + "traits": { + "smithy.api#documentation": "A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
" + } + }, + "type": { + "target": "com.amazonaws.bedrock#GuardrailTopicType", + "traits": { + "smithy.api#documentation": "Specifies to deny the topic.
" + } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailTopicAction", + "traits": { + "smithy.api#documentation": "The action to take when harmful content is detected in the input. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
The action to take when harmful content is detected in the output. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + }, + "outputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about topics for the guardrail to identify and deny.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrock#GuardrailTopicAction": { + "type": "enum", + "members": { + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailTopicConfig": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#GuardrailTopicName", + "traits": { + "smithy.api#documentation": "The name of the topic to deny.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrock#GuardrailTopicDefinition", + "traits": { + "smithy.api#documentation": "A definition of the topic to deny.
", + "smithy.api#required": {} + } + }, + "examples": { + "target": "com.amazonaws.bedrock#GuardrailTopicExamples", + "traits": { + "smithy.api#documentation": "A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
" + } + }, + "type": { + "target": "com.amazonaws.bedrock#GuardrailTopicType", + "traits": { + "smithy.api#documentation": "Specifies to deny the topic.
", + "smithy.api#required": {} + } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailTopicAction", + "traits": { + "smithy.api#documentation": "Specifies the action to take when harmful content is detected in the input. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Specifies the action to take when harmful content is detected in the output. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + }, + "outputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about topics for the guardrail to identify and deny.
" + } + }, + "com.amazonaws.bedrock#GuardrailTopicDefinition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailTopicExample": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailTopicExamples": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailTopicExample" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#GuardrailTopicName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_ !?.]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailTopicPolicy": { + "type": "structure", + "members": { + "topics": { + "target": "com.amazonaws.bedrock#GuardrailTopics", + "traits": { + "smithy.api#documentation": "A list of policies related to topics that the guardrail should deny.
", + "smithy.api#required": {} + } + }, + "tier": { + "target": "com.amazonaws.bedrock#GuardrailTopicsTier", + "traits": { + "smithy.api#documentation": "The tier that your guardrail uses for denied topic filters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about topics that the guardrail should identify and deny.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrock#GuardrailTopicPolicyConfig": { + "type": "structure", + "members": { + "topicsConfig": { + "target": "com.amazonaws.bedrock#GuardrailTopicsConfig", + "traits": { + "smithy.api#documentation": "A list of policies related to topics that the guardrail should deny.
", + "smithy.api#required": {} + } + }, + "tierConfig": { + "target": "com.amazonaws.bedrock#GuardrailTopicsTierConfig", + "traits": { + "smithy.api#documentation": "The tier that your guardrail uses for denied topic filters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about topics that the guardrail should identify and deny.
" + } + }, + "com.amazonaws.bedrock#GuardrailTopicType": { + "type": "enum", + "members": { + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailTopics": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailTopic" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.bedrock#GuardrailTopicsConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailTopicConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.bedrock#GuardrailTopicsTier": { + "type": "structure", + "members": { + "tierName": { + "target": "com.amazonaws.bedrock#GuardrailTopicsTierName", + "traits": { + "smithy.api#documentation": "The tier that your guardrail uses for denied topic filters. Valid values include:
CLASSIC tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
STANDARD tier – Provides a more robust solution than the CLASSIC tier and has more comprehensive language support. This tier requires that your guardrail use cross-Region inference.
The tier that your guardrail uses for denied topic filters.
" + } + }, + "com.amazonaws.bedrock#GuardrailTopicsTierConfig": { + "type": "structure", + "members": { + "tierName": { + "target": "com.amazonaws.bedrock#GuardrailTopicsTierName", + "traits": { + "smithy.api#documentation": "The tier that your guardrail uses for denied topic filters. Valid values include:
CLASSIC tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
STANDARD tier – Provides a more robust solution than the CLASSIC tier and has more comprehensive language support. This tier requires that your guardrail use cross-Region inference.
The tier that your guardrail uses for denied topic filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.
" + } + }, + "com.amazonaws.bedrock#GuardrailTopicsTierName": { + "type": "enum", + "members": { + "CLASSIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLASSIC" + } + }, + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" + } + }, + "com.amazonaws.bedrock#GuardrailWord": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Text of the word configured for the guardrail to block.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailWordAction", + "traits": { + "smithy.api#documentation": "The action to take when harmful content is detected in the input. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
The action to take when harmful content is detected in the output. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + }, + "outputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A word configured for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailWordAction": { + "type": "enum", + "members": { + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailWordConfig": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Text of the word configured for the guardrail to block.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailWordAction", + "traits": { + "smithy.api#documentation": "Specifies the action to take when harmful content is detected in the input. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Specifies the action to take when harmful content is detected in the output. Supported values include:
BLOCK – Block the content and replace it with blocked messaging.
NONE – Take no action but return detection information in the trace response.
Specifies whether to enable guardrail evaluation on the intput. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + }, + "outputEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A word to configure for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailWordPolicy": { + "type": "structure", + "members": { + "words": { + "target": "com.amazonaws.bedrock#GuardrailWords", + "traits": { + "smithy.api#documentation": "A list of words configured for the guardrail.
" + } + }, + "managedWordLists": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordLists", + "traits": { + "smithy.api#documentation": "A list of managed words configured for the guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the word policy configured for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailWordPolicyConfig": { + "type": "structure", + "members": { + "wordsConfig": { + "target": "com.amazonaws.bedrock#GuardrailWordsConfig", + "traits": { + "smithy.api#documentation": "A list of words to configure for the guardrail.
" + } + }, + "managedWordListsConfig": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordListsConfig", + "traits": { + "smithy.api#documentation": "A list of managed words to configure for the guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the word policy to configured for the guardrail.
" + } + }, + "com.amazonaws.bedrock#GuardrailWords": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailWord" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.bedrock#GuardrailWordsConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailWordConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.bedrock#GuardrailsResource": { + "type": "resource", + "identifiers": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrock#CreateGuardrail" + }, + "read": { + "target": "com.amazonaws.bedrock#GetGuardrail" + }, + "update": { + "target": "com.amazonaws.bedrock#UpdateGuardrail" + }, + "delete": { + "target": "com.amazonaws.bedrock#DeleteGuardrail" + }, + "list": { + "target": "com.amazonaws.bedrock#ListGuardrails" + }, + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateGuardrailVersion" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Guardrail" + } + } + }, + "com.amazonaws.bedrock#HumanEvaluationConfig": { + "type": "structure", + "members": { + "humanWorkflowConfig": { + "target": "com.amazonaws.bedrock#HumanWorkflowConfig", + "traits": { + "smithy.api#documentation": "The parameters of the human workflow.
" + } + }, + "customMetrics": { + "target": "com.amazonaws.bedrock#HumanEvaluationCustomMetrics", + "traits": { + "smithy.api#documentation": "A HumanEvaluationCustomMetric object. It contains the names the metrics, how the metrics are to be evaluated, an optional description.
Use to specify the metrics, task, and prompt dataset to be used in your model evaluation job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the custom metrics, how tasks will be rated, the flow definition ARN, and your custom prompt datasets. Model evaluation jobs use human workers only support the use of custom prompt datasets. To learn more about custom prompt datasets and the required format, see Custom prompt datasets.
When you create custom metrics in HumanEvaluationCustomMetric you must specify the metric's name. The list of names specified in the HumanEvaluationCustomMetric array, must match the metricNames array of strings specified in EvaluationDatasetMetricConfig. For example, if in the HumanEvaluationCustomMetric array your specified the names \"accuracy\", \"toxicity\", \"readability\" as custom metrics then the metricNames array would need to look like the following [\"accuracy\", \"toxicity\", \"readability\"] in EvaluationDatasetMetricConfig.
The name of the metric. Your human evaluators will see this name in the evaluation UI.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#EvaluationMetricDescription", + "traits": { + "smithy.api#documentation": "An optional description of the metric. Use this parameter to provide more details about the metric.
" + } + }, + "ratingMethod": { + "target": "com.amazonaws.bedrock#EvaluationRatingMethod", + "traits": { + "smithy.api#documentation": "Choose how you want your human workers to evaluation your model. Valid values for rating methods are ThumbsUpDown, IndividualLikertScale,ComparisonLikertScale, ComparisonChoice, and ComparisonRank
In a model evaluation job that uses human workers you must define the name of the metric, and how you want that metric rated ratingMethod, and an optional description of the metric.
The Amazon Resource Number (ARN) for the flow definition
", + "smithy.api#required": {} + } + }, + "instructions": { + "target": "com.amazonaws.bedrock#HumanTaskInstructions", + "traits": { + "smithy.api#documentation": "Instructions for the flow definition
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains SageMakerFlowDefinition object. The object is used to specify the prompt dataset, task type, rating method and metric names.
A list of metadata attribute schemas that define the structure and properties of metadata fields used for implicit filtering. Each attribute defines a key, type, and optional description.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the foundation model used for implicit filtering. This model processes the query to extract relevant filtering criteria.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for implicit filtering in Knowledge Base vector searches. Implicit filtering allows you to automatically filter search results based on metadata attributes without requiring explicit filter expressions in each query.
" + } + }, + "com.amazonaws.bedrock#ImportedModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ImportedModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12})|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrock#ImportedModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + } + }, + "com.amazonaws.bedrock#ImportedModelSummary": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#ImportedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the imported model.
", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "Name of the imported model.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Creation time of the imported model.
", + "smithy.api#required": {} + } + }, + "instructSupported": { + "target": "com.amazonaws.bedrock#InstructSupported", + "traits": { + "smithy.api#documentation": "Specifies if the imported model supports converse.
" + } + }, + "modelArchitecture": { + "target": "com.amazonaws.bedrock#ModelArchitecture", + "traits": { + "smithy.api#documentation": "The architecture of the imported model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the imported model.
" + } + }, + "com.amazonaws.bedrock#ImportedModelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ImportedModelSummary" + } + }, + "com.amazonaws.bedrock#IncludedModelId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(ALL|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}){0,1})$" + } + }, + "com.amazonaws.bedrock#IncludedModelsList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#IncludedModelId" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrock#InferenceConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using.
", + "smithy.api#range": { + "min": 1 + } + } + }, + "temperature": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
", + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "topP": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for topP, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.
A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
", + "smithy.api#length": { + "max": 2500 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Base inference parameters to pass to a model. For more information, see Inference parameters for foundation models.
" + } + }, + "com.amazonaws.bedrock#InferenceProfileArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$" + } + }, + "com.amazonaws.bedrock#InferenceProfileDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^([0-9a-zA-Z:.][ _-]?)+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#InferenceProfileId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-:.]+$" + } + }, + "com.amazonaws.bedrock#InferenceProfileIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/)?[a-zA-Z0-9-:.]+$" + } + }, + "com.amazonaws.bedrock#InferenceProfileModel": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a model.
" + } + }, + "com.amazonaws.bedrock#InferenceProfileModelSource": { + "type": "union", + "members": { + "copyFrom": { + "target": "com.amazonaws.bedrock#InferenceProfileModelSourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the model or system-defined inference profile that is the source for the inference profile.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the model or system-defined inference profile that is the source for an inference profile..
" + } + }, + "com.amazonaws.bedrock#InferenceProfileModelSourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|foundation-model)/[a-zA-Z0-9-:.]+$" + } + }, + "com.amazonaws.bedrock#InferenceProfileModels": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#InferenceProfileModel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#InferenceProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][ _-]?)+$" + } + }, + "com.amazonaws.bedrock#InferenceProfileResource": { + "type": "resource", + "identifiers": { + "inferenceProfileIdentifier": { + "target": "com.amazonaws.bedrock#InferenceProfileIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrock#CreateInferenceProfile" + }, + "read": { + "target": "com.amazonaws.bedrock#GetInferenceProfile" + }, + "delete": { + "target": "com.amazonaws.bedrock#DeleteInferenceProfile" + }, + "list": { + "target": "com.amazonaws.bedrock#ListInferenceProfiles" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "InferenceProfile" + } + } + }, + "com.amazonaws.bedrock#InferenceProfileStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } + }, + "com.amazonaws.bedrock#InferenceProfileSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#InferenceProfileSummary" + } + }, + "com.amazonaws.bedrock#InferenceProfileSummary": { + "type": "structure", + "members": { + "inferenceProfileName": { + "target": "com.amazonaws.bedrock#InferenceProfileName", + "traits": { + "smithy.api#documentation": "The name of the inference profile.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#InferenceProfileDescription", + "traits": { + "smithy.api#documentation": "The description of the inference profile.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the inference profile was created.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the inference profile was last updated.
" + } + }, + "inferenceProfileArn": { + "target": "com.amazonaws.bedrock#InferenceProfileArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference profile.
", + "smithy.api#required": {} + } + }, + "models": { + "target": "com.amazonaws.bedrock#InferenceProfileModels", + "traits": { + "smithy.api#documentation": "A list of information about each model in the inference profile.
", + "smithy.api#required": {} + } + }, + "inferenceProfileId": { + "target": "com.amazonaws.bedrock#InferenceProfileId", + "traits": { + "smithy.api#documentation": "The unique identifier of the inference profile.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#InferenceProfileStatus", + "traits": { + "smithy.api#documentation": "The status of the inference profile. ACTIVE means that the inference profile is ready to be used.
The type of the inference profile. The following types are possible:
SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.
APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.
Contains information about an inference profile.
" + } + }, + "com.amazonaws.bedrock#InferenceProfileType": { + "type": "enum", + "members": { + "SYSTEM_DEFINED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM_DEFINED" + } + }, + "APPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION" + } + } + } + }, + "com.amazonaws.bedrock#InferenceType": { + "type": "enum", + "members": { + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + }, + "PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONED" + } + } + } + }, + "com.amazonaws.bedrock#InferenceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#InferenceType" + } + }, + "com.amazonaws.bedrock#InputTags": { + "type": "enum", + "members": { + "HONOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HONOR" + } + }, + "IGNORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGNORE" + } + } + } + }, + "com.amazonaws.bedrock#InstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.bedrock#InstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.bedrock#InstructSupported": { + "type": "boolean" + }, + "com.amazonaws.bedrock#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "An internal server error occurred. Retry your request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrock#InvocationLogSource": { + "type": "union", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "The URI of an invocation log in a bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A storage location for invocation logs.
" + } + }, + "com.amazonaws.bedrock#InvocationLogsConfig": { + "type": "structure", + "members": { + "usePromptResponse": { + "target": "com.amazonaws.bedrock#UsePromptResponse", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether to use the model's response for training, or just the prompt. The default value is False.
The source of the invocation logs.
", + "smithy.api#required": {} + } + }, + "requestMetadataFilters": { + "target": "com.amazonaws.bedrock#RequestMetadataFilters", + "traits": { + "smithy.api#documentation": "Rules for filtering invocation logs based on request metadata.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for using invocation logs to customize a model.
" + } + }, + "com.amazonaws.bedrock#JobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*$" + } + }, + "com.amazonaws.bedrock#JobStatusDetails": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" + } + } + } + }, + "com.amazonaws.bedrock#KbInferenceConfig": { + "type": "structure", + "members": { + "textInferenceConfig": { + "target": "com.amazonaws.bedrock#TextInferenceConfig", + "traits": { + "smithy.api#documentation": "Contains configuration details for text generation using a language model via the RetrieveAndGenerate function.
Contains configuration details of the inference for knowledge base retrieval and response generation.
" + } + }, + "com.amazonaws.bedrock#KeyPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + } + } + }, + "com.amazonaws.bedrock#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.bedrock#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)$" + } + }, + "com.amazonaws.bedrock#KnowledgeBaseConfig": { + "type": "union", + "members": { + "retrieveConfig": { + "target": "com.amazonaws.bedrock#RetrieveConfig", + "traits": { + "smithy.api#documentation": "Contains configuration details for retrieving information from a knowledge base.
" + } + }, + "retrieveAndGenerateConfig": { + "target": "com.amazonaws.bedrock#RetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "Contains configuration details for retrieving information from a knowledge base and generating responses.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for retrieving information from a knowledge base and generating responses.
" + } + }, + "com.amazonaws.bedrock#KnowledgeBaseId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrock#KnowledgeBaseRetrievalConfiguration": { + "type": "structure", + "members": { + "vectorSearchConfiguration": { + "target": "com.amazonaws.bedrock#KnowledgeBaseVectorSearchConfiguration", + "traits": { + "smithy.api#documentation": "Contains configuration details for returning the results from the vector search.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configuration details for retrieving information from a knowledge base.
" + } + }, + "com.amazonaws.bedrock#KnowledgeBaseRetrieveAndGenerateConfiguration": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrock#KnowledgeBaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.
", + "smithy.api#required": {} + } + }, + "retrievalConfiguration": { + "target": "com.amazonaws.bedrock#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "Contains configuration details for retrieving text chunks.
" + } + }, + "generationConfiguration": { + "target": "com.amazonaws.bedrock#GenerationConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations details for response generation based on retrieved text chunks.
" + } + }, + "orchestrationConfiguration": { + "target": "com.amazonaws.bedrock#OrchestrationConfiguration", + "traits": { + "smithy.api#documentation": "Contains configuration details for the model to process the prompt prior to retrieval and response generation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configuration details for retrieving information from a knowledge base and generating responses.
" + } + }, + "com.amazonaws.bedrock#KnowledgeBaseVectorSearchConfiguration": { + "type": "structure", + "members": { + "numberOfResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of text chunks to retrieve; the number of results to return.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "overrideSearchType": { + "target": "com.amazonaws.bedrock#SearchType", + "traits": { + "smithy.api#documentation": "By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available.
Specifies the filters to use on the metadata fields in the knowledge base data sources before returning results.
" + } + }, + "implicitFilterConfiguration": { + "target": "com.amazonaws.bedrock#ImplicitFilterConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for implicit filtering in Knowledge Base vector searches. This allows the system to automatically apply filters based on the query context without requiring explicit filter expressions.
" + } + }, + "rerankingConfiguration": { + "target": "com.amazonaws.bedrock#VectorSearchRerankingConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for reranking search results in Knowledge Base vector searches. Reranking improves search relevance by reordering initial vector search results using more sophisticated relevance models.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for returning the results from the knowledge base vector search.
" + } + }, + "com.amazonaws.bedrock#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.bedrock#LambdaGraderConfig": { + "type": "structure", + "members": { + "lambdaArn": { + "target": "com.amazonaws.bedrock#LambdaArn", + "traits": { + "smithy.api#documentation": "ARN of the AWS Lambda function that will evaluate model responses and return reward scores for RFT training.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for using an AWS Lambda function to grade model responses during reinforcement fine-tuning training.
" + } + }, + "com.amazonaws.bedrock#LegalTerm": { + "type": "structure", + "members": { + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "URL to the legal term document.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The legal term of the agreement.
" + } + }, + "com.amazonaws.bedrock#ListAdvancedPromptOptimizationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListAdvancedPromptOptimizationJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListAdvancedPromptOptimizationJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the advanced prompt optimization jobs in your account.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/advanced-prompt-optimization-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListAdvancedPromptOptimizationJobsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token in a subsequent request to get the next set of results.
The field to sort the results by.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order for the results.
", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#documentation": "List Advanced Prompt Optimization Jobs Request
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListAdvancedPromptOptimizationJobsResponse": { + "type": "structure", + "members": { + "jobSummaries": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobSummaries", + "traits": { + "smithy.api#documentation": "A list of advanced prompt optimization job summaries.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token in a subsequent request to get the next set of results.
List Advanced Prompt Optimization Jobs Response
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all Automated Reasoning policies in your account, with optional filtering by policy ARN. This helps you manage and discover existing policies.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "items": "automatedReasoningPolicySummaries", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPoliciesRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "Optional filter to list only the policy versions with the specified Amazon Resource Name (ARN). If not provided, the DRAFT versions for all policies are listed.
", + "smithy.api#httpQuery": "policyArn" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#default": 25, + "smithy.api#documentation": "The maximum number of policies to return in a single call.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPoliciesResponse": { + "type": "structure", + "members": { + "automatedReasoningPolicySummaries": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicySummaries", + "traits": { + "smithy.api#documentation": "A list of Automated Reasoning policy summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token to use in a subsequent request to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyBuildWorkflows": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyBuildWorkflowsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyBuildWorkflowsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all build workflows for an Automated Reasoning policy, showing the history of policy creation and modification attempts.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "items": "automatedReasoningPolicyBuildWorkflowSummaries", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyBuildWorkflowsRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflows you want to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "A pagination token from a previous request to continue listing build workflows from where the previous request left off.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#default": 25, + "smithy.api#documentation": "The maximum number of build workflows to return in a single response. Valid range is 1-100.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyBuildWorkflowsResponse": { + "type": "structure", + "members": { + "automatedReasoningPolicyBuildWorkflowSummaries": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowSummaries", + "traits": { + "smithy.api#documentation": "A list of build workflow summaries, each containing key information about a build workflow including its status and timestamps.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "A pagination token to use in subsequent requests to retrieve additional build workflows.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestCases": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestCasesRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestCasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists tests for an Automated Reasoning policy. We recommend using pagination to ensure that the operation returns quickly and successfully.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/test-cases" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "items": "testCases", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestCasesRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to list tests.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#default": 25, + "smithy.api#documentation": "The maximum number of tests to return in a single call.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestCasesResponse": { + "type": "structure", + "members": { + "testCases": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseList", + "traits": { + "smithy.api#documentation": "A list of tests for the specified policy.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token to use in a subsequent request to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestResultsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/test-results" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "items": "testResults", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestResultsRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy whose test results you want to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow whose test results you want to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "A pagination token from a previous request to continue listing test results from where the previous request left off.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#default": 25, + "smithy.api#documentation": "The maximum number of test results to return in a single response. Valid range is 1-100.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestResultsResponse": { + "type": "structure", + "members": { + "testResults": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestList", + "traits": { + "smithy.api#documentation": "A list of test results, each containing information about how the policy performed on specific test scenarios.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "A pagination token to use in subsequent requests to retrieve additional test results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListCustomModelDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListCustomModelDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListCustomModelDeploymentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists custom model deployments in your account. You can filter the results by creation time, name, status, and associated model. Use this operation to manage and monitor your custom model deployments.
We recommend using pagination to ensure that the operation returns quickly and successfully.
The following actions are related to the ListCustomModelDeployments operation:
Filters deployments created before the specified date and time.
", + "smithy.api#httpQuery": "createdBefore" + } + }, + "createdAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Filters deployments created after the specified date and time.
", + "smithy.api#httpQuery": "createdAfter" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#ModelDeploymentName", + "traits": { + "smithy.api#documentation": "Filters deployments whose names contain the specified string.
", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use this token to retrieve additional results when the response is truncated.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortModelsBy", + "traits": { + "smithy.api#documentation": "The field to sort the results by. The only supported value is CreationTime.
The sort order for the results. Valid values are Ascending and Descending. Default is Descending.
Filters deployments by status. Valid values are CREATING, ACTIVE, and FAILED.
Filters deployments by the Amazon Resource Name (ARN) of the associated custom model.
", + "smithy.api#httpQuery": "modelArnEquals" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListCustomModelDeploymentsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. This value is null when there are no more results to return.
" + } + }, + "modelDeploymentSummaries": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentSummaryList", + "traits": { + "smithy.api#documentation": "A list of custom model deployment summaries.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListCustomModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListCustomModelsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListCustomModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.
For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/custom-models" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "modelSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListCustomModelsRequest": { + "type": "structure", + "members": { + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Return custom models created before the specified time.
", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Return custom models created after the specified time.
", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "Return custom models only if the job name contains these characters.
", + "smithy.api#httpQuery": "nameContains" + } + }, + "baseModelArnEquals": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.
", + "smithy.api#httpQuery": "baseModelArnEquals" + } + }, + "foundationModelArnEquals": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.
", + "smithy.api#httpQuery": "foundationModelArnEquals" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The field to sort by in the returned list of models.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order of the results.
", + "smithy.api#httpQuery": "sortOrder" + } + }, + "isOwned": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).
The status of them model to filter results by. Possible values include:
Creating - Include only models that are currently being created and validated.
Active - Include only models that have been successfully created and are ready for use.
Failed - Include only models where the creation process failed.
If you don't specify a status, the API returns models in all states.
", + "smithy.api#httpQuery": "modelStatus" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListCustomModelsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Model summaries.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListEnforcedGuardrailsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListEnforcedGuardrailsConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListEnforcedGuardrailsConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the account-level enforced guardrail configurations.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/enforcedGuardrailsConfiguration" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "guardrailsConfig" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListEnforcedGuardrailsConfigurationRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "Opaque continuation token of previous paginated response.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListEnforcedGuardrailsConfigurationResponse": { + "type": "structure", + "members": { + "guardrailsConfig": { + "target": "com.amazonaws.bedrock#AccountEnforcedGuardrailsOutputConfiguration", + "traits": { + "smithy.api#documentation": "Array of AccountEnforcedGuardrailOutputConfiguration objects.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "Opaque continuation token of previous paginated response.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListEvaluationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListEvaluationJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListEvaluationJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all existing evaluation jobs.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/evaluation-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListEvaluationJobsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "A filter to only list evaluation jobs created after a specified time.
", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "A filter to only list evaluation jobs created before a specified time.
", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "A filter to only list evaluation jobs that are of a certain status.
", + "smithy.api#httpQuery": "statusEquals" + } + }, + "applicationTypeEquals": { + "target": "com.amazonaws.bedrock#ApplicationType", + "traits": { + "smithy.api#documentation": "A filter to only list evaluation jobs that are either model evaluations or knowledge base evaluations.
", + "smithy.api#httpQuery": "applicationTypeEquals" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "A filter to only list evaluation jobs that contain a specified string in the job name.
", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortJobsBy", + "traits": { + "smithy.api#documentation": "Specifies a creation time to sort the list of evaluation jobs by when they were created.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "Specifies whether to sort the list of evaluation jobs by either ascending or descending order.
", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListEvaluationJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
" + } + }, + "jobSummaries": { + "target": "com.amazonaws.bedrock#EvaluationSummaries", + "traits": { + "smithy.api#documentation": "A list of summaries of the evaluation jobs.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListFoundationModelAgreementOffers": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListFoundationModelAgreementOffersRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListFoundationModelAgreementOffersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get the offers associated with the specified model.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/list-foundation-model-agreement-offers/{modelId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListFoundationModelAgreementOffersRequest": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "Model Id of the foundation model.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "offerType": { + "target": "com.amazonaws.bedrock#OfferType", + "traits": { + "smithy.api#documentation": "Type of offer associated with the model.
", + "smithy.api#httpQuery": "offerType" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListFoundationModelAgreementOffersResponse": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "Model Id of the foundation model.
", + "smithy.api#required": {} + } + }, + "offers": { + "target": "com.amazonaws.bedrock#Offers", + "traits": { + "smithy.api#documentation": "List of the offers associated with the specified model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListFoundationModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListFoundationModelsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListFoundationModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/foundation-models" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListFoundationModelsRequest": { + "type": "structure", + "members": { + "byProvider": { + "target": "com.amazonaws.bedrock#Provider", + "traits": { + "smithy.api#documentation": "Return models belonging to the model provider that you specify.
", + "smithy.api#httpQuery": "byProvider" + } + }, + "byCustomizationType": { + "target": "com.amazonaws.bedrock#ModelCustomization", + "traits": { + "smithy.api#documentation": "Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#httpQuery": "byCustomizationType" + } + }, + "byOutputModality": { + "target": "com.amazonaws.bedrock#ModelModality", + "traits": { + "smithy.api#documentation": "Return models that support the output modality that you specify.
", + "smithy.api#httpQuery": "byOutputModality" + } + }, + "byInferenceType": { + "target": "com.amazonaws.bedrock#InferenceType", + "traits": { + "smithy.api#documentation": "Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#httpQuery": "byInferenceType" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListFoundationModelsResponse": { + "type": "structure", + "members": { + "modelSummaries": { + "target": "com.amazonaws.bedrock#FoundationModelSummaryList", + "traits": { + "smithy.api#documentation": "A list of Amazon Bedrock foundation models.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListGuardrails": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListGuardrailsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListGuardrailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists details about all the guardrails in an account. To list the DRAFT version of all your guardrails, don't specify the guardrailIdentifier field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field.
You can set the maximum number of results to return in a response in the maxResults field. If there are more results than the number you set, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.
The unique identifier of the guardrail. This can be an ID or the ARN.
", + "smithy.api#httpQuery": "guardrailIdentifier" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If there are more results than were returned in the response, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.
A list of objects, each of which contains details about a guardrail.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If there are more results than were returned in the response, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.
Returns a list of models you've imported. You can filter the results to return based on one or more criteria. For more information, see Import a customized model in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/imported-models" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "modelSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListImportedModelsRequest": { + "type": "structure", + "members": { + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Return imported models that created before the specified time.
", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Return imported models that were created after the specified time.
", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "Return imported models only if the model name contains these characters.
", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The field to sort by in the returned list of imported models.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "Specifies whetehr to sort the results in ascending or descending order.
", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListImportedModelsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Model summaries.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListInferenceProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListInferenceProfilesRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListInferenceProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of inference profiles that you can use. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/inference-profiles" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "inferenceProfileSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListInferenceProfilesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
Filters for inference profiles that match the type you specify.
SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.
APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.
A list of information about each inference profile that you can use.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/marketplace-model/endpoints" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "marketplaceModelEndpoints" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListMarketplaceModelEndpointsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call. If more results are available, the operation returns a NextToken value.
The token for the next set of results. You receive this token from a previous ListMarketplaceModelEndpoints call.
If specified, only endpoints for the given model source identifier are returned.
", + "smithy.api#httpQuery": "modelSourceIdentifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListMarketplaceModelEndpointsResponse": { + "type": "structure", + "members": { + "marketplaceModelEndpoints": { + "target": "com.amazonaws.bedrock#MarketplaceModelEndpointSummaries", + "traits": { + "smithy.api#documentation": "An array of endpoint summaries.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use this token to get the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListModelCopyJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListModelCopyJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListModelCopyJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-copy-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "modelCopyJobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListModelCopyJobsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Filters for model copy jobs created after the specified time.
", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Filters for model copy jobs created before the specified time.
", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#ModelCopyJobStatus", + "traits": { + "smithy.api#documentation": "Filters for model copy jobs whose status matches the value that you specify.
", + "smithy.api#httpQuery": "statusEquals" + } + }, + "sourceAccountEquals": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.
", + "smithy.api#httpQuery": "sourceAccountEquals" + } + }, + "sourceModelArnEquals": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.
", + "smithy.api#httpQuery": "sourceModelArnEquals" + } + }, + "targetModelNameContains": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "Filters for model copy jobs in which the name of the copied model contains the string that you specify.
", + "smithy.api#httpQuery": "outputModelNameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The field to sort by in the returned list of model copy jobs.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "Specifies whether to sort the results in ascending or descending order.
", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListModelCopyJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
A list of information about each model copy job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListModelCustomizationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListModelCustomizationJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListModelCustomizationJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.
For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-customization-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "modelCustomizationJobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListModelCustomizationJobsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Return customization jobs created after the specified time.
", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Return customization jobs created before the specified time.
", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#FineTuningJobStatus", + "traits": { + "smithy.api#documentation": "Return customization jobs with the specified status.
", + "smithy.api#httpQuery": "statusEquals" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "Return customization jobs only if the job name contains these characters.
", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The field to sort by in the returned list of jobs.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order of the results.
", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListModelCustomizationJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Job summaries.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListModelImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListModelImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListModelImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of import jobs you've submitted. You can filter the results to return based on one or more criteria. For more information, see Import a customized model in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-import-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "modelImportJobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListModelImportJobsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Return import jobs that were created after the specified time.
", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Return import jobs that were created before the specified time.
", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#ModelImportJobStatus", + "traits": { + "smithy.api#documentation": "Return imported jobs with the specified status.
", + "smithy.api#httpQuery": "statusEquals" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "Return imported jobs only if the job name contains these characters.
", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The field to sort by in the returned list of imported jobs.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "Specifies whether to sort the results in ascending or descending order.
", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListModelImportJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
Import job summaries.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListModelInvocationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListModelInvocationJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListModelInvocationJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-invocation-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "invocationJobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListModelInvocationJobsRequest": { + "type": "structure", + "members": { + "submitTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Specify a time to filter for batch inference jobs that were submitted after the time you specify.
", + "smithy.api#httpQuery": "submitTimeAfter" + } + }, + "submitTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Specify a time to filter for batch inference jobs that were submitted before the time you specify.
", + "smithy.api#httpQuery": "submitTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", + "traits": { + "smithy.api#documentation": "Specify a status to filter for batch inference jobs whose statuses match the string you specify.
The following statuses are possible:
Submitted – This job has been submitted to a queue for validation.
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
Your IAM service role has access to the Amazon S3 buckets containing your files.
Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the modelInput value matches the request body for the model.
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
InProgress – This job has begun. You can start viewing the results in the output S3 location.
Completed – This job has successfully completed. View the output files in the output S3 location.
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web Services Support Center.
Stopped – This job was stopped by a user.
Stopping – This job is being stopped by a user.
Specify a string to filter for batch inference jobs whose names contain the string.
", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return. If there are more results than the number that you specify, a nextToken value is returned. Use the nextToken in a request to return the next batch of results.
If there were more results than the value you specified in the maxResults field in a previous ListModelInvocationJobs request, the response would have returned a nextToken value. To see the next batch of results, send the nextToken value in another request.
An attribute by which to sort the results.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "Specifies whether to sort the results by ascending or descending order.
", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListModelInvocationJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If there are more results than can fit in the response, a nextToken is returned. Use the nextToken in a request to return the next batch of results.
A list of items, each of which contains a summary about a batch inference job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListPromptRouters": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListPromptRoutersRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListPromptRoutersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of prompt routers.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/prompt-routers" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "promptRouterSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListPromptRoutersRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of prompt routers to return in one page of results.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "type": { + "target": "com.amazonaws.bedrock#PromptRouterType", + "traits": { + "smithy.api#default": "default", + "smithy.api#documentation": "The type of the prompt routers, such as whether it's default or custom.
", + "smithy.api#httpQuery": "type" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListPromptRoutersResponse": { + "type": "structure", + "members": { + "promptRouterSummaries": { + "target": "com.amazonaws.bedrock#PromptRouterSummaries", + "traits": { + "smithy.api#documentation": "A list of prompt router summaries.
" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListProvisionedModelThroughputs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/provisioned-model-throughputs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "provisionedModelSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns Provisioned Throughputs created after the specified time.
", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "A filter that returns Provisioned Throughputs created before the specified time.
", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.
", + "smithy.api#httpQuery": "statusEquals" + } + }, + "modelArnEquals": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.
", + "smithy.api#httpQuery": "modelArnEquals" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "A filter that returns Provisioned Throughputs if their name contains the expression that you specify.
", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a nextToken value. To see the next batch of results, send the nextToken value in another list request.
If there are more results than the number you specified in the maxResults field, the response returns a nextToken value. To see the next batch of results, specify the nextToken value in this field.
The field by which to sort the returned list of Provisioned Throughputs.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order of the results.
", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "If there are more results than the number you specified in the maxResults field, this value is returned. To see the next batch of results, include this value in the nextToken field in another list request.
A list of summaries, one for each Provisioned Throughput in the response.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List the tags associated with the specified resource.
For more information, see Tagging resources in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/listTagsForResource" + } + } + }, + "com.amazonaws.bedrock#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.bedrock#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "An array of the tags associated with this resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.bedrock#LoggingConfig": { + "type": "structure", + "members": { + "cloudWatchConfig": { + "target": "com.amazonaws.bedrock#CloudWatchConfig", + "traits": { + "smithy.api#documentation": "CloudWatch logging configuration.
" + } + }, + "s3Config": { + "target": "com.amazonaws.bedrock#S3Config", + "traits": { + "smithy.api#documentation": "S3 configuration for storing log data.
" + } + }, + "textDataDeliveryEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Set to include text data in the log delivery.
" + } + }, + "imageDataDeliveryEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Set to include image data in the log delivery.
" + } + }, + "embeddingDataDeliveryEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Set to include embeddings data in the log delivery.
" + } + }, + "videoDataDeliveryEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Set to include video data in the log delivery.
" + } + }, + "audioDataDeliveryEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Set to include audio data in the log delivery.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration fields for invocation logging.
" + } + }, + "com.amazonaws.bedrock#LoggingResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration" + }, + { + "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfiguration" + }, + { + "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfiguration" + } + ] + }, + "com.amazonaws.bedrock#MarketplaceModelEndpoint": { + "type": "structure", + "members": { + "endpointArn": { + "target": "com.amazonaws.bedrock#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", + "smithy.api#required": {} + } + }, + "modelSourceIdentifier": { + "target": "com.amazonaws.bedrock#ModelSourceIdentifier", + "traits": { + "smithy.api#documentation": "The ARN of the model from Amazon Bedrock Marketplace that is deployed on this endpoint.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#Status", + "traits": { + "smithy.api#documentation": "The overall status of the endpoint in Amazon Bedrock Marketplace (e.g., ACTIVE, INACTIVE).
" + } + }, + "statusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Additional information about the overall status, if available.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the endpoint was registered.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the endpoint was last updated.
", + "smithy.api#required": {} + } + }, + "endpointConfig": { + "target": "com.amazonaws.bedrock#EndpointConfig", + "traits": { + "smithy.api#documentation": "The configuration of the endpoint, including the number and type of instances used.
", + "smithy.api#required": {} + } + }, + "endpointStatus": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The current status of the endpoint (e.g., Creating, InService, Updating, Failed).
", + "smithy.api#required": {} + } + }, + "endpointStatusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Additional information about the endpoint status, if available.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an endpoint for a model from Amazon Bedrock Marketplace.
" + } + }, + "com.amazonaws.bedrock#MarketplaceModelEndpointSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#MarketplaceModelEndpointSummary" + }, + "traits": { + "smithy.api#length": { + "max": 1000 + } + } + }, + "com.amazonaws.bedrock#MarketplaceModelEndpointSummary": { + "type": "structure", + "members": { + "endpointArn": { + "target": "com.amazonaws.bedrock#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint.
", + "smithy.api#required": {} + } + }, + "modelSourceIdentifier": { + "target": "com.amazonaws.bedrock#ModelSourceIdentifier", + "traits": { + "smithy.api#documentation": "The ARN of the model from Amazon Bedrock Marketplace that is deployed on this endpoint.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#Status", + "traits": { + "smithy.api#documentation": "The overall status of the endpoint in Amazon Bedrock Marketplace.
" + } + }, + "statusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Additional information about the overall status, if available.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the endpoint was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the endpoint was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary of an endpoint for a model from Amazon Bedrock Marketplace.
" + } + }, + "com.amazonaws.bedrock#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrock#MaxTokens": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65536 + } + } + }, + "com.amazonaws.bedrock#Message": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#MetadataAttributeSchema": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the metadata attribute. This key is used to reference the attribute in filter expressions and reranking configurations.
", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrock#AttributeType", + "traits": { + "smithy.api#documentation": "The data type of the metadata attribute. The type determines how the attribute can be used in filter expressions and reranking.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "An optional description of the metadata attribute that provides additional context about its purpose and usage.
", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the schema for a metadata attribute used in Knowledge Base vector searches. Metadata attributes provide additional context for documents and can be used for filtering and reranking search results.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#MetadataAttributeSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#MetadataAttributeSchema" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bedrock#MetadataConfigurationForReranking": { + "type": "structure", + "members": { + "selectionMode": { + "target": "com.amazonaws.bedrock#RerankingMetadataSelectionMode", + "traits": { + "smithy.api#documentation": "The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).
", + "smithy.api#required": {} + } + }, + "selectiveModeConfiguration": { + "target": "com.amazonaws.bedrock#RerankingMetadataSelectiveModeConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches. This determines which metadata fields are included or excluded when reordering search results.
" + } + }, + "com.amazonaws.bedrock#MetricFloat": { + "type": "float" + }, + "com.amazonaws.bedrock#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#ModelArchitecture": { + "type": "string" + }, + "com.amazonaws.bedrock#ModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))$" + } + }, + "com.amazonaws.bedrock#ModelConfiguration": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "The ID of the model to use for optimization.
", + "smithy.api#required": {} + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrock#InferenceConfiguration", + "traits": { + "smithy.api#documentation": "The inference configuration for the model, including parameters such as maximum tokens, temperature, and top-p.
" + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrock#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "Additional model request fields. Use this to pass model-specific parameters that are not included in the standard inference configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configuration for a model used in an advanced prompt optimization job, including the model ID and inference parameters.
" + } + }, + "com.amazonaws.bedrock#ModelConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelConfiguration" + }, + "traits": { + "smithy.api#documentation": "A list of model configurations for advanced prompt optimization.
", + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#ModelCopyJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ModelCopyJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.bedrock#ModelCopyJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelCopyJobSummary" + } + }, + "com.amazonaws.bedrock#ModelCopyJobSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resoource Name (ARN) of the model copy job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCopyJobStatus", + "traits": { + "smithy.api#documentation": "The status of the model copy job.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the model copy job was created.
", + "smithy.api#required": {} + } + }, + "targetModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the copied model.
", + "smithy.api#required": {} + } + }, + "targetModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "The name of the copied model.
" + } + }, + "sourceAccountId": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "The unique identifier of the account that the model being copied originated from.
", + "smithy.api#required": {} + } + }, + "sourceModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the original model being copied.
", + "smithy.api#required": {} + } + }, + "targetModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied model.
" + } + }, + "targetModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags associated with the copied model.
" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "If a model fails to be copied, a message describing why the job failed is included here.
" + } + }, + "sourceModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "The name of the original model being copied.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about each model copy job.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrock#ModelCopyResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateModelCopyJob" + }, + { + "target": "com.amazonaws.bedrock#GetModelCopyJob" + }, + { + "target": "com.amazonaws.bedrock#ListModelCopyJobs" + } + ] + }, + "com.amazonaws.bedrock#ModelCustomization": { + "type": "enum", + "members": { + "FINE_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINE_TUNING" + } + }, + "CONTINUED_PRE_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" + } + }, + "DISTILLATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTILLATION" + } + } + } + }, + "com.amazonaws.bedrock#ModelCustomizationHyperParameters": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*)$" + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + } + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobSummary" + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the customization job.
", + "smithy.api#required": {} + } + }, + "baseModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the base model.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "Name of the customization job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", + "traits": { + "smithy.api#documentation": "Status of the customization job.
", + "smithy.api#required": {} + } + }, + "statusDetails": { + "target": "com.amazonaws.bedrock#StatusDetails", + "traits": { + "smithy.api#documentation": "Details about the status of the data processing sub-task of the job.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Time that the customization job was last modified.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Creation time of the custom model.
", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Time that the customization job ended.
" + } + }, + "customModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the custom model.
" + } + }, + "customModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "Name of the custom model.
" + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about one customization job
" + } + }, + "com.amazonaws.bedrock#ModelCustomizationList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelCustomization" + } + }, + "com.amazonaws.bedrock#ModelDataSource": { + "type": "union", + "members": { + "s3DataSource": { + "target": "com.amazonaws.bedrock#S3DataSource", + "traits": { + "smithy.api#documentation": "The Amazon S3 data source of the model to import.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The data source of the model to import.
" + } + }, + "com.amazonaws.bedrock#ModelDeploymentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,63}$" + } + }, + "com.amazonaws.bedrock#ModelEnforcement": { + "type": "structure", + "members": { + "includedModels": { + "target": "com.amazonaws.bedrock#IncludedModelsList", + "traits": { + "smithy.api#documentation": "Models to enforce the guardrail on.
", + "smithy.api#required": {} + } + }, + "excludedModels": { + "target": "com.amazonaws.bedrock#ExcludedModelsList", + "traits": { + "smithy.api#documentation": "Models to exclude from enforcement of the guardrail.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Model-specific information for the enforced guardrail configuration.
" + } + }, + "com.amazonaws.bedrock#ModelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-:]{1,63}/[a-z0-9]{12}$)|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrock#ModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrock#ModelImportJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ModelImportJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*)$" + } + }, + "com.amazonaws.bedrock#ModelImportJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.bedrock#ModelImportJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelImportJobSummary" + } + }, + "com.amazonaws.bedrock#ModelImportJobSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelImportJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the import job.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "The name of the import job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelImportJobStatus", + "traits": { + "smithy.api#documentation": "The status of the imported job.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the import job was last modified.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time import job was created.
", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time when import job ended.
" + } + }, + "importedModelArn": { + "target": "com.amazonaws.bedrock#ImportedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon resource Name (ARN) of the imported model.
" + } + }, + "importedModelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "The name of the imported model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the import job.
" + } + }, + "com.amazonaws.bedrock#ModelImportResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateModelImportJob" + }, + { + "target": "com.amazonaws.bedrock#DeleteImportedModel" + }, + { + "target": "com.amazonaws.bedrock#GetImportedModel" + }, + { + "target": "com.amazonaws.bedrock#GetModelImportJob" + }, + { + "target": "com.amazonaws.bedrock#ListImportedModels" + }, + { + "target": "com.amazonaws.bedrock#ListModelImportJobs" + } + ] + }, + "com.amazonaws.bedrock#ModelInvocationIdempotencyToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{1,256}(-*[a-zA-Z0-9]){0,256}$" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/[a-z0-9]{12})$" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^((arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/)?[a-z0-9]{12})$" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig": { + "type": "union", + "members": { + "s3InputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobS3InputDataConfig", + "traits": { + "smithy.api#documentation": "Contains the configuration of the S3 location of the input data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the location of the input to the batch inference job.
" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\\+\\-\\.]){0,63}$" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig": { + "type": "union", + "members": { + "s3OutputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobS3OutputDataConfig", + "traits": { + "smithy.api#documentation": "Contains the configuration of the S3 location of the output data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configuration of the S3 location of the output data.
" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateModelInvocationJob" + }, + { + "target": "com.amazonaws.bedrock#GetModelInvocationJob" + }, + { + "target": "com.amazonaws.bedrock#ListModelInvocationJobs" + }, + { + "target": "com.amazonaws.bedrock#StopModelInvocationJob" + } + ] + }, + "com.amazonaws.bedrock#ModelInvocationJobS3InputDataConfig": { + "type": "structure", + "members": { + "s3InputFormat": { + "target": "com.amazonaws.bedrock#S3InputFormat", + "traits": { + "smithy.api#documentation": "The format of the input data.
" + } + }, + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 location of the input data.
", + "smithy.api#required": {} + } + }, + "s3BucketOwner": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the S3 bucket containing the input data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configuration of the S3 location of the input data.
" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobS3OutputDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 location of the output data.
", + "smithy.api#required": {} + } + }, + "s3EncryptionKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "The unique identifier of the key that encrypts the S3 location of the output data.
" + } + }, + "s3BucketOwner": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the S3 bucket containing the output data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configuration of the S3 location of the output data.
" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobStatus": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Submitted" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "PARTIALLY_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PartiallyCompleted" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Expired" + } + }, + "VALIDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Validating" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scheduled" + } + } + } + }, + "com.amazonaws.bedrock#ModelInvocationJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelInvocationJobSummary" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelInvocationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the batch inference job.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#ModelInvocationJobName", + "traits": { + "smithy.api#documentation": "The name of the batch inference job.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#ModelId", + "traits": { + "smithy.api#documentation": "The unique identifier of the foundation model used for model inference.
", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", + "traits": { + "smithy.api#documentation": "The status of the batch inference job.
The following statuses are possible:
Submitted – This job has been submitted to a queue for validation.
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
Your IAM service role has access to the Amazon S3 buckets containing your files.
Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the modelInput value matches the request body for the model.
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
InProgress – This job has begun. You can start viewing the results in the output S3 location.
Completed – This job has successfully completed. View the output files in the output S3 location.
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web Services Support Center.
Stopped – This job was stopped by a user.
Stopping – This job is being stopped by a user.
If the batch inference job failed, this field contains a message describing why the job failed.
" + } + }, + "submitTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the batch inference job was submitted.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the batch inference job was last modified.
" + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the batch inference job ended.
" + } + }, + "inputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", + "traits": { + "smithy.api#documentation": "Details about the location of the input to the batch inference job.
", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", + "traits": { + "smithy.api#documentation": "Details about the location of the output of the batch inference job.
", + "smithy.api#required": {} + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.
" + } + }, + "timeoutDurationInHours": { + "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", + "traits": { + "smithy.api#documentation": "The number of hours after which the batch inference job was set to time out.
" + } + }, + "jobExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the batch inference job times or timed out.
" + } + }, + "modelInvocationType": { + "target": "com.amazonaws.bedrock#ModelInvocationType", + "traits": { + "smithy.api#documentation": "The invocation endpoint for ModelInvocationJob
" + } + }, + "totalRecordCount": { + "target": "com.amazonaws.bedrock#NonNegativeLong", + "traits": { + "smithy.api#documentation": "The total number of records in the batch inference job.
" + } + }, + "processedRecordCount": { + "target": "com.amazonaws.bedrock#NonNegativeLong", + "traits": { + "smithy.api#documentation": "The number of records that have been processed in the batch inference job.
" + } + }, + "successRecordCount": { + "target": "com.amazonaws.bedrock#NonNegativeLong", + "traits": { + "smithy.api#documentation": "The number of records that were successfully processed in the batch inference job.
" + } + }, + "errorRecordCount": { + "target": "com.amazonaws.bedrock#NonNegativeLong", + "traits": { + "smithy.api#documentation": "The number of records that failed to process in the batch inference job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of a batch inference job.
" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 24, + "max": 168 + } + } + }, + "com.amazonaws.bedrock#ModelInvocationType": { + "type": "enum", + "members": { + "InvokeModel": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvokeModel" + } + }, + "Converse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Converse" + } + } + } + }, + "com.amazonaws.bedrock#ModelModality": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + }, + "EMBEDDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMBEDDING" + } + } + } + }, + "com.amazonaws.bedrock#ModelModalityList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelModality" + } + }, + "com.amazonaws.bedrock#ModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63})$" + } + }, + "com.amazonaws.bedrock#ModelPackageArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package/[\\S]{1,2048}$" + } + }, + "com.amazonaws.bedrock#ModelPackageArnDataSource": { + "type": "structure", + "members": { + "modelPackageArn": { + "target": "com.amazonaws.bedrock#ModelPackageArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker AI model package. The ARN must be for a model package of restricted type.
To use a model package ARN, you must have the sagemaker:DescribeModelPackage and sagemaker:AccessModelPackageData permissions on the model package resource.
Contains the Amazon Resource Name (ARN) of a SageMaker AI model package to use as the data source for a custom model.
" + } + }, + "com.amazonaws.bedrock#ModelResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#GetFoundationModel" + }, + { + "target": "com.amazonaws.bedrock#ListFoundationModels" + } + ] + }, + "com.amazonaws.bedrock#ModelSourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "arn:aws:sagemaker:.*:hub-content/SageMakerPublicHub/Model/.*" + } + }, + "com.amazonaws.bedrock#ModelStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.bedrock#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.bedrock#NonEmptyStringList": { + "type": "list", + "member": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "traits": { + "smithy.api#documentation": "A list of non-empty strings.
" + } + }, + "com.amazonaws.bedrock#NonNegativeLong": { + "type": "long", + "traits": { + "smithy.api#documentation": "A non-negative long value.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.bedrock#Offer": { + "type": "structure", + "members": { + "offerId": { + "target": "com.amazonaws.bedrock#OfferId", + "traits": { + "smithy.api#documentation": "Offer Id for a model offer.
" + } + }, + "offerToken": { + "target": "com.amazonaws.bedrock#OfferToken", + "traits": { + "smithy.api#documentation": "Offer token.
", + "smithy.api#required": {} + } + }, + "termDetails": { + "target": "com.amazonaws.bedrock#TermDetails", + "traits": { + "smithy.api#documentation": "Details about the terms of the offer.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An offer dictates usage terms for the model.
" + } + }, + "com.amazonaws.bedrock#OfferId": { + "type": "string" + }, + "com.amazonaws.bedrock#OfferToken": { + "type": "string" + }, + "com.amazonaws.bedrock#OfferType": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "PUBLIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLIC" + } + } + } + }, + "com.amazonaws.bedrock#Offers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#Offer" + } + }, + "com.amazonaws.bedrock#OrchestrationConfiguration": { + "type": "structure", + "members": { + "queryTransformationConfiguration": { + "target": "com.amazonaws.bedrock#QueryTransformationConfiguration", + "traits": { + "smithy.api#documentation": "Contains configuration details for transforming the prompt.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for the model to process the prompt prior to retrieval and response generation.
" + } + }, + "com.amazonaws.bedrock#OutputDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI where the output data is stored.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "S3 Location of the output data.
" + } + }, + "com.amazonaws.bedrock#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrock#PerformanceConfigLatency": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optimized" + } + } + } + }, + "com.amazonaws.bedrock#PerformanceConfiguration": { + "type": "structure", + "members": { + "latency": { + "target": "com.amazonaws.bedrock#PerformanceConfigLatency", + "traits": { + "smithy.api#documentation": "Specifies whether to use the latency-optimized or standard version of a model or inference profile.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains performance settings for a model.
" + } + }, + "com.amazonaws.bedrock#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.bedrock#PricingTerm": { + "type": "structure", + "members": { + "rateCard": { + "target": "com.amazonaws.bedrock#RateCard", + "traits": { + "smithy.api#documentation": "Describes a usage price for each dimension.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the usage-based pricing term.
" + } + }, + "com.amazonaws.bedrock#PromptRouterArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+$" + } + }, + "com.amazonaws.bedrock#PromptRouterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^([0-9a-zA-Z:.][ _-]?)+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#PromptRouterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][ _-]?)+$" + } + }, + "com.amazonaws.bedrock#PromptRouterResource": { + "type": "resource", + "identifiers": { + "promptRouterArn": { + "target": "com.amazonaws.bedrock#PromptRouterArn" + } + }, + "create": { + "target": "com.amazonaws.bedrock#CreatePromptRouter" + }, + "read": { + "target": "com.amazonaws.bedrock#GetPromptRouter" + }, + "delete": { + "target": "com.amazonaws.bedrock#DeletePromptRouter" + }, + "list": { + "target": "com.amazonaws.bedrock#ListPromptRouters" + } + }, + "com.amazonaws.bedrock#PromptRouterStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + } + } + }, + "com.amazonaws.bedrock#PromptRouterSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#PromptRouterSummary" + } + }, + "com.amazonaws.bedrock#PromptRouterSummary": { + "type": "structure", + "members": { + "promptRouterName": { + "target": "com.amazonaws.bedrock#PromptRouterName", + "traits": { + "smithy.api#documentation": "The router's name.
", + "smithy.api#required": {} + } + }, + "routingCriteria": { + "target": "com.amazonaws.bedrock#RoutingCriteria", + "traits": { + "smithy.api#documentation": "The router's routing criteria.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#PromptRouterDescription", + "traits": { + "smithy.api#documentation": "The router's description.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "When the router was created.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "When the router was updated.
" + } + }, + "promptRouterArn": { + "target": "com.amazonaws.bedrock#PromptRouterArn", + "traits": { + "smithy.api#documentation": "The router's ARN.
", + "smithy.api#required": {} + } + }, + "models": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModels", + "traits": { + "smithy.api#documentation": "The router's models.
", + "smithy.api#required": {} + } + }, + "fallbackModel": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModel", + "traits": { + "smithy.api#documentation": "The router's fallback model.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#PromptRouterStatus", + "traits": { + "smithy.api#documentation": "The router's status.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrock#PromptRouterType", + "traits": { + "smithy.api#documentation": "The summary's type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a prompt router.
" + } + }, + "com.amazonaws.bedrock#PromptRouterTargetModel": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModelArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The target model's ARN.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The target model for a prompt router.
" + } + }, + "com.amazonaws.bedrock#PromptRouterTargetModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+)$" + } + }, + "com.amazonaws.bedrock#PromptRouterTargetModels": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModel" + } + }, + "com.amazonaws.bedrock#PromptRouterType": { + "type": "enum", + "members": { + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "custom" + } + }, + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, + "com.amazonaws.bedrock#PromptTemplate": { + "type": "structure", + "members": { + "textPromptTemplate": { + "target": "com.amazonaws.bedrock#TextPromptTemplate", + "traits": { + "smithy.api#documentation": "The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.
For more information, see Knowledge base prompt template and Use XML tags with Anthropic Claude models.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The template for the prompt that's sent to the model for response generation.
" + } + }, + "com.amazonaws.bedrock#Provider": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9- ]{1,63}$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.bedrock#ProvisionedModelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ProvisionedModelSummary" + } + }, + "com.amazonaws.bedrock#ProvisionedModelSummary": { + "type": "structure", + "members": { + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "The name of the Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "desiredModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.
The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.
", + "smithy.api#required": {} + } + }, + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "The number of model units allocated to the Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "desiredModelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "The number of model units that was requested to be allocated to the Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "The status of the Provisioned Throughput.
", + "smithy.api#required": {} + } + }, + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", + "traits": { + "smithy.api#documentation": "The duration for which the Provisioned Throughput was committed.
" + } + }, + "commitmentExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the commitment term of the Provisioned Throughput expires.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the Provisioned Throughput was created.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the Provisioned Throughput was last modified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of information about a Provisioned Throughput.
This data type is used in the following API operations:
" + } + }, + "com.amazonaws.bedrock#ProvisionedModelThroughputResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughput" + }, + { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughput" + }, + { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughput" + }, + { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputs" + }, + { + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughput" + } + ] + }, + "com.amazonaws.bedrock#PutAccountDataRetention": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#PutAccountDataRetentionRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#PutAccountDataRetentionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sets the account-wide data retention mode for Amazon Bedrock.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/data-retention" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#PutAccountDataRetentionRequest": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.bedrock#DataRetentionMode", + "traits": { + "smithy.api#documentation": "The data retention mode to set for the account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#PutAccountDataRetentionResponse": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.bedrock#DataRetentionMode", + "traits": { + "smithy.api#documentation": "The data retention mode set for the account.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the data retention mode was last updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#PutEnforcedGuardrailConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#PutEnforcedGuardrailConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#PutEnforcedGuardrailConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sets the account-level enforced guardrail configuration.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/enforcedGuardrailsConfiguration" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#PutEnforcedGuardrailConfigurationRequest": { + "type": "structure", + "members": { + "configId": { + "target": "com.amazonaws.bedrock#AccountEnforcedGuardrailConfigurationId", + "traits": { + "smithy.api#documentation": "Unique ID for the account enforced configuration.
" + } + }, + "guardrailInferenceConfig": { + "target": "com.amazonaws.bedrock#AccountEnforcedGuardrailInferenceInputConfiguration", + "traits": { + "smithy.api#documentation": "Account-level enforced guardrail input configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#PutEnforcedGuardrailConfigurationResponse": { + "type": "structure", + "members": { + "configId": { + "target": "com.amazonaws.bedrock#AccountEnforcedGuardrailConfigurationId", + "traits": { + "smithy.api#documentation": "Unique ID for the account enforced configuration.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp.
" + } + }, + "updatedBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the role used to update the configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#PutModelInvocationLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Set the configuration values for model invocation logging.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/logging/modelinvocations" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationRequest": { + "type": "structure", + "members": { + "loggingConfig": { + "target": "com.amazonaws.bedrock#LoggingConfig", + "traits": { + "smithy.api#documentation": "The logging configuration values to set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds a resource policy for a Bedrock resource.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/resource-policy" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "resource-policy", + "resource-policy-internal" + ] + } + }, + "com.amazonaws.bedrock#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrock#ResourcePolicyResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the Bedrock resource to which this resource policy applies.
", + "smithy.api#required": {} + } + }, + "resourcePolicy": { + "target": "com.amazonaws.bedrock#ResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "The JSON string representing the Bedrock resource policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrock#ResourcePolicyResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the Bedrock resource to which this resource policy applies.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#PutUseCaseForModelAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#PutUseCaseForModelAccessRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#PutUseCaseForModelAccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Put usecase for model access.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/use-case-for-model-access" + } + } + }, + "com.amazonaws.bedrock#PutUseCaseForModelAccessRequest": { + "type": "structure", + "members": { + "formData": { + "target": "com.amazonaws.bedrock#AcknowledgementFormDataBody", + "traits": { + "smithy.api#documentation": "Put customer profile Request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#PutUseCaseForModelAccessResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#QueryTransformationConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#QueryTransformationType", + "traits": { + "smithy.api#documentation": "The type of transformation to apply to the prompt.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for transforming the prompt.
" + } + }, + "com.amazonaws.bedrock#QueryTransformationType": { + "type": "enum", + "members": { + "QUERY_DECOMPOSITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERY_DECOMPOSITION" + } + } + } + }, + "com.amazonaws.bedrock#RAGConfig": { + "type": "union", + "members": { + "knowledgeBaseConfig": { + "target": "com.amazonaws.bedrock#KnowledgeBaseConfig", + "traits": { + "smithy.api#documentation": "Contains configuration details for knowledge base retrieval and response generation.
" + } + }, + "precomputedRagSourceConfig": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceConfig", + "traits": { + "smithy.api#documentation": "Contains configuration details about the RAG source used to generate inference response data for a Knowledge Base evaluation job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configuration details for retrieval of information and response generation.
" + } + }, + "com.amazonaws.bedrock#RAGStopSequences": { + "type": "list", + "member": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.bedrock#RFTBatchSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 16, + "max": 512 + } + } + }, + "com.amazonaws.bedrock#RFTConfig": { + "type": "structure", + "members": { + "graderConfig": { + "target": "com.amazonaws.bedrock#GraderConfig", + "traits": { + "smithy.api#documentation": "Configuration for the grader that evaluates model responses and provides reward signals during RFT training.
" + } + }, + "hyperParameters": { + "target": "com.amazonaws.bedrock#RFTHyperParameters", + "traits": { + "smithy.api#documentation": "Hyperparameters that control the reinforcement fine-tuning training process, including learning rate, batch size, and epoch count.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for reinforcement fine-tuning (RFT), including grader configuration and training hyperparameters.
" + } + }, + "com.amazonaws.bedrock#RFTEvalInterval": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrock#RFTHyperParameters": { + "type": "structure", + "members": { + "epochCount": { + "target": "com.amazonaws.bedrock#EpochCount", + "traits": { + "smithy.api#documentation": "Number of training epochs to run during reinforcement fine-tuning. Higher values may improve performance but increase training time.
" + } + }, + "batchSize": { + "target": "com.amazonaws.bedrock#RFTBatchSize", + "traits": { + "smithy.api#documentation": "Number of training samples processed in each batch during reinforcement fine-tuning (RFT) training. Larger batches may improve training stability.
" + } + }, + "learningRate": { + "target": "com.amazonaws.bedrock#RFTLearningRate", + "traits": { + "smithy.api#documentation": "Learning rate for the reinforcement fine-tuning. Controls how quickly the model adapts to reward signals.
" + } + }, + "maxPromptLength": { + "target": "com.amazonaws.bedrock#RFTMaxPromptLength", + "traits": { + "smithy.api#documentation": "Maximum length of input prompts during RFT training, measured in tokens. Longer prompts allow more context but increase memory usage and training-time.
" + } + }, + "trainingSamplePerPrompt": { + "target": "com.amazonaws.bedrock#RFTTrainingSamplePerPrompt", + "traits": { + "smithy.api#documentation": "Number of response samples generated per prompt during RFT training. More samples provide better reward signal estimation.
" + } + }, + "inferenceMaxTokens": { + "target": "com.amazonaws.bedrock#RFTInferenceMaxTokens", + "traits": { + "smithy.api#documentation": "Maximum number of tokens the model can generate in response to each prompt during RFT training.
" + } + }, + "reasoningEffort": { + "target": "com.amazonaws.bedrock#ReasoningEffort", + "traits": { + "smithy.api#documentation": "Level of reasoning effort applied during RFT training. Higher values may improve response quality but increase training time.
" + } + }, + "evalInterval": { + "target": "com.amazonaws.bedrock#RFTEvalInterval", + "traits": { + "smithy.api#documentation": "Interval between evaluation runs during RFT training, measured in training steps. More frequent evaluation provides better monitoring.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Hyperparameters for controlling the reinforcement fine-tuning training process, including learning settings and evaluation intervals.
" + } + }, + "com.amazonaws.bedrock#RFTInferenceMaxTokens": { + "type": "integer" + }, + "com.amazonaws.bedrock#RFTLearningRate": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 1.0E-7, + "max": 0.001 + } + } + }, + "com.amazonaws.bedrock#RFTMaxPromptLength": { + "type": "integer" + }, + "com.amazonaws.bedrock#RFTTrainingSamplePerPrompt": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 2, + "max": 16 + } + } + }, + "com.amazonaws.bedrock#RagConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#RAGConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#RateCard": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#DimensionalPriceRate" + } + }, + "com.amazonaws.bedrock#RatingScale": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#RatingScaleItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrock#RatingScaleItem": { + "type": "structure", + "members": { + "definition": { + "target": "com.amazonaws.bedrock#RatingScaleItemDefinition", + "traits": { + "smithy.api#documentation": "Defines the definition for one rating in a custom metric rating scale.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrock#RatingScaleItemValue", + "traits": { + "smithy.api#documentation": "Defines the value for one rating in a custom metric rating scale.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the value and corresponding definition for one rating in a custom metric rating scale.
" + } + }, + "com.amazonaws.bedrock#RatingScaleItemDefinition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrock#RatingScaleItemValue": { + "type": "union", + "members": { + "stringValue": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A string representing the value for a rating in a custom metric rating scale.
", + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "floatValue": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "A floating point number representing the value for a rating in a custom metric rating scale.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the value for one rating in a custom metric rating scale.
" + } + }, + "com.amazonaws.bedrock#ReasoningEffort": { + "type": "enum", + "members": { + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "low" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "medium" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "high" + } + } + } + }, + "com.amazonaws.bedrock#RegionAvailability": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_AVAILABLE" + } + } + } + }, + "com.amazonaws.bedrock#RegisterMarketplaceModelEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#RegisterMarketplaceModelEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#RegisterMarketplaceModelEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/marketplace-model/endpoints/{endpointIdentifier}/registration" + } + } + }, + "com.amazonaws.bedrock#RegisterMarketplaceModelEndpointRequest": { + "type": "structure", + "members": { + "endpointIdentifier": { + "target": "com.amazonaws.bedrock#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon SageMaker endpoint you want to register with Amazon Bedrock Marketplace.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "modelSourceIdentifier": { + "target": "com.amazonaws.bedrock#ModelSourceIdentifier", + "traits": { + "smithy.api#documentation": "The ARN of the model from Amazon Bedrock Marketplace that is deployed on the endpoint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#RegisterMarketplaceModelEndpointResponse": { + "type": "structure", + "members": { + "marketplaceModelEndpoint": { + "target": "com.amazonaws.bedrock#MarketplaceModelEndpoint", + "traits": { + "smithy.api#documentation": "Details about the registered endpoint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#RequestMetadataBaseFilters": { + "type": "structure", + "members": { + "equals": { + "target": "com.amazonaws.bedrock#RequestMetadataMap", + "traits": { + "smithy.api#documentation": "Include results where the key equals the value.
" + } + }, + "notEquals": { + "target": "com.amazonaws.bedrock#RequestMetadataMap", + "traits": { + "smithy.api#documentation": "Include results where the key does not equal the value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A mapping of a metadata key to a value that it should or should not equal.
" + } + }, + "com.amazonaws.bedrock#RequestMetadataFilters": { + "type": "union", + "members": { + "equals": { + "target": "com.amazonaws.bedrock#RequestMetadataMap", + "traits": { + "smithy.api#documentation": "Include results where the key equals the value.
" + } + }, + "notEquals": { + "target": "com.amazonaws.bedrock#RequestMetadataMap", + "traits": { + "smithy.api#documentation": "Include results where the key does not equal the value.
" + } + }, + "andAll": { + "target": "com.amazonaws.bedrock#RequestMetadataFiltersList", + "traits": { + "smithy.api#documentation": "Include results where all of the based filters match.
" + } + }, + "orAll": { + "target": "com.amazonaws.bedrock#RequestMetadataFiltersList", + "traits": { + "smithy.api#documentation": "Include results where any of the base filters match.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Rules for filtering invocation logs. A filter can be a mapping of a metadata key to a value that it should or should not equal (a base filter), or a list of base filters that are all applied with AND or OR logical operators
A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.
" + } + }, + "fieldsToExclude": { + "target": "com.amazonaws.bedrock#FieldsForReranking", + "traits": { + "smithy.api#documentation": "A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for selectively including or excluding metadata fields during the reranking process. This allows you to control which metadata attributes are considered when reordering search results.
" + } + }, + "com.amazonaws.bedrock#ResourceInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrock#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrock#ResourcePolicyDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20480 + }, + "smithy.api#pattern": "^[\t\n\r -ÿ]+$" + } + }, + "com.amazonaws.bedrock#ResourcePolicyResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.bedrock#GetResourcePolicy" + }, + { + "target": "com.amazonaws.bedrock#PutResourcePolicy" + } + ] + }, + "com.amazonaws.bedrock#ResourcePolicyResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.bedrock#RetrievalFilter": { + "type": "union", + "members": { + "equals": { + "target": "com.amazonaws.bedrock#FilterAttribute", + "traits": { + "smithy.api#documentation": "Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is 'cat': \"equals\": { \"key\": \"animal\", \"value\": \"cat\" }
Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.
The following example would return data sources that don't contain an animal attribute whose value is 'cat': \"notEquals\": { \"key\": \"animal\", \"value\": \"cat\" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than '1989': \"greaterThan\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to '1989': \"greaterThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to '1989': \"lessThan\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to '1989': \"lessThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either 'cat' or 'dog': \"in\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither 'cat' nor 'dog': \"notIn\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with 'ca' (for example, 'cat' or 'camel'). \"startsWith\": { \"key\": \"animal\", \"value\": \"ca\" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example, [\"dog\", \"cat\"]): \"listContains\": { \"key\": \"animals\", \"value\": \"cat\" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example, 'cat'): \"stringContains\": { \"key\": \"animal\", \"value\": \"at\" }
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example, [\"dog\", \"cat\"]): \"stringContains\": { \"key\": \"animals\", \"value\": \"at\" }
Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
" + } + }, + "orAll": { + "target": "com.amazonaws.bedrock#RetrievalFilterList", + "traits": { + "smithy.api#documentation": "Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the filters to use on the metadata attributes/fields in the knowledge base data sources before returning results.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#RetrievalFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#RetrievalFilter" + }, + "traits": { + "smithy.api#length": { + "min": 2 + } + } + }, + "com.amazonaws.bedrock#RetrieveAndGenerateConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#RetrieveAndGenerateType", + "traits": { + "smithy.api#documentation": "The type of resource that contains your data for retrieving information and generating responses.
If you choose to use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.
Contains configuration details for the knowledge base retrieval and response generation.
" + } + }, + "externalSourcesConfiguration": { + "target": "com.amazonaws.bedrock#ExternalSourcesRetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for the external source wrapper object in the retrieveAndGenerate function.
Contains configuration details for a knowledge base retrieval and response generation.
" + } + }, + "com.amazonaws.bedrock#RetrieveAndGenerateType": { + "type": "enum", + "members": { + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE" + } + }, + "EXTERNAL_SOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL_SOURCES" + } + } + } + }, + "com.amazonaws.bedrock#RetrieveConfig": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrock#KnowledgeBaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseRetrievalConfiguration": { + "target": "com.amazonaws.bedrock#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "Contains configuration details for knowledge base retrieval.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for retrieving information from a knowledge base.
" + } + }, + "com.amazonaws.bedrock#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" + } + }, + "com.amazonaws.bedrock#RoutingCriteria": { + "type": "structure", + "members": { + "responseQualityDifference": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The criteria's response quality difference.
", + "smithy.api#range": { + "min": 0, + "max": 100 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Routing criteria for a prompt router.
" + } + }, + "com.amazonaws.bedrock#S3Config": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.bedrock#BucketName", + "traits": { + "smithy.api#documentation": "S3 bucket name.
", + "smithy.api#required": {} + } + }, + "keyPrefix": { + "target": "com.amazonaws.bedrock#KeyPrefix", + "traits": { + "smithy.api#documentation": "S3 prefix.
" + } + } + }, + "traits": { + "smithy.api#documentation": "S3 configuration for storing log data.
" + } + }, + "com.amazonaws.bedrock#S3DataSource": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "The URI of the Amazon S3 data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 data source of the model to import.
" + } + }, + "com.amazonaws.bedrock#S3InputFormat": { + "type": "enum", + "members": { + "JSONL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSONL" + } + } + } + }, + "com.amazonaws.bedrock#S3ObjectDoc": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrock#kBS3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI location for the wrapper object of the document.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The unique wrapper object of the document from the S3 location.
" + } + }, + "com.amazonaws.bedrock#S3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?$" + } + }, + "com.amazonaws.bedrock#S3UriFolder": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/$" + } + }, + "com.amazonaws.bedrock#SageMakerEndpoint": { + "type": "structure", + "members": { + "initialInstanceCount": { + "target": "com.amazonaws.bedrock#InstanceCount", + "traits": { + "smithy.api#documentation": "The number of Amazon EC2 compute instances to deploy for initial endpoint creation.
", + "smithy.api#required": {} + } + }, + "instanceType": { + "target": "com.amazonaws.bedrock#InstanceType", + "traits": { + "smithy.api#documentation": "The Amazon EC2 compute instance type to deploy for hosting the model.
", + "smithy.api#required": {} + } + }, + "executionRole": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on Amazon EC2 compute instances or for batch transform jobs.
", + "smithy.api#required": {} + } + }, + "kmsEncryptionKey": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the Amazon EC2 compute instance that hosts the endpoint.
" + } + }, + "vpc": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC configuration for the endpoint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the configuration for a Amazon SageMaker endpoint.
" + } + }, + "com.amazonaws.bedrock#SageMakerFlowDefinitionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:flow-definition/.*$" + } + }, + "com.amazonaws.bedrock#SearchType": { + "type": "enum", + "members": { + "HYBRID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HYBRID" + } + }, + "SEMANTIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEMANTIC" + } + } + } + }, + "com.amazonaws.bedrock#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrock#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#SelectiveContentGuarding": { + "type": "structure", + "members": { + "system": { + "target": "com.amazonaws.bedrock#SelectiveGuardingMode", + "traits": { + "smithy.api#documentation": "Selective guarding mode for system prompts.\"
" + } + }, + "messages": { + "target": "com.amazonaws.bedrock#SelectiveGuardingMode", + "traits": { + "smithy.api#documentation": "Selective guarding mode for user messages.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Selective content guarding controls for enforced guardrails.
" + } + }, + "com.amazonaws.bedrock#SelectiveGuardingMode": { + "type": "enum", + "members": { + "SELECTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECTIVE" + } + }, + "COMPREHENSIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPREHENSIVE" + } + } + } + }, + "com.amazonaws.bedrock#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrock#ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "Returned if the service cannot complete the request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.bedrock#SortByProvisionedModels": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.bedrock#SortJobsBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.bedrock#SortModelsBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.bedrock#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.bedrock#StartAutomatedReasoningPolicyBuildWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StartAutomatedReasoningPolicyBuildWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StartAutomatedReasoningPolicyBuildWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceInUseException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a new build workflow for an Automated Reasoning policy. This initiates the process of analyzing source documents and generating policy rules, variables, and types.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowType}/start" + } + } + }, + "com.amazonaws.bedrock#StartAutomatedReasoningPolicyBuildWorkflowRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to start the build workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowType", + "traits": { + "smithy.api#documentation": "The type of build workflow to start (e.g., DOCUMENT_INGESTION for processing new documents, POLICY_REPAIR for fixing existing policies).
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.
", + "smithy.api#httpHeader": "x-amz-client-token", + "smithy.api#idempotencyToken": {} + } + }, + "sourceContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowSource", + "traits": { + "smithy.api#documentation": "The source content for the build workflow, such as documents to analyze or repair instructions for existing policies.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#StartAutomatedReasoningPolicyBuildWorkflowResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy.
", + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the newly started build workflow. Use this ID to track the workflow's progress and retrieve its results.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#StartAutomatedReasoningPolicyTestWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StartAutomatedReasoningPolicyTestWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StartAutomatedReasoningPolicyTestWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceInUseException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Initiates a test workflow to validate Automated Reasoning policy tests. The workflow executes the specified tests against the policy and generates validation results.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/test-workflows" + } + } + }, + "com.amazonaws.bedrock#StartAutomatedReasoningPolicyTestWorkflowRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy to test.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The build workflow identifier. The build workflow must show a COMPLETED status before running tests.
The list of test identifiers to run. If not provided, all tests for the policy are run.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#StartAutomatedReasoningPolicyTestWorkflowResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy for which the test workflow was started.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#Status": { + "type": "enum", + "members": { + "REGISTERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTERED" + } + }, + "INCOMPATIBLE_ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCOMPATIBLE_ENDPOINT" + } + } + } + }, + "com.amazonaws.bedrock#StatusDetails": { + "type": "structure", + "members": { + "validationDetails": { + "target": "com.amazonaws.bedrock#ValidationDetails", + "traits": { + "smithy.api#documentation": "The status details for the validation sub-task of the job.
" + } + }, + "dataProcessingDetails": { + "target": "com.amazonaws.bedrock#DataProcessingDetails", + "traits": { + "smithy.api#documentation": "The status details for the data processing sub-task of the job.
" + } + }, + "trainingDetails": { + "target": "com.amazonaws.bedrock#TrainingDetails", + "traits": { + "smithy.api#documentation": "The status details for the training sub-task of the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "For a Distillation job, the status details for sub-tasks of the job. Possible statuses for each sub-task include the following:
NotStarted
InProgress
Completed
Stopping
Stopped
Failed
Stops an advanced prompt optimization job that is in progress.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/advanced-prompt-optimization-jobs/{jobIdentifier}/stop" + } + } + }, + "com.amazonaws.bedrock#StopAdvancedPromptOptimizationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#AdvancedPromptOptimizationJobIdentifier", + "traits": { + "smithy.api#documentation": "The ARN or ID of the advanced prompt optimization job to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stop Advanced Prompt Optimization Job Request
", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#StopAdvancedPromptOptimizationJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Stop Advanced Prompt Optimization Job Response
", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#StopEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StopEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StopEvaluationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops an evaluation job that is current being created or running.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/evaluation-job/{jobIdentifier}/stop" + } + } + }, + "com.amazonaws.bedrock#StopEvaluationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the evaluation job you want to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#StopEvaluationJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#StopModelCustomizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StopModelCustomizationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StopModelCustomizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/model-customization-jobs/{jobIdentifier}/stop" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#StopModelCustomizationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", + "traits": { + "smithy.api#documentation": "Job identifier of the job to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#StopModelCustomizationJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#StopModelInvocationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StopModelInvocationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StopModelInvocationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/model-invocation-job/{jobIdentifier}/stop" + } + } + }, + "com.amazonaws.bedrock#StopModelInvocationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelInvocationJobIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the batch inference job to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#StopModelInvocationJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrock#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.bedrock#SubscriptionResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateFoundationModelAgreement" + }, + { + "target": "com.amazonaws.bedrock#DeleteFoundationModelAgreement" + }, + { + "target": "com.amazonaws.bedrock#GetFoundationModelAvailability" + }, + { + "target": "com.amazonaws.bedrock#ListFoundationModelAgreementOffers" + } + ] + }, + "com.amazonaws.bedrock#SupportTerm": { + "type": "structure", + "members": { + "refundPolicyDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Describes the refund policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a support term.
" + } + }, + "com.amazonaws.bedrock#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrock#TagKey", + "traits": { + "smithy.api#documentation": "Key for the tag.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrock#TagValue", + "traits": { + "smithy.api#documentation": "Value for the tag.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Definition of the key/value pair for a tag.
" + } + }, + "com.amazonaws.bedrock#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrock#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrock#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrock#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/tagResource" + } + } + }, + "com.amazonaws.bedrock#TagResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.bedrock#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to associate with the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrock#TaggableResourcesArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "(^[a-zA-Z0-9][a-zA-Z0-9\\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported)/[a-z0-9]{12}$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:automated-reasoning-policy/[a-zA-Z0-9]+(:[a-zA-Z0-9]+)?$)|(:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model|async-invoke|provisioned-model-v2|provisioned-model-reservation|prompt-router|custom-model-deployment)/[a-z0-9]{12}$)))" + } + }, + "com.amazonaws.bedrock#TaggingResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#ListTagsForResource" + }, + { + "target": "com.amazonaws.bedrock#TagResource" + }, + { + "target": "com.amazonaws.bedrock#UntagResource" + } + ] + }, + "com.amazonaws.bedrock#TeacherModelConfig": { + "type": "structure", + "members": { + "teacherModelIdentifier": { + "target": "com.amazonaws.bedrock#TeacherModelIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the teacher model.
", + "smithy.api#required": {} + } + }, + "maxResponseLengthForInference": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens requested when the customization job invokes the teacher model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a teacher model used for model customization.
" + } + }, + "com.amazonaws.bedrock#TeacherModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+$)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})$" + } + }, + "com.amazonaws.bedrock#Temperature": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#TermDetails": { + "type": "structure", + "members": { + "usageBasedPricingTerm": { + "target": "com.amazonaws.bedrock#PricingTerm", + "traits": { + "smithy.api#required": {} + } + }, + "legalTerm": { + "target": "com.amazonaws.bedrock#LegalTerm", + "traits": { + "smithy.api#documentation": "Describes the legal terms.
", + "smithy.api#required": {} + } + }, + "supportTerm": { + "target": "com.amazonaws.bedrock#SupportTerm", + "traits": { + "smithy.api#documentation": "Describes the support terms.
", + "smithy.api#required": {} + } + }, + "validityTerm": { + "target": "com.amazonaws.bedrock#ValidityTerm", + "traits": { + "smithy.api#documentation": "Describes the validity terms.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the usage terms of an offer.
" + } + }, + "com.amazonaws.bedrock#TextInferenceConfig": { + "type": "structure", + "members": { + "temperature": { + "target": "com.amazonaws.bedrock#Temperature", + "traits": { + "smithy.api#documentation": "Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrock#TopP", + "traits": { + "smithy.api#documentation": "A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.
" + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrock#MaxTokens", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitrary values, for actual values consult the limits defined by your specific model.
" + } + }, + "stopSequences": { + "target": "com.amazonaws.bedrock#RAGStopSequences", + "traits": { + "smithy.api#documentation": "A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitrary values, for actual values consult the limits defined by your specific model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for text generation using a language model via the RetrieveAndGenerate function.
The number of requests exceeds the limit. Resubmit your request later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bedrock#Timestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.bedrock#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + }, + "resourceName": { + "target": "com.amazonaws.bedrock#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The name of the resource with too many tags.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrock#TopP": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#TrainingDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI where the training data is stored.
" + } + }, + "invocationLogsConfig": { + "target": "com.amazonaws.bedrock#InvocationLogsConfig", + "traits": { + "smithy.api#documentation": "Settings for using invocation logs to customize a model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "S3 Location of the training data.
" + } + }, + "com.amazonaws.bedrock#TrainingDetails": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#JobStatusDetails", + "traits": { + "smithy.api#documentation": "The status of the training sub-task of the job.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the training sub-task of the job.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The latest update to the training sub-task of the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "For a Distillation job, the status details for the training sub-task of the job.
" + } + }, + "com.amazonaws.bedrock#TrainingMetrics": { + "type": "structure", + "members": { + "trainingLoss": { + "target": "com.amazonaws.bedrock#MetricFloat", + "traits": { + "smithy.api#documentation": "Loss metric associated with the custom job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metrics associated with the custom job.
" + } + }, + "com.amazonaws.bedrock#TrainingResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateModelCustomizationJob" + }, + { + "target": "com.amazonaws.bedrock#GetModelCustomizationJob" + }, + { + "target": "com.amazonaws.bedrock#ListModelCustomizationJobs" + }, + { + "target": "com.amazonaws.bedrock#StopModelCustomizationJob" + } + ] + }, + "com.amazonaws.bedrock#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/untagResource" + } + } + }, + "com.amazonaws.bedrock#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.bedrock#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to untag.
", + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.bedrock#TagKeyList", + "traits": { + "smithy.api#documentation": "Tag keys of the tags to remove from the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Automated Reasoning policy with new rules, variables, or configuration. This creates a new version of the policy while preserving the previous version.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/automated-reasoning-policies/{policyArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyAnnotations": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyAnnotationsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyAnnotationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the annotations for an Automated Reasoning policy build workflow. This allows you to modify extracted rules, variables, and types before finalizing the policy.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/annotations" + } + } + }, + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyAnnotationsRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy whose annotations you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow whose annotations you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "annotations": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationList", + "traits": { + "smithy.api#documentation": "The updated annotations containing modified rules, variables, and types for the policy.
", + "smithy.api#required": {} + } + }, + "lastUpdatedAnnotationSetHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "The hash value of the annotation set that you're updating. This is used for optimistic concurrency control to prevent conflicting updates.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyAnnotationsResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy.
", + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the build workflow.
", + "smithy.api#required": {} + } + }, + "annotationSetHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "The new hash value representing the updated state of the annotations.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the annotations were updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy to update. This must be the ARN of a draft policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyDefinition": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition", + "traits": { + "smithy.api#documentation": "The updated policy definition containing the formal logic rules, variables, and types.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", + "traits": { + "smithy.api#documentation": "The updated name for the Automated Reasoning policy.
" + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription", + "traits": { + "smithy.api#documentation": "The updated description for the Automated Reasoning policy.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated policy.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", + "traits": { + "smithy.api#documentation": "The updated name of the policy.
", + "smithy.api#required": {} + } + }, + "definitionHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "The hash of the updated policy definition.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the policy was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyTestCase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyTestCaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyTestCaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceInUseException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Automated Reasoning policy test. You can modify the content, query, expected result, and confidence threshold.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/automated-reasoning-policies/{policyArn}/test-cases/{testCaseId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyTestCaseRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the test to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "guardContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestGuardContent", + "traits": { + "smithy.api#documentation": "The updated content to be validated by the Automated Reasoning policy.
", + "smithy.api#required": {} + } + }, + "queryContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestQueryContent", + "traits": { + "smithy.api#documentation": "The updated input query or prompt that generated the content.
" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the test was last updated. This is used as a concurrency token to prevent conflicting modifications.
", + "smithy.api#required": {} + } + }, + "expectedAggregatedFindingsResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckResult", + "traits": { + "smithy.api#documentation": "The updated expected result of the Automated Reasoning check.
", + "smithy.api#required": {} + } + }, + "confidenceThreshold": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationConfidence", + "traits": { + "smithy.api#documentation": "The updated minimum confidence level for logic validation. If null is provided, the threshold will be removed.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyTestCaseResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy that contains the updated test.
", + "smithy.api#required": {} + } + }, + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated test.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#UpdateCustomModelDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateCustomModelDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateCustomModelDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a custom model deployment with a new custom model. This allows you to deploy updated models without creating new deployment endpoints.
", + "smithy.api#http": { + "code": 202, + "method": "PATCH", + "uri": "/model-customization/custom-model-deployments/{customModelDeploymentIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#UpdateCustomModelDeploymentRequest": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "ARN of the new custom model to deploy. This replaces the currently deployed model.
", + "smithy.api#required": {} + } + }, + "customModelDeploymentIdentifier": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentIdentifier", + "traits": { + "smithy.api#documentation": "Identifier of the custom model deployment to update with the new custom model.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#UpdateCustomModelDeploymentResponse": { + "type": "structure", + "members": { + "customModelDeploymentArn": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentArn", + "traits": { + "smithy.api#documentation": "ARN of the custom model deployment being updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#UpdateGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateGuardrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a guardrail with the values you specify.
Specify a name and optional description.
Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields.
Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic.
Give a name and description so that the guardrail can properly identify the topic.
Specify DENY in the type field.
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list.
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.
Specify the category in the type field.
Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig.
(Optional) For security, include the ARN of a KMS key in the kmsKeyId field.
The unique identifier of the guardrail. This can be an ID or the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", + "traits": { + "smithy.api#documentation": "A name for the guardrail.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "A description of the guardrail.
" + } + }, + "topicPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailTopicPolicyConfig", + "traits": { + "smithy.api#documentation": "The topic policy to configure for the guardrail.
" + } + }, + "contentPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContentPolicyConfig", + "traits": { + "smithy.api#documentation": "The content policy to configure for the guardrail.
" + } + }, + "wordPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailWordPolicyConfig", + "traits": { + "smithy.api#documentation": "The word policy to configure for the guardrail.
" + } + }, + "sensitiveInformationPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig", + "traits": { + "smithy.api#documentation": "The sensitive information policy to configure for the guardrail.
" + } + }, + "contextualGroundingPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig", + "traits": { + "smithy.api#documentation": "The contextual grounding policy configuration used to update a guardrail.
" + } + }, + "automatedReasoningPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailAutomatedReasoningPolicyConfig", + "traits": { + "smithy.api#documentation": "Updated configuration for Automated Reasoning policies associated with the guardrail.
" + } + }, + "crossRegionConfig": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionConfig", + "traits": { + "smithy.api#documentation": "The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
For more information, see the Amazon Bedrock User Guide.
" + } + }, + "blockedInputMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "The message to return when the guardrail blocks a prompt.
", + "smithy.api#required": {} + } + }, + "blockedOutputsMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "The message to return when the guardrail blocks a model response.
", + "smithy.api#required": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key with which to encrypt the guardrail.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#UpdateGuardrailResponse": { + "type": "structure", + "members": { + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail
", + "smithy.api#required": {} + } + }, + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", + "traits": { + "smithy.api#documentation": "The ARN of the guardrail.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailDraftVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the guardrail was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#UpdateMarketplaceModelEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateMarketplaceModelEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateMarketplaceModelEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/marketplace-model/endpoints/{endpointArn}" + } + } + }, + "com.amazonaws.bedrock#UpdateMarketplaceModelEndpointRequest": { + "type": "structure", + "members": { + "endpointArn": { + "target": "com.amazonaws.bedrock#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "endpointConfig": { + "target": "com.amazonaws.bedrock#EndpointConfig", + "traits": { + "smithy.api#documentation": "The new configuration for the endpoint, including the number and type of instances to use.
", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because Amazon Web Services SDKs automatically generate it for you and set this parameter. If you're not using the Amazon Web Services SDK or the CLI, you must provide this token or the action will fail.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#UpdateMarketplaceModelEndpointResponse": { + "type": "structure", + "members": { + "marketplaceModelEndpoint": { + "target": "com.amazonaws.bedrock#MarketplaceModelEndpoint", + "traits": { + "smithy.api#documentation": "Details about the updated endpoint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#UpdateProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/provisioned-model-throughput/{provisionedModelId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#UpdateProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) or name of the Provisioned Throughput to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "desiredProvisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "The new name for this Provisioned Throughput.
" + } + }, + "desiredModelId": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new model to associate with this Provisioned Throughput. You can't specify this field if this Provisioned Throughput is associated with a base model.
If this Provisioned Throughput is associated with a custom model, you can specify one of the following options:
The base model from which the custom model was customized.
Another custom model that was customized from the same base model as the custom model.
Information about the validators.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Array of up to 10 validators.
" + } + }, + "com.amazonaws.bedrock#ValidationDetails": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#JobStatusDetails", + "traits": { + "smithy.api#documentation": "The status of the validation sub-task of the job.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the validation sub-task of the job.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The latest update to the validation sub-task of the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "For a Distillation job, the status details for the validation sub-task of the job.
" + } + }, + "com.amazonaws.bedrock#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrock#ValidationMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ValidatorMetric" + } + }, + "com.amazonaws.bedrock#Validator": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI where the validation data is stored.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a validator.
" + } + }, + "com.amazonaws.bedrock#ValidatorMetric": { + "type": "structure", + "members": { + "validationLoss": { + "target": "com.amazonaws.bedrock#MetricFloat", + "traits": { + "smithy.api#documentation": "The validation loss associated with this validator.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The metric for the validator.
" + } + }, + "com.amazonaws.bedrock#Validators": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#Validator" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrock#ValidityTerm": { + "type": "structure", + "members": { + "agreementDuration": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Describes the agreement duration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the validity terms.
" + } + }, + "com.amazonaws.bedrock#VectorSearchBedrockRerankingConfiguration": { + "type": "structure", + "members": { + "modelConfiguration": { + "target": "com.amazonaws.bedrock#VectorSearchBedrockRerankingModelConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model.
", + "smithy.api#required": {} + } + }, + "numberOfRerankedResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to rerank. This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrock#MetadataConfigurationForReranking", + "traits": { + "smithy.api#documentation": "Configuration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results. This enables more sophisticated relevance ranking using large language models.
" + } + }, + "com.amazonaws.bedrock#VectorSearchBedrockRerankingModelConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#BedrockRerankingModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering.
", + "smithy.api#required": {} + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrock#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "A list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for the Amazon Bedrock foundation model used for reranking vector search results. This specifies which model to use and any additional parameters required by the model.
" + } + }, + "com.amazonaws.bedrock#VectorSearchRerankingConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#VectorSearchRerankingConfigurationType", + "traits": { + "smithy.api#documentation": "The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.
", + "smithy.api#required": {} + } + }, + "bedrockRerankingConfiguration": { + "target": "com.amazonaws.bedrock#VectorSearchBedrockRerankingConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for reranking vector search results to improve relevance. Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.
" + } + }, + "com.amazonaws.bedrock#VectorSearchRerankingConfigurationType": { + "type": "enum", + "members": { + "BEDROCK_RERANKING_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_RERANKING_MODEL" + } + } + } + }, + "com.amazonaws.bedrock#VpcConfig": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.bedrock#SubnetIds", + "traits": { + "smithy.api#documentation": "An array of IDs for each subnet in the VPC to use.
", + "smithy.api#required": {} + } + }, + "securityGroupIds": { + "target": "com.amazonaws.bedrock#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "An array of IDs for each security group in the VPC to use.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of a virtual private cloud (VPC). For more information, see Protect your data using Amazon Virtual Private Cloud and Amazon Web Services PrivateLink.
" + } + }, + "com.amazonaws.bedrock#kBS3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$" + } + } + } +} \ No newline at end of file diff --git a/codegen/aws-models/connecthealth.json b/codegen/aws-models/connecthealth.json index c62c6bb..0ac1514 100644 --- a/codegen/aws-models/connecthealth.json +++ b/codegen/aws-models/connecthealth.json @@ -2922,7 +2922,7 @@ "com.amazonaws.connecthealth#SensitiveMarkdownString": { "type": "string", "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9\\s\\*_\\-#\\[\\]\\(\\)\\.,:;!?'\"`<>~/]+$", + "smithy.api#pattern": "^[\\p{L}\\p{N}\\s\\*_\\-#\\[\\]\\(\\)\\.,:;!?'\"`<>~/|+=&%@\\\\{}^]+$", "smithy.api#sensitive": {} } }, diff --git a/codegen/aws-models/guardduty.json b/codegen/aws-models/guardduty.json new file mode 100644 index 0000000..1e282a2 --- /dev/null +++ b/codegen/aws-models/guardduty.json @@ -0,0 +1,22027 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.guardduty#AcceptAdministratorInvitation": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#AcceptAdministratorInvitationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#AcceptAdministratorInvitationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Accepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/administrator", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#AcceptAdministratorInvitationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AdministratorId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The account ID of the GuardDuty administrator account whose invitation you're accepting.
", + "smithy.api#jsonName": "administratorId", + "smithy.api#required": {} + } + }, + "InvitationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The value that is used to validate the administrator account to the member account.
", + "smithy.api#jsonName": "invitationId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#AcceptAdministratorInvitationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#AcceptInvitation": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#AcceptInvitationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#AcceptInvitationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use AcceptAdministratorInvitation instead" + }, + "smithy.api#documentation": "Accepts the invitation to be monitored by a GuardDuty administrator account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/master", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#AcceptInvitationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The account ID of the GuardDuty administrator account whose invitation you're accepting.
", + "smithy.api#jsonName": "masterId", + "smithy.api#required": {} + } + }, + "InvitationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The value that is used to validate the administrator account to the member account.
", + "smithy.api#jsonName": "invitationId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This input is deprecated, use AcceptAdministratorInvitationRequest instead" + }, + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#AcceptInvitationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#deprecated": { + "message": "This output is deprecated, use AcceptAdministratorInvitationResponse instead" + }, + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#AccessControlList": { + "type": "structure", + "members": { + "AllowsPublicReadAccess": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "A value that indicates whether public read access for the bucket is enabled through an Access Control List (ACL).
", + "smithy.api#jsonName": "allowsPublicReadAccess" + } + }, + "AllowsPublicWriteAccess": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "A value that indicates whether public write access for the bucket is enabled through an Access Control List (ACL).
", + "smithy.api#jsonName": "allowsPublicWriteAccess" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the current access control policies for the bucket.
" + } + }, + "com.amazonaws.guardduty#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error type.
", + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "An access denied exception object.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.guardduty#AccessKey": { + "type": "structure", + "members": { + "PrincipalId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Principal ID of the user.
", + "smithy.api#jsonName": "principalId" + } + }, + "UserName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Name of the user.
", + "smithy.api#jsonName": "userName" + } + }, + "UserType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Type of the user.
", + "smithy.api#jsonName": "userType" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the access keys.
" + } + }, + "com.amazonaws.guardduty#AccessKeyDetails": { + "type": "structure", + "members": { + "AccessKeyId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The access key ID of the user.
", + "smithy.api#jsonName": "accessKeyId" + } + }, + "PrincipalId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The principal ID of the user.
", + "smithy.api#jsonName": "principalId" + } + }, + "UserName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the user.
", + "smithy.api#jsonName": "userName" + } + }, + "UserType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The type of the user.
", + "smithy.api#jsonName": "userType" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the access keys.
" + } + }, + "com.amazonaws.guardduty#Account": { + "type": "structure", + "members": { + "Uid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Web Services account ID within which the activity took place. This may differ from the account that owns the user identity.
", + "smithy.api#jsonName": "uid", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Name of the member's Amazon Web Services account.
", + "smithy.api#jsonName": "account" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon Web Services account within which the activity took place.
" + } + }, + "com.amazonaws.guardduty#AccountDetail": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The member account ID.
", + "smithy.api#jsonName": "accountId", + "smithy.api#required": {} + } + }, + "Email": { + "target": "com.amazonaws.guardduty#Email", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The email address of the member account. The following list includes the rules for a valid email address:
The email address must be a minimum of 6 and a maximum of 64 characters long.
All characters must be 7-bit ASCII characters.
There must be one and only one @ symbol, which separates the local name from the domain name.
The local name can't contain any of the following characters:
whitespace, \" ' ( ) < > [ ] : ' , \\ | % &
The local name can't begin with a dot (.).
The domain name can consist of only the characters [a-z], [A-Z], [0-9], hyphen (-), or dot (.).
The domain name can't begin or end with a dot (.) or hyphen (-).
The domain name must contain at least one dot.
Contains information about the account.
" + } + }, + "com.amazonaws.guardduty#AccountDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#AccountDetail" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#AccountFreeTrialInfo": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The account identifier of the GuardDuty member account.
", + "smithy.api#jsonName": "accountId" + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourcesFreeTrial", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Describes the data source enabled for the GuardDuty member account.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#FreeTrialFeatureConfigurationsResults", + "traits": { + "smithy.api#documentation": "A list of features enabled for the GuardDuty account.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides details of the GuardDuty member account that uses a free trial service.
" + } + }, + "com.amazonaws.guardduty#AccountFreeTrialInfos": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#AccountFreeTrialInfo" + } + }, + "com.amazonaws.guardduty#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + } + } + }, + "com.amazonaws.guardduty#AccountIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#AccountLevelPermissions": { + "type": "structure", + "members": { + "BlockPublicAccess": { + "target": "com.amazonaws.guardduty#BlockPublicAccess", + "traits": { + "smithy.api#documentation": "Describes the S3 Block Public Access settings of the bucket's parent account.
", + "smithy.api#jsonName": "blockPublicAccess" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the account level permissions on the S3 bucket.
" + } + }, + "com.amazonaws.guardduty#AccountStatistics": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account.
", + "smithy.api#jsonName": "accountId" + } + }, + "LastGeneratedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the finding for this account was last generated.
", + "smithy.api#jsonName": "lastGeneratedAt" + } + }, + "TotalFindings": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The total number of findings associated with an account.
", + "smithy.api#jsonName": "totalFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a list of map of accounts with the number of findings associated with each account.
" + } + }, + "com.amazonaws.guardduty#Action": { + "type": "structure", + "members": { + "ActionType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The GuardDuty finding activity type.
", + "smithy.api#jsonName": "actionType" + } + }, + "AwsApiCallAction": { + "target": "com.amazonaws.guardduty#AwsApiCallAction", + "traits": { + "smithy.api#documentation": "Information about the AWS_API_CALL action described in this finding.
", + "smithy.api#jsonName": "awsApiCallAction" + } + }, + "DnsRequestAction": { + "target": "com.amazonaws.guardduty#DnsRequestAction", + "traits": { + "smithy.api#documentation": "Information about the DNS_REQUEST action described in this finding.
", + "smithy.api#jsonName": "dnsRequestAction" + } + }, + "NetworkConnectionAction": { + "target": "com.amazonaws.guardduty#NetworkConnectionAction", + "traits": { + "smithy.api#documentation": "Information about the NETWORK_CONNECTION action described in this finding.
", + "smithy.api#jsonName": "networkConnectionAction" + } + }, + "PortProbeAction": { + "target": "com.amazonaws.guardduty#PortProbeAction", + "traits": { + "smithy.api#documentation": "Information about the PORT_PROBE action described in this finding.
", + "smithy.api#jsonName": "portProbeAction" + } + }, + "KubernetesApiCallAction": { + "target": "com.amazonaws.guardduty#KubernetesApiCallAction", + "traits": { + "smithy.api#documentation": "Information about the Kubernetes API call action described in this finding.
", + "smithy.api#jsonName": "kubernetesApiCallAction" + } + }, + "KubernetesPermissionCheckedDetails": { + "target": "com.amazonaws.guardduty#KubernetesPermissionCheckedDetails", + "traits": { + "smithy.api#documentation": "Information whether the user has the permission to use a specific Kubernetes API.
", + "smithy.api#jsonName": "kubernetesPermissionCheckedDetails" + } + }, + "KubernetesRoleBindingDetails": { + "target": "com.amazonaws.guardduty#KubernetesRoleBindingDetails", + "traits": { + "smithy.api#documentation": "Information about the role binding that grants the permission defined in a Kubernetes role.
", + "smithy.api#jsonName": "kubernetesRoleBindingDetails" + } + }, + "KubernetesRoleDetails": { + "target": "com.amazonaws.guardduty#KubernetesRoleDetails", + "traits": { + "smithy.api#documentation": "Information about the Kubernetes role name and role type.
", + "smithy.api#jsonName": "kubernetesRoleDetails" + } + }, + "RdsLoginAttemptAction": { + "target": "com.amazonaws.guardduty#RdsLoginAttemptAction", + "traits": { + "smithy.api#documentation": "Information about RDS_LOGIN_ATTEMPT action described in this finding.
Contains information about actions.
" + } + }, + "com.amazonaws.guardduty#Actor": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "ID of the threat actor.
", + "smithy.api#jsonName": "id", + "smithy.api#required": {} + } + }, + "User": { + "target": "com.amazonaws.guardduty#User", + "traits": { + "smithy.api#documentation": "Contains information about the user credentials used by the threat actor.
", + "smithy.api#jsonName": "user" + } + }, + "Session": { + "target": "com.amazonaws.guardduty#Session", + "traits": { + "smithy.api#documentation": "Contains information about the user session where the activity initiated.
", + "smithy.api#jsonName": "session" + } + }, + "Process": { + "target": "com.amazonaws.guardduty#ActorProcess", + "traits": { + "smithy.api#documentation": "Contains information about the process associated with the threat actor. This includes details such as process name, path, execution time, and unique identifiers that help track the actor's activities within the system.
", + "smithy.api#jsonName": "process" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the actors involved in an attack sequence.
" + } + }, + "com.amazonaws.guardduty#ActorIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, + "com.amazonaws.guardduty#ActorProcess": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#ProcessName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the process as it appears in the system.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Path": { + "target": "com.amazonaws.guardduty#ProcessPath", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The full file path to the process executable on the system.
", + "smithy.api#jsonName": "path", + "smithy.api#required": {} + } + }, + "Sha256": { + "target": "com.amazonaws.guardduty#ProcessSha256", + "traits": { + "smithy.api#documentation": "The SHA256 hash of the process executable file, which can be used for identification and verification purposes.
", + "smithy.api#jsonName": "sha256" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a process involved in a GuardDuty finding, including process identification, execution details, and file information.
" + } + }, + "com.amazonaws.guardduty#Actors": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Actor" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, + "com.amazonaws.guardduty#AdditionalInfo": { + "type": "structure", + "members": { + "VersionId": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The version ID of the S3 object, if applicable.
", + "smithy.api#jsonName": "versionId" + } + }, + "DeviceName": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The device name of the EBS volume, if applicable.
", + "smithy.api#jsonName": "deviceName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains additional information about the detected threat.
" + } + }, + "com.amazonaws.guardduty#AdditionalSequenceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FindingType" + } + }, + "com.amazonaws.guardduty#AddonDetails": { + "type": "structure", + "members": { + "AddonVersion": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Version of the installed EKS add-on.
", + "smithy.api#jsonName": "addonVersion" + } + }, + "AddonStatus": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Status of the installed EKS add-on.
", + "smithy.api#jsonName": "addonStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the installed EKS add-on (GuardDuty security agent).
" + } + }, + "com.amazonaws.guardduty#AdminAccount": { + "type": "structure", + "members": { + "AdminAccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID for the account.
", + "smithy.api#jsonName": "adminAccountId" + } + }, + "AdminStatus": { + "target": "com.amazonaws.guardduty#AdminStatus", + "traits": { + "smithy.api#documentation": "Indicates whether the account is enabled as the delegated administrator.
", + "smithy.api#jsonName": "adminStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "The account within the organization specified as the GuardDuty delegated administrator.
" + } + }, + "com.amazonaws.guardduty#AdminAccounts": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#AdminAccount" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.guardduty#AdminStatus": { + "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" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#Administrator": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the account used as the administrator account.
", + "smithy.api#jsonName": "accountId" + } + }, + "InvitationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The value that is used to validate the administrator account to the member account.
", + "smithy.api#jsonName": "invitationId" + } + }, + "RelationshipStatus": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The status of the relationship between the administrator and member accounts.
", + "smithy.api#jsonName": "relationshipStatus" + } + }, + "InvitedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The timestamp when the invitation was sent.
", + "smithy.api#jsonName": "invitedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the administrator account and invitation.
" + } + }, + "com.amazonaws.guardduty#AffectedResources": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#AgentDetails": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Version of the installed GuardDuty security agent.
", + "smithy.api#jsonName": "version" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the installed GuardDuty security agent.
" + } + }, + "com.amazonaws.guardduty#Anomaly": { + "type": "structure", + "members": { + "Profiles": { + "target": "com.amazonaws.guardduty#AnomalyProfiles", + "traits": { + "smithy.api#documentation": "Information about the types of profiles.
", + "smithy.api#jsonName": "profiles" + } + }, + "Unusual": { + "target": "com.amazonaws.guardduty#AnomalyUnusual", + "traits": { + "smithy.api#documentation": "Information about the behavior of the anomalies.
", + "smithy.api#jsonName": "unusual" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the anomalies.
" + } + }, + "com.amazonaws.guardduty#AnomalyObject": { + "type": "structure", + "members": { + "ProfileType": { + "target": "com.amazonaws.guardduty#ProfileType", + "traits": { + "smithy.api#documentation": "The type of behavior of the profile.
", + "smithy.api#jsonName": "profileType" + } + }, + "ProfileSubtype": { + "target": "com.amazonaws.guardduty#ProfileSubtype", + "traits": { + "smithy.api#documentation": "The frequency of the anomaly.
", + "smithy.api#jsonName": "profileSubtype" + } + }, + "Observations": { + "target": "com.amazonaws.guardduty#Observations", + "traits": { + "smithy.api#documentation": "The recorded value.
", + "smithy.api#jsonName": "observations" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the unusual anomalies.
" + } + }, + "com.amazonaws.guardduty#AnomalyProfileFeatureObjects": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#AnomalyObject" + } + }, + "com.amazonaws.guardduty#AnomalyProfileFeatures": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#AnomalyProfileFeatureObjects" + } + }, + "com.amazonaws.guardduty#AnomalyProfiles": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#AnomalyProfileFeatures" + } + }, + "com.amazonaws.guardduty#AnomalyUnusual": { + "type": "structure", + "members": { + "Behavior": { + "target": "com.amazonaws.guardduty#Behavior", + "traits": { + "smithy.api#documentation": "The behavior of the anomalous activity that caused GuardDuty to generate the finding.
", + "smithy.api#jsonName": "behavior" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the behavior of the anomaly that is new to GuardDuty.
" + } + }, + "com.amazonaws.guardduty#AnomalyUnusualBehaviorFeature": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#AnomalyObject" + } + }, + "com.amazonaws.guardduty#ArchiveFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ArchiveFindingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ArchiveFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Archives GuardDuty findings that are specified by the list of finding IDs.
Only the administrator account can archive findings. Member accounts don't have permission to archive findings from their accounts.
The ID of the detector that specifies the GuardDuty service whose findings you want to archive.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The IDs of the findings that you want to archive.
", + "smithy.api#jsonName": "findingIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ArchiveFindingsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#AutoEnableMembers": { + "type": "enum", + "members": { + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.guardduty#AutonomousSystem": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Name associated with the Autonomous System (AS).
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Number": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique number that identifies the Autonomous System (AS).
", + "smithy.api#jsonName": "number", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Autonomous System (AS) associated with the network endpoints involved in an attack sequence.
" + } + }, + "com.amazonaws.guardduty#AutoscalingAutoScalingGroup": { + "type": "structure", + "members": { + "Ec2InstanceUids": { + "target": "com.amazonaws.guardduty#Ec2InstanceUids", + "traits": { + "smithy.api#documentation": "A list of unique identifiers for the compromised Amazon EC2 instances that are part of the same Auto Scaling Group.
", + "smithy.api#jsonName": "ec2InstanceUids" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Auto Scaling Group involved in a GuardDuty finding, including unique identifiers of the Amazon EC2 instances.
" + } + }, + "com.amazonaws.guardduty#AwsApiCallAction": { + "type": "structure", + "members": { + "Api": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services API name.
", + "smithy.api#jsonName": "api" + } + }, + "CallerType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services API caller type.
", + "smithy.api#jsonName": "callerType" + } + }, + "DomainDetails": { + "target": "com.amazonaws.guardduty#DomainDetails", + "traits": { + "smithy.api#documentation": "The domain information for the Amazon Web Services API call.
", + "smithy.api#jsonName": "domainDetails" + } + }, + "ErrorCode": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error code of the failed Amazon Web Services API action.
", + "smithy.api#jsonName": "errorCode" + } + }, + "UserAgent": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The agent through which the API request was made.
", + "smithy.api#jsonName": "userAgent" + } + }, + "RemoteIpDetails": { + "target": "com.amazonaws.guardduty#RemoteIpDetails", + "traits": { + "smithy.api#documentation": "The remote IP information of the connection that initiated the Amazon Web Services API call.
", + "smithy.api#jsonName": "remoteIpDetails" + } + }, + "ServiceName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service name whose API was invoked.
", + "smithy.api#jsonName": "serviceName" + } + }, + "RemoteAccountDetails": { + "target": "com.amazonaws.guardduty#RemoteAccountDetails", + "traits": { + "smithy.api#documentation": "The details of the Amazon Web Services account that made the API call. This field appears if the call was made from outside your account.
", + "smithy.api#jsonName": "remoteAccountDetails" + } + }, + "AffectedResources": { + "target": "com.amazonaws.guardduty#AffectedResources", + "traits": { + "smithy.api#documentation": "The details of the Amazon Web Services account that made the API call. This field identifies the resources that were affected by this API call.
", + "smithy.api#jsonName": "affectedResources" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the API action.
" + } + }, + "com.amazonaws.guardduty#BadRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error type.
", + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "A bad request exception object.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.guardduty#BedrockGuardrail": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ARN of the Bedrock guardrail.
", + "smithy.api#jsonName": "arn", + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$" + } + }, + "Version": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version of the Bedrock guardrail.
", + "smithy.api#jsonName": "version", + "smithy.api#length": { + "min": 1, + "max": 8 + }, + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT)|(ENFORCED))$" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a Bedrock guardrail associated with a finding.
" + } + }, + "com.amazonaws.guardduty#BedrockGuardrailDetails": { + "type": "structure", + "members": { + "GuardrailArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#deprecated": { + "message": "Use guardrails list instead", + "since": "2026-07-13" + }, + "smithy.api#documentation": "The ARN of the Bedrock guardrail. This field is deprecated. Use the guardrails list instead.
The version of the Bedrock guardrail. This field is deprecated. Use the guardrails list instead.
The list of Bedrock guardrails associated with the finding.
", + "smithy.api#jsonName": "guardrails" + } + }, + "GuardrailAction": { + "target": "com.amazonaws.guardduty#GuardrailAction", + "traits": { + "smithy.api#documentation": "Indicates whether the guardrail intervened or not.
", + "smithy.api#jsonName": "guardrailAction" + } + }, + "GuardrailSource": { + "target": "com.amazonaws.guardduty#GuardrailSource", + "traits": { + "smithy.api#documentation": "Indicates whether the guardrail was applied on the input or output of the model invocation.
", + "smithy.api#jsonName": "guardrailSource" + } + }, + "ContentPolicyFilters": { + "target": "com.amazonaws.guardduty#ContentPolicyFilters", + "traits": { + "smithy.api#documentation": "The list of content policy filters that matched during the guardrail evaluation.
", + "smithy.api#jsonName": "contentPolicyFilters" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Bedrock guardrail that was involved in a finding.
" + } + }, + "com.amazonaws.guardduty#BedrockGuardrails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#BedrockGuardrail" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.guardduty#Behavior": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#AnomalyUnusualBehaviorFeature" + } + }, + "com.amazonaws.guardduty#BlockPublicAccess": { + "type": "structure", + "members": { + "IgnorePublicAcls": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if S3 Block Public Access is set to IgnorePublicAcls.
Indicates if S3 Block Public Access is set to RestrictPublicBuckets.
Indicates if S3 Block Public Access is set to BlockPublicAcls.
Indicates if S3 Block Public Access is set to BlockPublicPolicy.
Contains information on how the bucker owner's S3 Block Public Access settings are being applied to the S3 bucket. See S3 Block Public Access for more information.
" + } + }, + "com.amazonaws.guardduty#Boolean": { + "type": "boolean" + }, + "com.amazonaws.guardduty#BucketLevelPermissions": { + "type": "structure", + "members": { + "AccessControlList": { + "target": "com.amazonaws.guardduty#AccessControlList", + "traits": { + "smithy.api#documentation": "Contains information on how Access Control Policies are applied to the bucket.
", + "smithy.api#jsonName": "accessControlList" + } + }, + "BucketPolicy": { + "target": "com.amazonaws.guardduty#BucketPolicy", + "traits": { + "smithy.api#documentation": "Contains information on the bucket policies for the S3 bucket.
", + "smithy.api#jsonName": "bucketPolicy" + } + }, + "BlockPublicAccess": { + "target": "com.amazonaws.guardduty#BlockPublicAccess", + "traits": { + "smithy.api#documentation": "Contains information on which account level S3 Block Public Access settings are applied to the S3 bucket.
", + "smithy.api#jsonName": "blockPublicAccess" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the bucket level permissions for the S3 bucket.
" + } + }, + "com.amazonaws.guardduty#BucketPolicy": { + "type": "structure", + "members": { + "AllowsPublicReadAccess": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "A value that indicates whether public read access for the bucket is enabled through a bucket policy.
", + "smithy.api#jsonName": "allowsPublicReadAccess" + } + }, + "AllowsPublicWriteAccess": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "A value that indicates whether public write access for the bucket is enabled through a bucket policy.
", + "smithy.api#jsonName": "allowsPublicWriteAccess" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the current bucket policies for the S3 bucket.
" + } + }, + "com.amazonaws.guardduty#City": { + "type": "structure", + "members": { + "CityName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The city name of the remote IP address.
", + "smithy.api#jsonName": "cityName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the city associated with the IP address.
" + } + }, + "com.amazonaws.guardduty#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.guardduty#CloudDetails": { + "type": "structure", + "members": { + "Provider": { + "target": "com.amazonaws.guardduty#CloudProvider", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The cloud provider. Currently, only AWS is supported.
The Amazon Web Services Region in which the investigated resource resides.
", + "smithy.api#jsonName": "region", + "smithy.api#required": {} + } + }, + "Account": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Web Services account ID of the investigated resource.
", + "smithy.api#jsonName": "account", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the cloud environment associated with an investigation.
" + } + }, + "com.amazonaws.guardduty#CloudProvider": { + "type": "enum", + "members": { + "AWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#CloudTrailConfigurationResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes whether CloudTrail is enabled as a data source for the detector.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the status of CloudTrail as a data source for the detector.
" + } + }, + "com.amazonaws.guardduty#CloudformationStack": { + "type": "structure", + "members": { + "Ec2InstanceUids": { + "target": "com.amazonaws.guardduty#Ec2InstanceUids", + "traits": { + "smithy.api#documentation": "A list of unique identifiers for the compromised Amazon EC2 instances that were created as part of the same CloudFormation stack.
", + "smithy.api#jsonName": "ec2InstanceUids" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the CloudFormation stack involved in a GuardDuty finding, including unique identifiers of the Amazon EC2 instances.
" + } + }, + "com.amazonaws.guardduty#ClusterStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + } + } + }, + "com.amazonaws.guardduty#Condition": { + "type": "structure", + "members": { + "Eq": { + "target": "com.amazonaws.guardduty#Eq", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Represents the equal condition to be applied to a single field when querying for findings.
Max values: 50
", + "smithy.api#jsonName": "eq" + } + }, + "Neq": { + "target": "com.amazonaws.guardduty#Neq", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Represents the not equal condition to be applied to a single field when querying for findings.
Max values: 50
", + "smithy.api#jsonName": "neq" + } + }, + "Gt": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Represents a greater than condition to be applied to a single field when querying for findings.
", + "smithy.api#jsonName": "gt" + } + }, + "Gte": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Represents a greater than or equal condition to be applied to a single field when querying for findings.
", + "smithy.api#jsonName": "gte" + } + }, + "Lt": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Represents a less than condition to be applied to a single field when querying for findings.
", + "smithy.api#jsonName": "lt" + } + }, + "Lte": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Represents a less than or equal condition to be applied to a single field when querying for findings.
", + "smithy.api#jsonName": "lte" + } + }, + "Equals": { + "target": "com.amazonaws.guardduty#Equals", + "traits": { + "smithy.api#documentation": "Represents an equal condition to be applied to a single field when querying for findings.
Max values: 50
", + "smithy.api#jsonName": "equals" + } + }, + "NotEquals": { + "target": "com.amazonaws.guardduty#NotEquals", + "traits": { + "smithy.api#documentation": "Represents a not equal condition to be applied to a single field when querying for findings.
Max values: 50
", + "smithy.api#jsonName": "notEquals" + } + }, + "GreaterThan": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "Represents a greater than condition to be applied to a single field when querying for findings.
", + "smithy.api#jsonName": "greaterThan" + } + }, + "GreaterThanOrEqual": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "Represents a greater than or equal condition to be applied to a single field when querying for findings.
", + "smithy.api#jsonName": "greaterThanOrEqual" + } + }, + "LessThan": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "Represents a less than condition to be applied to a single field when querying for findings.
", + "smithy.api#jsonName": "lessThan" + } + }, + "LessThanOrEqual": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "Represents a less than or equal condition to be applied to a single field when querying for findings.
", + "smithy.api#jsonName": "lessThanOrEqual" + } + }, + "Matches": { + "target": "com.amazonaws.guardduty#Matches", + "traits": { + "smithy.api#documentation": "Represents the match condition to be applied to a single field when querying for findings.
The matches condition is available only for create-filter and update-filter APIs.
Represents the not match condition to be applied to a single field when querying for findings.
The not-matches condition is available only for create-filter and update-filter APIs.
Contains information about the condition.
" + } + }, + "com.amazonaws.guardduty#Confidence": { + "type": "enum", + "members": { + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Low" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Medium" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "High" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#ConfidenceLevel": { + "type": "enum", + "members": { + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.guardduty#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error type.
", + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "A request conflict exception object.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.guardduty#Container": { + "type": "structure", + "members": { + "ContainerRuntime": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The container runtime (such as, Docker or containerd) used to run the container.
", + "smithy.api#jsonName": "containerRuntime" + } + }, + "Id": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Container ID.
", + "smithy.api#jsonName": "id" + } + }, + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Container name.
", + "smithy.api#jsonName": "name" + } + }, + "Image": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Container image.
", + "smithy.api#jsonName": "image" + } + }, + "ImagePrefix": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Part of the image name before the last slash. For example, imagePrefix for public.ecr.aws/amazonlinux/amazonlinux:latest would be public.ecr.aws/amazonlinux. If the image name is relative and does not have a slash, this field is empty.
", + "smithy.api#jsonName": "imagePrefix" + } + }, + "VolumeMounts": { + "target": "com.amazonaws.guardduty#VolumeMounts", + "traits": { + "smithy.api#documentation": "Container volume mounts.
", + "smithy.api#jsonName": "volumeMounts" + } + }, + "SecurityContext": { + "target": "com.amazonaws.guardduty#SecurityContext", + "traits": { + "smithy.api#documentation": "Container security context.
", + "smithy.api#jsonName": "securityContext" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of a container.
" + } + }, + "com.amazonaws.guardduty#ContainerFindingResource": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The container image information, including the image name and tag used to run the container that was involved in the finding.
", + "smithy.api#jsonName": "image", + "smithy.api#required": {} + } + }, + "ImageUid": { + "target": "com.amazonaws.guardduty#ContainerImageUid", + "traits": { + "smithy.api#documentation": "The unique ID associated with the container image.
", + "smithy.api#jsonName": "imageUid" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about container resources involved in a GuardDuty finding. This structure provides details about containers that were identified as part of suspicious or malicious activity.
" + } + }, + "com.amazonaws.guardduty#ContainerImageUid": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.guardduty#ContainerInstanceDetails": { + "type": "structure", + "members": { + "CoveredContainerInstances": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "Represents the nodes in the Amazon ECS cluster that has a HEALTHY coverage status.
Represents total number of nodes in the Amazon ECS cluster.
", + "smithy.api#jsonName": "compatibleContainerInstances" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon EC2 instance that is running the Amazon ECS container.
" + } + }, + "com.amazonaws.guardduty#ContainerUid": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.guardduty#ContainerUids": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ContainerUid" + } + }, + "com.amazonaws.guardduty#Containers": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Container" + } + }, + "com.amazonaws.guardduty#ContentPolicyFilter": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.guardduty#ContentPolicyFilterType", + "traits": { + "smithy.api#documentation": "The type of content that was filtered by the guardrail.
", + "smithy.api#jsonName": "type" + } + }, + "Confidence": { + "target": "com.amazonaws.guardduty#ConfidenceLevel", + "traits": { + "smithy.api#documentation": "The confidence level that the content matched the filter.
", + "smithy.api#jsonName": "confidence" + } + }, + "Action": { + "target": "com.amazonaws.guardduty#ContentPolicyFilterAction", + "traits": { + "smithy.api#documentation": "The action taken by the guardrail filter.
", + "smithy.api#jsonName": "action" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a content policy filter that matched during a guardrail evaluation.
" + } + }, + "com.amazonaws.guardduty#ContentPolicyFilterAction": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.guardduty#ContentPolicyFilterType": { + "type": "enum", + "members": { + "PROMPT_ATTACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROMPT_ATTACK" + } + }, + "JAILBREAK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JAILBREAK" + } + }, + "HATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HATE" + } + }, + "INSULTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSULTS" + } + }, + "SEXUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEXUAL" + } + }, + "VIOLENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIOLENCE" + } + }, + "MISCONDUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISCONDUCT" + } + } + } + }, + "com.amazonaws.guardduty#ContentPolicyFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ContentPolicyFilter" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.guardduty#ContinuousScanDetails": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp representing the start of the time range to scan. Reserved for internal use.
", + "smithy.api#jsonName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp representing the end of the time range to scan.
", + "smithy.api#jsonName": "endTime", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the time range within the continuous backup in Amazon Web Services Backup to scan for a point-in-time recovery resource.
" + } + }, + "com.amazonaws.guardduty#CountByCoverageStatus": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#CoverageStatus" + }, + "value": { + "target": "com.amazonaws.guardduty#Long" + } + }, + "com.amazonaws.guardduty#CountByResourceType": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#ResourceType" + }, + "value": { + "target": "com.amazonaws.guardduty#Long" + } + }, + "com.amazonaws.guardduty#CountBySeverity": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#Integer" + } + }, + "com.amazonaws.guardduty#Country": { + "type": "structure", + "members": { + "CountryCode": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The country code of the remote IP address.
", + "smithy.api#jsonName": "countryCode" + } + }, + "CountryName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The country name of the remote IP address.
", + "smithy.api#jsonName": "countryName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the country where the remote IP address is located.
" + } + }, + "com.amazonaws.guardduty#CoverageEc2InstanceDetails": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon EC2 instance ID.
", + "smithy.api#jsonName": "instanceId" + } + }, + "InstanceType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The instance type of the Amazon EC2 instance.
", + "smithy.api#jsonName": "instanceType" + } + }, + "ClusterArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The cluster ARN of the Amazon ECS cluster running on the Amazon EC2 instance.
", + "smithy.api#jsonName": "clusterArn" + } + }, + "AgentDetails": { + "target": "com.amazonaws.guardduty#AgentDetails", + "traits": { + "smithy.api#documentation": "Information about the installed security agent.
", + "smithy.api#jsonName": "agentDetails" + } + }, + "ManagementType": { + "target": "com.amazonaws.guardduty#ManagementType", + "traits": { + "smithy.api#documentation": "Indicates how the GuardDuty security agent is managed for this resource.
AUTO_MANAGED indicates that GuardDuty deploys and manages updates for this resource.
MANUAL indicates that you are responsible to deploy, update, and manage the GuardDuty security agent updates for this resource.
The DISABLED status doesn't apply to Amazon EC2 instances and Amazon EKS clusters.
Contains information about the Amazon EC2 instance runtime coverage details.
" + } + }, + "com.amazonaws.guardduty#CoverageEcsClusterDetails": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon ECS cluster.
", + "smithy.api#jsonName": "clusterName" + } + }, + "FargateDetails": { + "target": "com.amazonaws.guardduty#FargateDetails", + "traits": { + "smithy.api#documentation": "Information about the Fargate details associated with the Amazon ECS cluster.
", + "smithy.api#jsonName": "fargateDetails" + } + }, + "ContainerInstanceDetails": { + "target": "com.amazonaws.guardduty#ContainerInstanceDetails", + "traits": { + "smithy.api#documentation": "Information about the Amazon ECS container running on Amazon EC2 instance.
", + "smithy.api#jsonName": "containerInstanceDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about Amazon ECS cluster runtime coverage details.
" + } + }, + "com.amazonaws.guardduty#CoverageEksClusterDetails": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Name of the EKS cluster.
", + "smithy.api#jsonName": "clusterName" + } + }, + "CoveredNodes": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "Represents the nodes within the EKS cluster that have a HEALTHY coverage status.
Represents all the nodes within the EKS cluster in your account.
", + "smithy.api#jsonName": "compatibleNodes" + } + }, + "AddonDetails": { + "target": "com.amazonaws.guardduty#AddonDetails", + "traits": { + "smithy.api#documentation": "Information about the installed EKS add-on.
", + "smithy.api#jsonName": "addonDetails" + } + }, + "ManagementType": { + "target": "com.amazonaws.guardduty#ManagementType", + "traits": { + "smithy.api#documentation": "Indicates how the Amazon EKS add-on GuardDuty agent is managed for this EKS cluster.
AUTO_MANAGED indicates GuardDuty deploys and manages updates for this resource.
MANUAL indicates that you are responsible to deploy, update, and manage the Amazon EKS add-on GuardDuty agent for this resource.
Information about the EKS cluster that has a coverage status.
" + } + }, + "com.amazonaws.guardduty#CoverageFilterCondition": { + "type": "structure", + "members": { + "Equals": { + "target": "com.amazonaws.guardduty#Equals", + "traits": { + "smithy.api#documentation": "Represents an equal condition that is applied to a single field while retrieving the coverage details.
", + "smithy.api#jsonName": "equals" + } + }, + "NotEquals": { + "target": "com.amazonaws.guardduty#NotEquals", + "traits": { + "smithy.api#documentation": "Represents a not equal condition that is applied to a single field while retrieving the coverage details.
", + "smithy.api#jsonName": "notEquals" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the operation.
" + } + }, + "com.amazonaws.guardduty#CoverageFilterCriteria": { + "type": "structure", + "members": { + "FilterCriterion": { + "target": "com.amazonaws.guardduty#CoverageFilterCriterionList", + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the operation.
", + "smithy.api#jsonName": "filterCriterion" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the criteria used in the filter.
" + } + }, + "com.amazonaws.guardduty#CoverageFilterCriterion": { + "type": "structure", + "members": { + "CriterionKey": { + "target": "com.amazonaws.guardduty#CoverageFilterCriterionKey", + "traits": { + "smithy.api#documentation": "An enum value representing possible filter fields.
Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME. CLUSTER_NAME has been deprecated.
Contains information about the condition.
", + "smithy.api#jsonName": "filterCondition" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the operation.
" + } + }, + "com.amazonaws.guardduty#CoverageFilterCriterionKey": { + "type": "enum", + "members": { + "ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_ID" + } + }, + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_TYPE" + } + }, + "COVERAGE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COVERAGE_STATUS" + } + }, + "ADDON_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDON_VERSION" + } + }, + "CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER_NAME" + } + }, + "ECS_CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS_CLUSTER_NAME" + } + }, + "MANAGEMENT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGEMENT_TYPE" + } + }, + "EKS_CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_CLUSTER_NAME" + } + }, + "AGENT_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_VERSION" + } + }, + "INSTANCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_ID" + } + }, + "CLUSTER_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER_ARN" + } + } + } + }, + "com.amazonaws.guardduty#CoverageFilterCriterionList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#CoverageFilterCriterion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#CoverageResource": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID of the resource.
", + "smithy.api#jsonName": "resourceId" + } + }, + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the GuardDuty detector associated with the resource.
", + "smithy.api#jsonName": "detectorId" + } + }, + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The unique ID of the Amazon Web Services account.
", + "smithy.api#jsonName": "accountId" + } + }, + "ResourceDetails": { + "target": "com.amazonaws.guardduty#CoverageResourceDetails", + "traits": { + "smithy.api#documentation": "Information about the resource for which the coverage statistics are retrieved.
", + "smithy.api#jsonName": "resourceDetails" + } + }, + "CoverageStatus": { + "target": "com.amazonaws.guardduty#CoverageStatus", + "traits": { + "smithy.api#documentation": "Represents the status of the EKS cluster coverage.
", + "smithy.api#jsonName": "coverageStatus" + } + }, + "Issue": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Represents the reason why a coverage status was UNHEALTHY for the EKS cluster.
The timestamp at which the coverage details for the resource were last updated. This is in UTC format.
", + "smithy.api#jsonName": "updatedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the resource of the GuardDuty account.
" + } + }, + "com.amazonaws.guardduty#CoverageResourceDetails": { + "type": "structure", + "members": { + "EksClusterDetails": { + "target": "com.amazonaws.guardduty#CoverageEksClusterDetails", + "traits": { + "smithy.api#documentation": "EKS cluster details involved in the coverage statistics.
", + "smithy.api#jsonName": "eksClusterDetails" + } + }, + "EcsClusterDetails": { + "target": "com.amazonaws.guardduty#CoverageEcsClusterDetails", + "traits": { + "smithy.api#documentation": "Information about the Amazon ECS cluster that is assessed for runtime coverage.
", + "smithy.api#jsonName": "ecsClusterDetails" + } + }, + "Ec2InstanceDetails": { + "target": "com.amazonaws.guardduty#CoverageEc2InstanceDetails", + "traits": { + "smithy.api#documentation": "Information about the Amazon EC2 instance assessed for runtime coverage.
", + "smithy.api#jsonName": "ec2InstanceDetails" + } + }, + "ResourceType": { + "target": "com.amazonaws.guardduty#ResourceType", + "traits": { + "smithy.api#documentation": "The type of Amazon Web Services resource.
", + "smithy.api#jsonName": "resourceType" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the resource for each individual EKS cluster.
" + } + }, + "com.amazonaws.guardduty#CoverageResources": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#CoverageResource" + } + }, + "com.amazonaws.guardduty#CoverageSortCriteria": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.guardduty#CoverageSortKey", + "traits": { + "smithy.api#documentation": "Represents the field name used to sort the coverage details.
Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME. CLUSTER_NAME has been deprecated.
The order in which the sorted findings are to be displayed.
", + "smithy.api#jsonName": "orderBy" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the sorting criteria used in the coverage statistics.
" + } + }, + "com.amazonaws.guardduty#CoverageSortKey": { + "type": "enum", + "members": { + "ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_ID" + } + }, + "COVERAGE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COVERAGE_STATUS" + } + }, + "ISSUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISSUE" + } + }, + "ADDON_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDON_VERSION" + } + }, + "UPDATED_AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED_AT" + } + }, + "CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER_NAME" + } + }, + "EKS_CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_CLUSTER_NAME" + } + }, + "ECS_CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS_CLUSTER_NAME" + } + }, + "INSTANCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_ID" + } + } + } + }, + "com.amazonaws.guardduty#CoverageStatistics": { + "type": "structure", + "members": { + "CountByResourceType": { + "target": "com.amazonaws.guardduty#CountByResourceType", + "traits": { + "smithy.api#documentation": "Represents coverage statistics for EKS clusters aggregated by resource type.
", + "smithy.api#jsonName": "countByResourceType" + } + }, + "CountByCoverageStatus": { + "target": "com.amazonaws.guardduty#CountByCoverageStatus", + "traits": { + "smithy.api#documentation": "Represents coverage statistics for EKS clusters aggregated by coverage status.
", + "smithy.api#jsonName": "countByCoverageStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the coverage statistics for a resource.
" + } + }, + "com.amazonaws.guardduty#CoverageStatisticsType": { + "type": "enum", + "members": { + "COUNT_BY_RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT_BY_RESOURCE_TYPE" + } + }, + "COUNT_BY_COVERAGE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT_BY_COVERAGE_STATUS" + } + } + } + }, + "com.amazonaws.guardduty#CoverageStatisticsTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#CoverageStatisticsType" + } + }, + "com.amazonaws.guardduty#CoverageStatus": { + "type": "enum", + "members": { + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" + } + }, + "UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNHEALTHY" + } + } + } + }, + "com.amazonaws.guardduty#CreateDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateDetectorRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateDetectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a single GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each Region where you enable the service. You can have only one detector per account per Region. All data sources are enabled in a new detector by default.
When you don't specify any features, with an exception to RUNTIME_MONITORING, all the optional features are enabled by default.
When you specify some of the features, any feature that is not specified in the API call gets enabled by default, with an exception to RUNTIME_MONITORING.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can add only one of these two features because Runtime Monitoring already includes the threat detection for Amazon EKS resources. For more information, see Runtime Monitoring.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateDetectorRequest": { + "type": "structure", + "members": { + "Enable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A Boolean value that specifies whether the detector is to be enabled.
", + "smithy.api#jsonName": "enable", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "FindingPublishingFrequency": { + "target": "com.amazonaws.guardduty#FindingPublishingFrequency", + "traits": { + "smithy.api#documentation": "A value that specifies how frequently updated findings are exported.
", + "smithy.api#jsonName": "findingPublishingFrequency" + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurations", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Describes which data sources will be enabled for the detector.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a new detector resource.
", + "smithy.api#jsonName": "tags" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#DetectorFeatureConfigurations", + "traits": { + "smithy.api#documentation": "A list of features that will be configured for the detector.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateDetectorResponse": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the created detector.
", + "smithy.api#jsonName": "detectorId" + } + }, + "UnprocessedDataSources": { + "target": "com.amazonaws.guardduty#UnprocessedDataSourcesResult", + "traits": { + "smithy.api#documentation": "Specifies the data sources that couldn't be enabled when GuardDuty was enabled for the first time.
", + "smithy.api#jsonName": "unprocessedDataSources" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateFilterRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a filter using the specified finding criteria. The maximum number of saved filters per Amazon Web Services account per Region is 100. For more information, see Quotas for GuardDuty.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/filter", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateFilterRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detector ID associated with the GuardDuty account for which you want to create a filter.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The name of the filter. Valid characters include period (.), underscore (_), dash (-), and alphanumeric characters. A whitespace is considered to be an invalid character.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.guardduty#FilterDescription", + "traits": { + "smithy.api#documentation": "The description of the filter. Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses ({ }, [ ], and ( )), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace.
Specifies the action that is to be applied to the findings that match the filter.
Default: NOOP
", + "smithy.api#jsonName": "action" + } + }, + "Rank": { + "target": "com.amazonaws.guardduty#FilterRank", + "traits": { + "smithy.api#documentation": "Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.
", + "smithy.api#jsonName": "rank" + } + }, + "FindingCriteria": { + "target": "com.amazonaws.guardduty#FindingCriteria", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Represents the criteria to be used in the filter for querying findings. The following fields are available for filtering:
accountId
arn
associatedAttackSequenceArn
confidence
createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
id
partition
region
resource.accessKeyDetails.accessKeyId
resource.accessKeyDetails.principalId
resource.accessKeyDetails.userIdentity.accessKeyId
resource.accessKeyDetails.userIdentity.accountId
resource.accessKeyDetails.userIdentity.arn
resource.accessKeyDetails.userIdentity.principalId
resource.accessKeyDetails.userIdentity.sessionContext.attributes.mfaAuthenticated
resource.accessKeyDetails.userIdentity.sessionContext.ec2RoleDelivery
resource.accessKeyDetails.userIdentity.sessionContext.invokedBy
resource.accessKeyDetails.userIdentity.sessionContext.sessionIssuer.accountId
resource.accessKeyDetails.userIdentity.sessionContext.sessionIssuer.arn
resource.accessKeyDetails.userIdentity.sessionContext.sessionIssuer.principalId
resource.accessKeyDetails.userIdentity.sessionContext.sessionIssuer.type
resource.accessKeyDetails.userIdentity.sessionContext.sessionIssuer.userName
resource.accessKeyDetails.userIdentity.sessionContext.sourceIdentity
resource.accessKeyDetails.userIdentity.sessionContext.webIdFederationData.attributes
resource.accessKeyDetails.userIdentity.sessionContext.webIdFederationData.federatedProvider
resource.accessKeyDetails.userIdentity.type
resource.accessKeyDetails.userIdentity.userName
resource.accessKeyDetails.userName
resource.accessKeyDetails.userType
resource.bedrockGuardrailDetails.guardrailArn
resource.bedrockGuardrailDetails.guardrailVersion
resource.containerDetails.containerRuntime
resource.containerDetails.id
resource.containerDetails.image
resource.containerDetails.imagePrefix
resource.containerDetails.name
resource.containerDetails.securityContext.allowPrivilegeEscalation
resource.containerDetails.securityContext.privileged
resource.containerDetails.volumeMounts.mountPath
resource.containerDetails.volumeMounts.name
resource.ebsSnapshotDetails.snapshotArn
resource.ebsVolumeDetails.scannedVolumeDetails.deviceName
resource.ebsVolumeDetails.scannedVolumeDetails.encryptionType
resource.ebsVolumeDetails.scannedVolumeDetails.kmsKeyArn
resource.ebsVolumeDetails.scannedVolumeDetails.snapshotArn
resource.ebsVolumeDetails.scannedVolumeDetails.volumeArn
resource.ebsVolumeDetails.scannedVolumeDetails.volumeSizeInGB
resource.ebsVolumeDetails.scannedVolumeDetails.volumeType
resource.ebsVolumeDetails.skippedVolumeDetails.deviceName
resource.ebsVolumeDetails.skippedVolumeDetails.encryptionType
resource.ebsVolumeDetails.skippedVolumeDetails.kmsKeyArn
resource.ebsVolumeDetails.skippedVolumeDetails.snapshotArn
resource.ebsVolumeDetails.skippedVolumeDetails.volumeArn
resource.ebsVolumeDetails.skippedVolumeDetails.volumeSizeInGB
resource.ebsVolumeDetails.skippedVolumeDetails.volumeType
resource.ec2ImageDetails.imageArn
resource.ecsClusterDetails.activeServicesCount
resource.ecsClusterDetails.arn
resource.ecsClusterDetails.name
resource.ecsClusterDetails.registeredContainerInstancesCount
resource.ecsClusterDetails.runningTasksCount
resource.ecsClusterDetails.status
resource.ecsClusterDetails.tags.key
resource.ecsClusterDetails.tags.value
resource.ecsClusterDetails.taskDetails.arn
resource.ecsClusterDetails.taskDetails.containers.containerRuntime
resource.ecsClusterDetails.taskDetails.containers.id
resource.ecsClusterDetails.taskDetails.containers.image
resource.ecsClusterDetails.taskDetails.containers.imagePrefix
resource.ecsClusterDetails.taskDetails.containers.name
resource.ecsClusterDetails.taskDetails.containers.securityContext.allowPrivilegeEscalation
resource.ecsClusterDetails.taskDetails.containers.securityContext.privileged
resource.ecsClusterDetails.taskDetails.containers.volumeMounts.mountPath
resource.ecsClusterDetails.taskDetails.containers.volumeMounts.name
resource.ecsClusterDetails.taskDetails.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
resource.ecsClusterDetails.taskDetails.definitionArn
resource.ecsClusterDetails.taskDetails.group
resource.ecsClusterDetails.taskDetails.launchType
resource.ecsClusterDetails.taskDetails.startedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
resource.ecsClusterDetails.taskDetails.startedBy
resource.ecsClusterDetails.taskDetails.tags.key
resource.ecsClusterDetails.taskDetails.tags.value
resource.ecsClusterDetails.taskDetails.version
resource.ecsClusterDetails.taskDetails.volumes.hostPath.path
resource.ecsClusterDetails.taskDetails.volumes.name
resource.eksClusterDetails.arn
resource.eksClusterDetails.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
resource.eksClusterDetails.name
resource.eksClusterDetails.status
resource.eksClusterDetails.tags.key
resource.eksClusterDetails.tags.value
resource.eksClusterDetails.vpcId
resource.instanceDetails.availabilityZone
resource.instanceDetails.iamInstanceProfile.arn
resource.instanceDetails.iamInstanceProfile.id
resource.instanceDetails.imageDescription
resource.instanceDetails.imageId
resource.instanceDetails.instanceId
resource.instanceDetails.instanceState
resource.instanceDetails.instanceType
resource.instanceDetails.launchTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
resource.instanceDetails.networkInterfaces.ipv6Addresses
resource.instanceDetails.networkInterfaces.networkInterfaceId
resource.instanceDetails.networkInterfaces.privateDnsName
resource.instanceDetails.networkInterfaces.privateIpAddress
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateDnsName
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
resource.instanceDetails.networkInterfaces.publicDnsName
resource.instanceDetails.networkInterfaces.publicIp
resource.instanceDetails.networkInterfaces.securityGroups.groupId
resource.instanceDetails.networkInterfaces.securityGroups.groupName
resource.instanceDetails.networkInterfaces.subnetId
resource.instanceDetails.networkInterfaces.vpcId
resource.instanceDetails.outpostArn
resource.instanceDetails.platform
resource.instanceDetails.productCodes.productCodeId
resource.instanceDetails.productCodes.productCodeType
resource.instanceDetails.tags.key
resource.instanceDetails.tags.value
resource.kubernetesDetails.kubernetesUserDetails.groups
resource.kubernetesDetails.kubernetesUserDetails.impersonatedUser.groups
resource.kubernetesDetails.kubernetesUserDetails.impersonatedUser.username
resource.kubernetesDetails.kubernetesUserDetails.sessionName
resource.kubernetesDetails.kubernetesUserDetails.uid
resource.kubernetesDetails.kubernetesUserDetails.username
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.containerRuntime
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.id
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.name
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.securityContext.allowPrivilegeEscalation
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.securityContext.privileged
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.volumeMounts.mountPath
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.volumeMounts.name
resource.kubernetesDetails.kubernetesWorkloadDetails.hostIpc
resource.kubernetesDetails.kubernetesWorkloadDetails.hostNetwork
resource.kubernetesDetails.kubernetesWorkloadDetails.hostPid
resource.kubernetesDetails.kubernetesWorkloadDetails.name
resource.kubernetesDetails.kubernetesWorkloadDetails.namespace
resource.kubernetesDetails.kubernetesWorkloadDetails.serviceAccountName
resource.kubernetesDetails.kubernetesWorkloadDetails.type
resource.kubernetesDetails.kubernetesWorkloadDetails.uid
resource.kubernetesDetails.kubernetesWorkloadDetails.volumes.hostPath.path
resource.kubernetesDetails.kubernetesWorkloadDetails.volumes.name
resource.lambdaDetails.description
resource.lambdaDetails.functionArn
resource.lambdaDetails.functionName
resource.lambdaDetails.functionVersion
resource.lambdaDetails.lastModifiedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
resource.lambdaDetails.revisionId
resource.lambdaDetails.role
resource.lambdaDetails.tags.key
resource.lambdaDetails.tags.value
resource.lambdaDetails.vpcConfig.securityGroups.groupId
resource.lambdaDetails.vpcConfig.securityGroups.groupName
resource.lambdaDetails.vpcConfig.subnetIds
resource.lambdaDetails.vpcConfig.vpcId
resource.rdsDbInstanceDetails.dbClusterIdentifier
resource.rdsDbInstanceDetails.dbInstanceArn
resource.rdsDbInstanceDetails.dbInstanceIdentifier
resource.rdsDbInstanceDetails.dbSecurityGroups.name
resource.rdsDbInstanceDetails.dbSecurityGroups.status
resource.rdsDbInstanceDetails.dbiResourceId
resource.rdsDbInstanceDetails.engine
resource.rdsDbInstanceDetails.engineVersion
resource.rdsDbInstanceDetails.iamDatabaseAuthenticationEnabled
resource.rdsDbInstanceDetails.publiclyAccessible
resource.rdsDbInstanceDetails.vpcId
resource.rdsDbInstanceDetails.vpcSecurityGroups.status
resource.rdsDbInstanceDetails.vpcSecurityGroups.vpcSecurityGroupId
resource.rdsDbUserDetails.application
resource.rdsDbUserDetails.authMethod
resource.rdsDbUserDetails.database
resource.rdsDbUserDetails.ssl
resource.rdsDbUserDetails.user
resource.rdsLimitlessDbDetails.dbClusterIdentifier
resource.rdsLimitlessDbDetails.dbShardGroupArn
resource.rdsLimitlessDbDetails.dbShardGroupIdentifier
resource.rdsLimitlessDbDetails.dbShardGroupResourceId
resource.rdsLimitlessDbDetails.engine
resource.rdsLimitlessDbDetails.engineVersion
resource.rdsLimitlessDbDetails.tags.key
resource.rdsLimitlessDbDetails.tags.value
resource.recoveryPointDetails.backupVaultName
resource.recoveryPointDetails.recoveryPointArn
resource.resourceType
resource.s3BucketDetails.arn
resource.s3BucketDetails.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
resource.s3BucketDetails.defaultServerSideEncryption.encryptionType
resource.s3BucketDetails.defaultServerSideEncryption.kmsMasterKeyArn
resource.s3BucketDetails.name
resource.s3BucketDetails.owner.id
resource.s3BucketDetails.publicAccess.effectivePermission
resource.s3BucketDetails.publicAccess.permissionConfiguration.accountLevelPermissions.blockPublicAccess.blockPublicAcls
resource.s3BucketDetails.publicAccess.permissionConfiguration.accountLevelPermissions.blockPublicAccess.blockPublicPolicy
resource.s3BucketDetails.publicAccess.permissionConfiguration.accountLevelPermissions.blockPublicAccess.ignorePublicAcls
resource.s3BucketDetails.publicAccess.permissionConfiguration.accountLevelPermissions.blockPublicAccess.restrictPublicBuckets
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.accessControlList.allowsPublicReadAccess
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.accessControlList.allowsPublicWriteAccess
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.blockPublicAccess.blockPublicAcls
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.blockPublicAccess.blockPublicPolicy
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.blockPublicAccess.ignorePublicAcls
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.blockPublicAccess.restrictPublicBuckets
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.bucketPolicy.allowsPublicReadAccess
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.bucketPolicy.allowsPublicWriteAccess
resource.s3BucketDetails.s3ObjectDetails.eTag
resource.s3BucketDetails.s3ObjectDetails.hash
resource.s3BucketDetails.s3ObjectDetails.key
resource.s3BucketDetails.s3ObjectDetails.objectArn
resource.s3BucketDetails.s3ObjectDetails.versionId
resource.s3BucketDetails.tags.key
resource.s3BucketDetails.tags.value
resource.s3BucketDetails.type
schemaVersion
service.action.actionType
service.action.awsApiCallAction.api
service.action.awsApiCallAction.callerType
service.action.awsApiCallAction.domainDetails.domain
service.action.awsApiCallAction.errorCode
service.action.awsApiCallAction.remoteAccountDetails.accountId
service.action.awsApiCallAction.remoteAccountDetails.affiliated
service.action.awsApiCallAction.remoteAccountDetails.awsServiceName
service.action.awsApiCallAction.remoteIpDetails.city.cityName
service.action.awsApiCallAction.remoteIpDetails.country.countryCode
service.action.awsApiCallAction.remoteIpDetails.country.countryName
service.action.awsApiCallAction.remoteIpDetails.geoLocation.lat
service.action.awsApiCallAction.remoteIpDetails.geoLocation.lon
service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
service.action.awsApiCallAction.remoteIpDetails.ipAddressV6
service.action.awsApiCallAction.remoteIpDetails.organization.asn
service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
service.action.awsApiCallAction.remoteIpDetails.organization.isp
service.action.awsApiCallAction.remoteIpDetails.organization.org
service.action.awsApiCallAction.serviceName
service.action.awsApiCallAction.userAgent
service.action.dnsRequestAction.blocked
service.action.dnsRequestAction.domain
service.action.dnsRequestAction.domainWithSuffix
service.action.dnsRequestAction.protocol
service.action.dnsRequestAction.vpcOwnerAccountId
service.action.kubernetesApiCallAction.namespace
service.action.kubernetesApiCallAction.parameters
service.action.kubernetesApiCallAction.remoteIpDetails.city.cityName
service.action.kubernetesApiCallAction.remoteIpDetails.country.countryCode
service.action.kubernetesApiCallAction.remoteIpDetails.country.countryName
service.action.kubernetesApiCallAction.remoteIpDetails.geoLocation.lat
service.action.kubernetesApiCallAction.remoteIpDetails.geoLocation.lon
service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6
service.action.kubernetesApiCallAction.remoteIpDetails.organization.asn
service.action.kubernetesApiCallAction.remoteIpDetails.organization.asnOrg
service.action.kubernetesApiCallAction.remoteIpDetails.organization.isp
service.action.kubernetesApiCallAction.remoteIpDetails.organization.org
service.action.kubernetesApiCallAction.requestUri
service.action.kubernetesApiCallAction.resource
service.action.kubernetesApiCallAction.resourceName
service.action.kubernetesApiCallAction.sourceIPs
service.action.kubernetesApiCallAction.statusCode
service.action.kubernetesApiCallAction.subresource
service.action.kubernetesApiCallAction.userAgent
service.action.kubernetesApiCallAction.verb
service.action.kubernetesPermissionCheckedDetails.allowed
service.action.kubernetesPermissionCheckedDetails.namespace
service.action.kubernetesPermissionCheckedDetails.resource
service.action.kubernetesPermissionCheckedDetails.verb
service.action.kubernetesRoleBindingDetails.kind
service.action.kubernetesRoleBindingDetails.name
service.action.kubernetesRoleBindingDetails.roleRefKind
service.action.kubernetesRoleBindingDetails.roleRefName
service.action.kubernetesRoleBindingDetails.uid
service.action.kubernetesRoleDetails.kind
service.action.kubernetesRoleDetails.name
service.action.kubernetesRoleDetails.uid
service.action.networkConnectionAction.blocked
service.action.networkConnectionAction.connectionDirection
service.action.networkConnectionAction.localIpDetails.ipAddressV4
service.action.networkConnectionAction.localIpDetails.ipAddressV6
service.action.networkConnectionAction.localNetworkInterface
service.action.networkConnectionAction.localPortDetails.port
service.action.networkConnectionAction.localPortDetails.portName
service.action.networkConnectionAction.protocol
service.action.networkConnectionAction.remoteIpDetails.city.cityName
service.action.networkConnectionAction.remoteIpDetails.country.countryCode
service.action.networkConnectionAction.remoteIpDetails.country.countryName
service.action.networkConnectionAction.remoteIpDetails.geoLocation.lat
service.action.networkConnectionAction.remoteIpDetails.geoLocation.lon
service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
service.action.networkConnectionAction.remoteIpDetails.ipAddressV6
service.action.networkConnectionAction.remoteIpDetails.organization.asn
service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
service.action.networkConnectionAction.remoteIpDetails.organization.isp
service.action.networkConnectionAction.remoteIpDetails.organization.org
service.action.networkConnectionAction.remotePortDetails.port
service.action.networkConnectionAction.remotePortDetails.portName
service.action.portProbeAction.blocked
service.action.portProbeAction.portProbeDetails.localIpDetails.ipAddressV4
service.action.portProbeAction.portProbeDetails.localIpDetails.ipAddressV6
service.action.portProbeAction.portProbeDetails.localPortDetails.port
service.action.portProbeAction.portProbeDetails.localPortDetails.portName
service.action.portProbeAction.portProbeDetails.remoteIpDetails.city.cityName
service.action.portProbeAction.portProbeDetails.remoteIpDetails.country.countryCode
service.action.portProbeAction.portProbeDetails.remoteIpDetails.country.countryName
service.action.portProbeAction.portProbeDetails.remoteIpDetails.geoLocation.lat
service.action.portProbeAction.portProbeDetails.remoteIpDetails.geoLocation.lon
service.action.portProbeAction.portProbeDetails.remoteIpDetails.ipAddressV4
service.action.portProbeAction.portProbeDetails.remoteIpDetails.ipAddressV6
service.action.portProbeAction.portProbeDetails.remoteIpDetails.organization.asn
service.action.portProbeAction.portProbeDetails.remoteIpDetails.organization.asnOrg
service.action.portProbeAction.portProbeDetails.remoteIpDetails.organization.isp
service.action.portProbeAction.portProbeDetails.remoteIpDetails.organization.org
service.action.rdsLoginAttemptAction.loginAttributes.application
service.action.rdsLoginAttemptAction.loginAttributes.failedLoginAttempts
service.action.rdsLoginAttemptAction.loginAttributes.successfulLoginAttempts
service.action.rdsLoginAttemptAction.loginAttributes.user
service.action.rdsLoginAttemptAction.remoteIpDetails.city.cityName
service.action.rdsLoginAttemptAction.remoteIpDetails.country.countryCode
service.action.rdsLoginAttemptAction.remoteIpDetails.country.countryName
service.action.rdsLoginAttemptAction.remoteIpDetails.geoLocation.lat
service.action.rdsLoginAttemptAction.remoteIpDetails.geoLocation.lon
service.action.rdsLoginAttemptAction.remoteIpDetails.ipAddressV4
service.action.rdsLoginAttemptAction.remoteIpDetails.ipAddressV6
service.action.rdsLoginAttemptAction.remoteIpDetails.organization.asn
service.action.rdsLoginAttemptAction.remoteIpDetails.organization.asnOrg
service.action.rdsLoginAttemptAction.remoteIpDetails.organization.isp
service.action.rdsLoginAttemptAction.remoteIpDetails.organization.org
service.additionalInfo.agentDetails.agentId
service.additionalInfo.agentDetails.agentVersion
service.additionalInfo.anomalies.anomalousAPIs
service.additionalInfo.authenticationMethod
service.additionalInfo.averagePacketSizeIn
service.additionalInfo.averagePacketSizeOut
service.additionalInfo.context
service.additionalInfo.domain
service.additionalInfo.inBytes
service.additionalInfo.localNetworkInterfaceOwner
service.additionalInfo.localPort
service.additionalInfo.outBytes
service.additionalInfo.packetsIn
service.additionalInfo.packetsOut
service.additionalInfo.policyArn
service.additionalInfo.policyName
service.additionalInfo.remotePort
service.additionalInfo.sample
service.additionalInfo.scannedPort
service.additionalInfo.threatFileSha256
service.additionalInfo.threatListName
service.additionalInfo.threatName
service.additionalInfo.totalBytesIn
service.additionalInfo.totalBytesOut
service.additionalInfo.type
service.additionalInfo.unusual.asnOrg
service.additionalInfo.unusual.port
service.additionalInfo.unusualProtocol
service.additionalInfo.userAgent.fullUserAgent
service.additionalInfo.userAgent.userAgentCategory
service.additionalInfo.value
service.additionalInfo.vpcOwnerAccountId
service.archived
service.count
service.detection.sequence.actors.id
service.detection.sequence.actors.process.name
service.detection.sequence.actors.process.path
service.detection.sequence.actors.process.sha256
service.detection.sequence.actors.session.createdTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.actors.session.issuer
service.detection.sequence.actors.session.mfaStatus
service.detection.sequence.actors.session.uid
service.detection.sequence.actors.user.account.account
service.detection.sequence.actors.user.account.uid
service.detection.sequence.actors.user.credentialUid
service.detection.sequence.actors.user.name
service.detection.sequence.actors.user.type
service.detection.sequence.actors.user.uid
service.detection.sequence.additionalSequenceTypes
service.detection.sequence.description
service.detection.sequence.endpoints.autonomousSystem.name
service.detection.sequence.endpoints.autonomousSystem.number
service.detection.sequence.endpoints.connection.direction
service.detection.sequence.endpoints.domain
service.detection.sequence.endpoints.id
service.detection.sequence.endpoints.ip
service.detection.sequence.endpoints.location.city
service.detection.sequence.endpoints.location.country
service.detection.sequence.endpoints.location.lat
service.detection.sequence.endpoints.location.lon
service.detection.sequence.endpoints.port
service.detection.sequence.resources.accountId
service.detection.sequence.resources.cloudPartition
service.detection.sequence.resources.data.accessKey.principalId
service.detection.sequence.resources.data.accessKey.userName
service.detection.sequence.resources.data.accessKey.userType
service.detection.sequence.resources.data.autoscalingAutoScalingGroup.ec2InstanceUids
service.detection.sequence.resources.data.cloudformationStack.ec2InstanceUids
service.detection.sequence.resources.data.container.image
service.detection.sequence.resources.data.container.imageUid
service.detection.sequence.resources.data.ec2Image.ec2InstanceUids
service.detection.sequence.resources.data.ec2Instance.availabilityZone
service.detection.sequence.resources.data.ec2Instance.ec2NetworkInterfaceUids
service.detection.sequence.resources.data.ec2Instance.iamInstanceProfile.arn
service.detection.sequence.resources.data.ec2Instance.iamInstanceProfile.id
service.detection.sequence.resources.data.ec2Instance.imageDescription
service.detection.sequence.resources.data.ec2Instance.instanceState
service.detection.sequence.resources.data.ec2Instance.instanceType
service.detection.sequence.resources.data.ec2Instance.outpostArn
service.detection.sequence.resources.data.ec2Instance.platform
service.detection.sequence.resources.data.ec2Instance.productCodes.productCodeId
service.detection.sequence.resources.data.ec2Instance.productCodes.productCodeType
service.detection.sequence.resources.data.ec2LaunchTemplate.ec2InstanceUids
service.detection.sequence.resources.data.ec2LaunchTemplate.version
service.detection.sequence.resources.data.ec2NetworkInterface.ipv6Addresses
service.detection.sequence.resources.data.ec2NetworkInterface.privateIpAddresses.privateDnsName
service.detection.sequence.resources.data.ec2NetworkInterface.privateIpAddresses.privateIpAddress
service.detection.sequence.resources.data.ec2NetworkInterface.publicIp
service.detection.sequence.resources.data.ec2NetworkInterface.securityGroups.groupId
service.detection.sequence.resources.data.ec2NetworkInterface.securityGroups.groupName
service.detection.sequence.resources.data.ec2NetworkInterface.subNetId
service.detection.sequence.resources.data.ec2NetworkInterface.vpcId
service.detection.sequence.resources.data.ec2Vpc.ec2InstanceUids
service.detection.sequence.resources.data.ecsCluster.ec2InstanceUids
service.detection.sequence.resources.data.ecsCluster.status
service.detection.sequence.resources.data.ecsTask.containerUids
service.detection.sequence.resources.data.ecsTask.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.resources.data.ecsTask.launchType
service.detection.sequence.resources.data.ecsTask.taskDefinitionArn
service.detection.sequence.resources.data.eksCluster.arn
service.detection.sequence.resources.data.eksCluster.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.resources.data.eksCluster.ec2InstanceUids
service.detection.sequence.resources.data.eksCluster.status
service.detection.sequence.resources.data.eksCluster.vpcId
service.detection.sequence.resources.data.iamInstanceProfile.ec2InstanceUids
service.detection.sequence.resources.data.iamInstanceProfile.id
service.detection.sequence.resources.data.kubernetesWorkload.containerUids
service.detection.sequence.resources.data.kubernetesWorkload.namespace
service.detection.sequence.resources.data.kubernetesWorkload.type
service.detection.sequence.resources.data.s3Bucket.accountPublicAccess.publicAclAccess
service.detection.sequence.resources.data.s3Bucket.accountPublicAccess.publicAclIgnoreBehavior
service.detection.sequence.resources.data.s3Bucket.accountPublicAccess.publicBucketRestrictBehavior
service.detection.sequence.resources.data.s3Bucket.accountPublicAccess.publicPolicyAccess
service.detection.sequence.resources.data.s3Bucket.bucketPublicAccess.publicAclAccess
service.detection.sequence.resources.data.s3Bucket.bucketPublicAccess.publicAclIgnoreBehavior
service.detection.sequence.resources.data.s3Bucket.bucketPublicAccess.publicBucketRestrictBehavior
service.detection.sequence.resources.data.s3Bucket.bucketPublicAccess.publicPolicyAccess
service.detection.sequence.resources.data.s3Bucket.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.resources.data.s3Bucket.effectivePermission
service.detection.sequence.resources.data.s3Bucket.encryptionKeyArn
service.detection.sequence.resources.data.s3Bucket.encryptionType
service.detection.sequence.resources.data.s3Bucket.ownerId
service.detection.sequence.resources.data.s3Bucket.publicReadAccess
service.detection.sequence.resources.data.s3Bucket.publicWriteAccess
service.detection.sequence.resources.data.s3Bucket.s3ObjectUids
service.detection.sequence.resources.data.s3Object.eTag
service.detection.sequence.resources.data.s3Object.key
service.detection.sequence.resources.data.s3Object.versionId
service.detection.sequence.resources.name
service.detection.sequence.resources.region
service.detection.sequence.resources.resourceType
service.detection.sequence.resources.service
service.detection.sequence.resources.tags.key
service.detection.sequence.resources.tags.value
service.detection.sequence.resources.uid
service.detection.sequence.sequenceIndicators.key
service.detection.sequence.sequenceIndicators.title
service.detection.sequence.sequenceIndicators.values
service.detection.sequence.signals.actorIds
service.detection.sequence.signals.count
service.detection.sequence.signals.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.signals.description
service.detection.sequence.signals.endpointIds
service.detection.sequence.signals.firstSeenAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.signals.lastSeenAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.signals.name
service.detection.sequence.signals.resourceUids
service.detection.sequence.signals.severity
service.detection.sequence.signals.signalIndicators.key
service.detection.sequence.signals.signalIndicators.title
service.detection.sequence.signals.signalIndicators.values
service.detection.sequence.signals.type
service.detection.sequence.signals.uid
service.detection.sequence.signals.updatedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.uid
service.detectorId
service.ebsVolumeScanDetails.scanCompletedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.ebsVolumeScanDetails.scanDetections.highestSeverityThreatDetails.count
service.ebsVolumeScanDetails.scanDetections.highestSeverityThreatDetails.severity
service.ebsVolumeScanDetails.scanDetections.highestSeverityThreatDetails.threatName
service.ebsVolumeScanDetails.scanDetections.scannedItemCount.files
service.ebsVolumeScanDetails.scanDetections.scannedItemCount.totalGb
service.ebsVolumeScanDetails.scanDetections.scannedItemCount.volumes
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.itemCount
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.shortened
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.fileName
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.filePath
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.volumeArn
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.itemCount
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.uniqueThreatNameCount
service.ebsVolumeScanDetails.scanDetections.threatsDetectedItemCount.files
service.ebsVolumeScanDetails.scanId
service.ebsVolumeScanDetails.scanStartedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.ebsVolumeScanDetails.scanType
service.ebsVolumeScanDetails.sources
service.ebsVolumeScanDetails.triggerFindingId
service.eventFirstSeen
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.eventLastSeen
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.evidence.threatIntelligenceDetails.threatFileSha256
service.evidence.threatIntelligenceDetails.threatListName
service.evidence.threatIntelligenceDetails.threatNames
service.featureName
service.malwareScanDetails.scanCategory
service.malwareScanDetails.scanConfiguration.incrementalScanDetails.baselineResourceArn
service.malwareScanDetails.scanConfiguration.triggerType
service.malwareScanDetails.scanId
service.malwareScanDetails.scanType
service.malwareScanDetails.threats.count
service.malwareScanDetails.threats.hash
service.malwareScanDetails.threats.itemDetails.additionalInfo.deviceName
service.malwareScanDetails.threats.itemDetails.additionalInfo.versionId
service.malwareScanDetails.threats.itemDetails.hash
service.malwareScanDetails.threats.itemDetails.itemPath
service.malwareScanDetails.threats.itemDetails.resourceArn
service.malwareScanDetails.threats.itemPaths.hash
service.malwareScanDetails.threats.itemPaths.nestedItemPath
service.malwareScanDetails.threats.name
service.malwareScanDetails.threats.source
service.malwareScanDetails.uniqueThreatCount
service.resourceRole
service.runtimeDetails.context.addressFamily
service.runtimeDetails.context.commandLineExample
service.runtimeDetails.context.fileOperation
service.runtimeDetails.context.filePath
service.runtimeDetails.context.fileSystemType
service.runtimeDetails.context.flags
service.runtimeDetails.context.ianaProtocolNumber
service.runtimeDetails.context.ldPreloadValue
service.runtimeDetails.context.libraryPath
service.runtimeDetails.context.memoryRegions
service.runtimeDetails.context.modifiedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.context.modifyingProcess.euid
service.runtimeDetails.context.modifyingProcess.executablePath
service.runtimeDetails.context.modifyingProcess.executableSha256
service.runtimeDetails.context.modifyingProcess.lineage.euid
service.runtimeDetails.context.modifyingProcess.lineage.executablePath
service.runtimeDetails.context.modifyingProcess.lineage.name
service.runtimeDetails.context.modifyingProcess.lineage.namespacePid
service.runtimeDetails.context.modifyingProcess.lineage.parentUuid
service.runtimeDetails.context.modifyingProcess.lineage.pid
service.runtimeDetails.context.modifyingProcess.lineage.startTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.context.modifyingProcess.lineage.userId
service.runtimeDetails.context.modifyingProcess.lineage.uuid
service.runtimeDetails.context.modifyingProcess.name
service.runtimeDetails.context.modifyingProcess.namespacePid
service.runtimeDetails.context.modifyingProcess.parentUuid
service.runtimeDetails.context.modifyingProcess.pid
service.runtimeDetails.context.modifyingProcess.pwd
service.runtimeDetails.context.modifyingProcess.startTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.context.modifyingProcess.user
service.runtimeDetails.context.modifyingProcess.userId
service.runtimeDetails.context.modifyingProcess.uuid
service.runtimeDetails.context.moduleFilePath
service.runtimeDetails.context.moduleName
service.runtimeDetails.context.moduleSha256
service.runtimeDetails.context.mountSource
service.runtimeDetails.context.mountTarget
service.runtimeDetails.context.relatedFilePaths
service.runtimeDetails.context.releaseAgentPath
service.runtimeDetails.context.runcBinaryPath
service.runtimeDetails.context.scriptPath
service.runtimeDetails.context.serviceName
service.runtimeDetails.context.shellHistoryFilePath
service.runtimeDetails.context.socketPath
service.runtimeDetails.context.targetProcess.euid
service.runtimeDetails.context.targetProcess.executablePath
service.runtimeDetails.context.targetProcess.executableSha256
service.runtimeDetails.context.targetProcess.lineage.euid
service.runtimeDetails.context.targetProcess.lineage.executablePath
service.runtimeDetails.context.targetProcess.lineage.name
service.runtimeDetails.context.targetProcess.lineage.namespacePid
service.runtimeDetails.context.targetProcess.lineage.parentUuid
service.runtimeDetails.context.targetProcess.lineage.pid
service.runtimeDetails.context.targetProcess.lineage.startTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.context.targetProcess.lineage.userId
service.runtimeDetails.context.targetProcess.lineage.uuid
service.runtimeDetails.context.targetProcess.name
service.runtimeDetails.context.targetProcess.namespacePid
service.runtimeDetails.context.targetProcess.parentUuid
service.runtimeDetails.context.targetProcess.pid
service.runtimeDetails.context.targetProcess.pwd
service.runtimeDetails.context.targetProcess.startTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.context.targetProcess.user
service.runtimeDetails.context.targetProcess.userId
service.runtimeDetails.context.targetProcess.uuid
service.runtimeDetails.context.threatFilePath
service.runtimeDetails.context.toolCategory
service.runtimeDetails.context.toolName
service.runtimeDetails.process.euid
service.runtimeDetails.process.executablePath
service.runtimeDetails.process.executableSha256
service.runtimeDetails.process.lineage.euid
service.runtimeDetails.process.lineage.executablePath
service.runtimeDetails.process.lineage.name
service.runtimeDetails.process.lineage.namespacePid
service.runtimeDetails.process.lineage.parentUuid
service.runtimeDetails.process.lineage.pid
service.runtimeDetails.process.lineage.startTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.process.lineage.userId
service.runtimeDetails.process.lineage.uuid
service.runtimeDetails.process.name
service.runtimeDetails.process.namespacePid
service.runtimeDetails.process.parentUuid
service.runtimeDetails.process.pid
service.runtimeDetails.process.pwd
service.runtimeDetails.process.startTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.process.user
service.runtimeDetails.process.userId
service.runtimeDetails.process.uuid
service.serviceName
service.userFeedback
severity
To configure severity based filters, use the following for the FindingCriteria condition:
Low: [\"1\", \"2\", \"3\"]
Medium: [\"4\", \"5\", \"6\"]
High: [\"7\", \"8\"]
Critical: [\"9\", \"10\"]
For more information, see Findings severity levels in the Amazon GuardDuty User Guide.
type
updatedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
The idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a new filter resource.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateFilterResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#FilterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the successfully created filter.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateIPSetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new IPSet, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure communication with Amazon Web Services infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the administrator account can use this operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/ipset", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateIPSetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The user-friendly name to identify the IPSet.
Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#IpSetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The format of the file that contains the IPSet.
", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the file that contains the IPSet.
", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.
", + "smithy.api#jsonName": "activate", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a new IP set resource.
", + "smithy.api#jsonName": "tags" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.
", + "smithy.api#jsonName": "expectedBucketOwner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateIPSetResponse": { + "type": "structure", + "members": { + "IpSetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the IPSet resource.
", + "smithy.api#jsonName": "ipSetId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateInvestigation": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateInvestigationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateInvestigationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "This API is currently available as a preview. During the preview, you can initiate up to 10 investigations per account per day, with a total limit of 100 investigations per account. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo).
Initiates a GuardDuty investigation that automatically analyzes security findings, correlates related activity, performs account-level analysis, and produces a structured investigation summary with recommended next steps.
Only the administrator account can create an investigation. Member accounts don't have permission to create investigations from their accounts.
To use this operation, the AI_ANALYST feature must be enabled on your detector.
This feature uses Amazon Bedrock models that leverage Cross-Region Inference (CRIS), which automatically selects the optimal Amazon Web Services Region within your geography to process the investigation analysis and generate the investigation report. This maximizes available compute resources, model availability, and delivers the best customer experience. Your data remains stored only in the Region where the investigation request originates, however, investigation data and summary results may be processed outside that Region. All data is transmitted encrypted across Amazon's secure network. For more information, see GuardDuty Investigation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/investigation", + "code": 202 + } + } + }, + "com.amazonaws.guardduty#CreateInvestigationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the GuardDuty detector for the account in which the investigation is created.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A natural-language description of what to investigate. For example:
\"Investigate finding 1ab2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 in account 123456789012\"
\"Analyze findings in account with id 123456789012\"
\"Analyze findings in my organization\"
The idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateInvestigationResponse": { + "type": "structure", + "members": { + "InvestigationId": { + "target": "com.amazonaws.guardduty#InvestigationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the newly created investigation.
", + "smithy.api#jsonName": "investigationId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateMalwareProtectionPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateMalwareProtectionPlanRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateMalwareProtectionPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#ConflictException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new Malware Protection plan for the protected resource.
When you create a Malware Protection plan, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuardDuty Malware Protection.
", + "smithy.api#http": { + "method": "POST", + "uri": "/malware-protection-plan", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateMalwareProtectionPlanRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "Role": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Amazon Resource Name (ARN) of the IAM role that has the permissions to scan and add tags to the associated protected resource.
", + "smithy.api#jsonName": "role", + "smithy.api#required": {} + } + }, + "ProtectedResource": { + "target": "com.amazonaws.guardduty#CreateProtectedResource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource.
Information about whether the tags will be added to the S3 object after scanning.
", + "smithy.api#jsonName": "actions" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "Tags added to the Malware Protection plan resource.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateMalwareProtectionPlanResponse": { + "type": "structure", + "members": { + "MalwareProtectionPlanId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "A unique identifier associated with the Malware Protection plan resource.
", + "smithy.api#jsonName": "malwareProtectionPlanId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account IDs. This step is a prerequisite for managing the associated member accounts either by invitation or through an organization.
As a delegated administrator, using CreateMembers will enable GuardDuty in the added member accounts, with the exception of the organization delegated administrator account. A delegated administrator must enable GuardDuty prior to being added as a member.
When you use CreateMembers as an Organizations delegated administrator, GuardDuty applies your organization's auto-enable settings to the member accounts in this request, irrespective of the accounts being new or existing members. For more information about the existing auto-enable settings for your organization, see DescribeOrganizationConfiguration.
If you disassociate a member account that was added by invitation, the member account details obtained from this API, including the associated email addresses, will be retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
When the member accounts added through Organizations are later disassociated, you (administrator) can't invite them by calling the InviteMembers API. You can create an association with these member accounts again only by calling the CreateMembers API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateMembersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account for which you want to associate member accounts.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A list of account ID and email address pairs of the accounts that you want to associate with the GuardDuty administrator account.
", + "smithy.api#jsonName": "accountDetails", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that include the accountIds of the unprocessed accounts and a result string that explains why each was unprocessed.
Information about the protected S3 bucket resource.
", + "smithy.api#jsonName": "s3Bucket" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource.
Creates a publishing destination where you can export your GuardDuty findings. Before you start exporting the findings, the destination resource must exist.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/publishingDestination", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreatePublishingDestinationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the GuardDuty detector associated with the publishing destination.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.
", + "smithy.api#jsonName": "destinationType", + "smithy.api#required": {} + } + }, + "DestinationProperties": { + "target": "com.amazonaws.guardduty#DestinationProperties", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.
", + "smithy.api#jsonName": "destinationProperties", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a new publishing destination resource.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreatePublishingDestinationResponse": { + "type": "structure", + "members": { + "DestinationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the publishing destination that is created.
", + "smithy.api#jsonName": "destinationId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateS3BucketResource": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Name of the S3 bucket.
", + "smithy.api#jsonName": "bucketName" + } + }, + "ObjectPrefixes": { + "target": "com.amazonaws.guardduty#MalwareProtectionPlanObjectPrefixesList", + "traits": { + "smithy.api#documentation": "Information about the specified object prefixes. The S3 object will be scanned only if it belongs to any of the specified object prefixes.
", + "smithy.api#jsonName": "objectPrefixes" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the protected S3 bucket resource.
" + } + }, + "com.amazonaws.guardduty#CreateSampleFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateSampleFindingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateSampleFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Generates sample findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes, the API generates sample findings of all supported finding types.
The ID of the detector for which you need to create sample findings.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The types of sample findings to generate.
", + "smithy.api#jsonName": "findingTypes" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateSampleFindingsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateThreatEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateThreatEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateThreatEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new threat entity set. In a threat entity set, you can provide known malicious threat entities for your Amazon Web Services environment. GuardDuty generates findings based on the entries in the threat entity sets. Only users of the administrator account can manage entity sets, which automatically apply to member accounts.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/threatentityset", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateThreatEntitySetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account for which you want to create a threat entity set.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A user-friendly name to identify the threat entity set.
The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#ThreatEntitySetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The format of the file that contains the threat entity set.
", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the file that contains the threat entity set. The format of the Location URL must be a valid Amazon S3 URL format. Invalid URL formats will result in an error, regardless of whether you activate the entity set or not. For more information about format of the location URLs, see Format of location URL under Step 2: Adding trusted or threat intelligence data in the Amazon GuardDuty User Guide.
The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.
", + "smithy.api#jsonName": "expectedBucketOwner" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A boolean value that indicates whether GuardDuty should start using the uploaded threat entity set to generate findings.
", + "smithy.api#jsonName": "activate", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a new threat entity set resource.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateThreatEntitySetResponse": { + "type": "structure", + "members": { + "ThreatEntitySetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID returned by GuardDuty after creation of the threat entity set resource.
", + "smithy.api#jsonName": "threatEntitySetId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateThreatIntelSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateThreatIntelSetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateThreatIntelSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the administrator account can use this operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/threatintelset", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateThreatIntelSetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account for which you want to create a threatIntelSet.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#ThreatIntelSetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The format of the file that contains the ThreatIntelSet.
", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the file that contains the ThreatIntelSet.
", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A Boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.
", + "smithy.api#jsonName": "activate", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a new threat list resource.
", + "smithy.api#jsonName": "tags" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.
", + "smithy.api#jsonName": "expectedBucketOwner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateThreatIntelSetResponse": { + "type": "structure", + "members": { + "ThreatIntelSetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the ThreatIntelSet resource.
", + "smithy.api#jsonName": "threatIntelSetId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateTrustedEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateTrustedEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateTrustedEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new trusted entity set. In the trusted entity set, you can provide IP addresses and domains that you believe are secure for communication in your Amazon Web Services environment. GuardDuty will not generate findings for the entries that are specified in a trusted entity set. At any given time, you can have only one trusted entity set.
Only users of the administrator account can manage the entity sets, which automatically apply to member accounts.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/trustedentityset", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateTrustedEntitySetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account for which you want to create a trusted entity set.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A user-friendly name to identify the trusted entity set.
The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#TrustedEntitySetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The format of the file that contains the trusted entity set.
", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the file that contains the threat entity set. The format of the Location URL must be a valid Amazon S3 URL format. Invalid URL formats will result in an error, regardless of whether you activate the entity set or not. For more information about format of the location URLs, see Format of location URL under Step 2: Adding trusted or threat intelligence data in the Amazon GuardDuty User Guide.
The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.
", + "smithy.api#jsonName": "expectedBucketOwner" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A boolean value that indicates whether GuardDuty is to start using the uploaded trusted entity set.
", + "smithy.api#jsonName": "activate", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a new trusted entity set resource.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateTrustedEntitySetResponse": { + "type": "structure", + "members": { + "TrustedEntitySetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID returned by GuardDuty after creation of the trusted entity set resource.
", + "smithy.api#jsonName": "trustedEntitySetId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#Criterion": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#Condition" + } + }, + "com.amazonaws.guardduty#CriterionKey": { + "type": "enum", + "members": { + "EC2_INSTANCE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_INSTANCE_ARN" + } + }, + "SCAN_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_ID" + } + }, + "ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_ID" + } + }, + "GUARDDUTY_FINDING_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GUARDDUTY_FINDING_ID" + } + }, + "SCAN_START_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_START_TIME" + } + }, + "SCAN_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_STATUS" + } + }, + "SCAN_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_TYPE" + } + } + } + }, + "com.amazonaws.guardduty#DNSLogsConfigurationResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Denotes whether DNS logs is enabled as a data source.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the status of DNS logs as a data source.
" + } + }, + "com.amazonaws.guardduty#DataSource": { + "type": "enum", + "members": { + "FLOW_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOW_LOGS" + } + }, + "CLOUD_TRAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUD_TRAIL" + } + }, + "DNS_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DNS_LOGS" + } + }, + "S3_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_LOGS" + } + }, + "KUBERNETES_AUDIT_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KUBERNETES_AUDIT_LOGS" + } + }, + "EC2_MALWARE_SCAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_MALWARE_SCAN" + } + } + } + }, + "com.amazonaws.guardduty#DataSourceConfigurations": { + "type": "structure", + "members": { + "S3Logs": { + "target": "com.amazonaws.guardduty#S3LogsConfiguration", + "traits": { + "smithy.api#documentation": "Describes whether S3 data event logs are enabled as a data source.
", + "smithy.api#jsonName": "s3Logs" + } + }, + "Kubernetes": { + "target": "com.amazonaws.guardduty#KubernetesConfiguration", + "traits": { + "smithy.api#documentation": "Describes whether any Kubernetes logs are enabled as data sources.
", + "smithy.api#jsonName": "kubernetes" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#MalwareProtectionConfiguration", + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection is enabled as a data source.
", + "smithy.api#jsonName": "malwareProtection" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about which data sources are enabled.
" + } + }, + "com.amazonaws.guardduty#DataSourceConfigurationsResult": { + "type": "structure", + "members": { + "CloudTrail": { + "target": "com.amazonaws.guardduty#CloudTrailConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object that contains information on the status of CloudTrail as a data source.
", + "smithy.api#jsonName": "cloudTrail", + "smithy.api#required": {} + } + }, + "DNSLogs": { + "target": "com.amazonaws.guardduty#DNSLogsConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object that contains information on the status of DNS logs as a data source.
", + "smithy.api#jsonName": "dnsLogs", + "smithy.api#required": {} + } + }, + "FlowLogs": { + "target": "com.amazonaws.guardduty#FlowLogsConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object that contains information on the status of VPC flow logs as a data source.
", + "smithy.api#jsonName": "flowLogs", + "smithy.api#required": {} + } + }, + "S3Logs": { + "target": "com.amazonaws.guardduty#S3LogsConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object that contains information on the status of S3 Data event logs as a data source.
", + "smithy.api#jsonName": "s3Logs", + "smithy.api#required": {} + } + }, + "Kubernetes": { + "target": "com.amazonaws.guardduty#KubernetesConfigurationResult", + "traits": { + "smithy.api#documentation": "An object that contains information on the status of all Kubernetes data sources.
", + "smithy.api#jsonName": "kubernetes" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#MalwareProtectionConfigurationResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection data sources.
", + "smithy.api#jsonName": "malwareProtection" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the status of data sources for the detector.
" + } + }, + "com.amazonaws.guardduty#DataSourceFreeTrial": { + "type": "structure", + "members": { + "FreeTrialDaysRemaining": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "A value that specifies the number of days left to use each enabled data source.
", + "smithy.api#jsonName": "freeTrialDaysRemaining" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about which data sources are enabled for the GuardDuty member account.
" + } + }, + "com.amazonaws.guardduty#DataSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#DataSource" + } + }, + "com.amazonaws.guardduty#DataSourceStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#DataSourcesFreeTrial": { + "type": "structure", + "members": { + "CloudTrail": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether any Amazon Web Services CloudTrail management event logs are enabled as data sources.
", + "smithy.api#jsonName": "cloudTrail" + } + }, + "DnsLogs": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether any DNS logs are enabled as data sources.
", + "smithy.api#jsonName": "dnsLogs" + } + }, + "FlowLogs": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether any VPC Flow logs are enabled as data sources.
", + "smithy.api#jsonName": "flowLogs" + } + }, + "S3Logs": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether any S3 data event logs are enabled as data sources.
", + "smithy.api#jsonName": "s3Logs" + } + }, + "Kubernetes": { + "target": "com.amazonaws.guardduty#KubernetesDataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether any Kubernetes logs are enabled as data sources.
", + "smithy.api#jsonName": "kubernetes" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#MalwareProtectionDataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection is enabled as a data source.
", + "smithy.api#jsonName": "malwareProtection" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about which data sources are enabled for the GuardDuty member account.
" + } + }, + "com.amazonaws.guardduty#DateStatistics": { + "type": "structure", + "members": { + "Date": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the total findings count is observed.
For example, Date would look like \"2024-09-05T17:00:00-07:00\" whereas LastGeneratedAt would look like 2024-09-05T17:12:29-07:00\".
The timestamp at which the last finding in the findings count, was generated.
", + "smithy.api#jsonName": "lastGeneratedAt" + } + }, + "Severity": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#documentation": "The severity of the findings generated on each date.
", + "smithy.api#jsonName": "severity" + } + }, + "TotalFindings": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The total number of findings that were generated per severity level on each date.
", + "smithy.api#jsonName": "totalFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents list a map of dates with a count of total findings generated on each date.
" + } + }, + "com.amazonaws.guardduty#DeclineInvitations": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeclineInvitationsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeclineInvitationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Declines invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
", + "smithy.api#http": { + "method": "POST", + "uri": "/invitation/decline", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeclineInvitationsRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of account IDs of the Amazon Web Services accounts that sent invitations to the current member account that you want to decline invitations from.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeclineInvitationsResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DefaultServerSideEncryption": { + "type": "structure", + "members": { + "EncryptionType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The type of encryption used for objects within the S3 bucket.
", + "smithy.api#jsonName": "encryptionType" + } + }, + "KmsMasterKeyArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS encryption key. Only available if the bucket EncryptionType is aws:kms.
Contains information on the server side encryption method used in the S3 bucket. See S3 Server-Side Encryption for more information.
" + } + }, + "com.amazonaws.guardduty#DeleteDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteDetectorRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeleteDetectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon GuardDuty detector that is specified by the detector ID.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/detector/{DetectorId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeleteDetectorRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that you want to delete.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
Deletes the filter specified by the filter name.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/detector/{DetectorId}/filter/{FilterName}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeleteFilterRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that is associated with the filter.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The name of the filter that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteFilterResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeleteIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteIPSetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeleteIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP lists in the console user interface.
The unique ID of the detector associated with the IPSet.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the IPSet to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteIPSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeleteInvitations": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteInvitationsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeleteInvitationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
", + "smithy.api#http": { + "method": "POST", + "uri": "/invitation/delete", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeleteInvitationsRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of account IDs of the Amazon Web Services accounts that sent invitations to the current member account that you want to delete invitations from.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteInvitationsResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeleteMalwareProtectionPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteMalwareProtectionPlanRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + }, + { + "target": "com.amazonaws.guardduty#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the Malware Protection plan ID associated with the Malware Protection plan resource. Use this API only when you no longer want to protect the resource associated with this Malware Protection plan ID.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/malware-protection-plan/{MalwareProtectionPlanId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeleteMalwareProtectionPlanRequest": { + "type": "structure", + "members": { + "MalwareProtectionPlanId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique identifier associated with Malware Protection plan resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeleteMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.
With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disable GuardDuty for a member account in your organization.
The unique ID of the detector of the GuardDuty account whose members you want to delete.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A list of account IDs of the GuardDuty member accounts that you want to delete.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The accounts that could not be processed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeletePublishingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeletePublishingDestinationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeletePublishingDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the publishing definition with the specified destinationId.
The unique ID of the detector associated with the publishing destination to delete.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The ID of the publishing destination to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeletePublishingDestinationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeleteThreatEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteThreatEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeleteThreatEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the threat entity set that is associated with the specified threatEntitySetId.
The unique ID of the detector associated with the threat entity set resource.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique ID that helps GuardDuty identify which threat entity set needs to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteThreatEntitySetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeleteThreatIntelSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteThreatIntelSetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeleteThreatIntelSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/detector/{DetectorId}/threatintelset/{ThreatIntelSetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeleteThreatIntelSetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that is associated with the threatIntelSet.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the threatIntelSet that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteThreatIntelSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeleteTrustedEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteTrustedEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeleteTrustedEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the trusted entity set that is associated with the specified trustedEntitySetId.
The unique ID of the detector associated with the trusted entity set resource.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique ID that helps GuardDuty identify which trusted entity set needs to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteTrustedEntitySetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DescribeMalwareScans": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DescribeMalwareScansRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DescribeMalwareScansResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of malware scans. Each member account can view the malware scans for their own accounts. An administrator can view the malware scans for all the member accounts.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/malware-scans", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Scans", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#DescribeMalwareScansRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the request is associated with.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "smithy.api#jsonName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#IntegerValueWithMax", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
", + "smithy.api#jsonName": "maxResults" + } + }, + "FilterCriteria": { + "target": "com.amazonaws.guardduty#FilterCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria to be used in the filter for describing scan entries.
", + "smithy.api#jsonName": "filterCriteria" + } + }, + "SortCriteria": { + "target": "com.amazonaws.guardduty#SortCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used for sorting scan entries. The attributeName is required and it must be scanStartTime.
Contains information about malware scans associated with GuardDuty Malware Protection for EC2.
", + "smithy.api#jsonName": "scans", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DescribeOrganizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DescribeOrganizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DescribeOrganizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about the account selected as the delegated administrator for GuardDuty.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/admin", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#DescribeOrganizationConfigurationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detector ID of the delegated administrator for which you need to retrieve the information.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
You can use this parameter to indicate the maximum number of items that you want in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Indicates whether GuardDuty is automatically enabled for accounts added to the organization.
Even though this is still supported, we recommend using AutoEnableOrganizationMembers to achieve the similar results.
Indicates whether the maximum number of allowed member accounts are already associated with the delegated administrator account for your organization.
", + "smithy.api#jsonName": "memberAccountLimitReached", + "smithy.api#required": {} + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#OrganizationDataSourceConfigurationsResult", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Describes which data sources are enabled automatically for member accounts.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#OrganizationFeaturesConfigurationsResults", + "traits": { + "smithy.api#documentation": "A list of features that are configured for this organization.
", + "smithy.api#jsonName": "features" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + }, + "AutoEnableOrganizationMembers": { + "target": "com.amazonaws.guardduty#AutoEnableMembers", + "traits": { + "smithy.api#documentation": "Indicates the auto-enablement configuration of GuardDuty or any of the corresponding protection plans for the member accounts in the organization.
NEW: Indicates that when a new account joins the organization, they will have GuardDuty or any of the corresponding protection plans enabled automatically.
ALL: Indicates that all accounts in the organization have GuardDuty and any of the corresponding protection plans enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.
NONE: Indicates that GuardDuty or any of the corresponding protection plans will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.
When you update the auto-enable setting from ALL or NEW to NONE, this action doesn't disable the corresponding option for your existing accounts. This configuration will apply to the new accounts that join the organization. After you update the auto-enable settings, no new account will have the corresponding option as enabled.
Returns information about the publishing destination specified by the provided destinationId.
The unique ID of the detector associated with the publishing destination to retrieve.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The ID of the publishing destination to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DescribePublishingDestinationResponse": { + "type": "structure", + "members": { + "DestinationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the publishing destination.
", + "smithy.api#jsonName": "destinationId", + "smithy.api#required": {} + } + }, + "DestinationType": { + "target": "com.amazonaws.guardduty#DestinationType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of publishing destination. Currently, only Amazon S3 buckets are supported.
", + "smithy.api#jsonName": "destinationType", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.guardduty#PublishingStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the publishing destination.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "PublishingFailureStartTimestamp": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.
", + "smithy.api#jsonName": "publishingFailureStartTimestamp", + "smithy.api#required": {} + } + }, + "DestinationProperties": { + "target": "com.amazonaws.guardduty#DestinationProperties", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.
The tags of the publishing destination resource.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#Destination": { + "type": "structure", + "members": { + "DestinationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique ID of the publishing destination.
", + "smithy.api#jsonName": "destinationId", + "smithy.api#required": {} + } + }, + "DestinationType": { + "target": "com.amazonaws.guardduty#DestinationType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of resource used for the publishing destination. Currently, only Amazon S3 buckets are supported.
", + "smithy.api#jsonName": "destinationType", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.guardduty#PublishingStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the publishing destination.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the publishing destination, including the ID, type, and status.
" + } + }, + "com.amazonaws.guardduty#DestinationProperties": { + "type": "structure", + "members": { + "DestinationArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ARN of the resource to publish to.
To specify an S3 bucket folder use the following format: arn:aws:s3:::DOC-EXAMPLE-BUCKET/myFolder/
The ARN of the KMS key to use for encryption.
", + "smithy.api#jsonName": "kmsKeyArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the Amazon Resource Name (ARN) of the resource to publish to, such as an S3 bucket, and the ARN of the KMS key to use to encrypt published findings.
" + } + }, + "com.amazonaws.guardduty#DestinationType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#Destinations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Destination" + } + }, + "com.amazonaws.guardduty#Detection": { + "type": "structure", + "members": { + "Anomaly": { + "target": "com.amazonaws.guardduty#Anomaly", + "traits": { + "smithy.api#documentation": "The details about the anomalous activity that caused GuardDuty to generate the finding.
", + "smithy.api#jsonName": "anomaly" + } + }, + "Sequence": { + "target": "com.amazonaws.guardduty#Sequence", + "traits": { + "smithy.api#documentation": "The details about the attack sequence.
", + "smithy.api#jsonName": "sequence" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the detected behavior.
" + } + }, + "com.amazonaws.guardduty#DetectionSource": { + "type": "enum", + "members": { + "AMAZON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON" + } + }, + "BITDEFENDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BITDEFENDER" + } + } + } + }, + "com.amazonaws.guardduty#DetectorAdditionalConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#FeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "Name of the additional configuration.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "Status of the additional configuration.
", + "smithy.api#jsonName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the additional configuration for a feature in your GuardDuty account.
" + } + }, + "com.amazonaws.guardduty#DetectorAdditionalConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#FeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "Name of the additional configuration.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "Status of the additional configuration.
", + "smithy.api#jsonName": "status" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the additional configuration was last updated. This is in UTC format.
", + "smithy.api#jsonName": "updatedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the additional configuration.
" + } + }, + "com.amazonaws.guardduty#DetectorAdditionalConfigurationResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#DetectorAdditionalConfigurationResult" + } + }, + "com.amazonaws.guardduty#DetectorAdditionalConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#DetectorAdditionalConfiguration" + } + }, + "com.amazonaws.guardduty#DetectorFeature": { + "type": "enum", + "members": { + "S3_DATA_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_DATA_EVENTS" + } + }, + "EKS_AUDIT_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_AUDIT_LOGS" + } + }, + "EBS_MALWARE_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" + } + }, + "RDS_LOGIN_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_LOGIN_EVENTS" + } + }, + "LAMBDA_NETWORK_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" + } + }, + "EKS_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" + } + }, + "RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNTIME_MONITORING" + } + }, + "AI_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AI_PROTECTION" + } + }, + "AI_ANALYST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AI_ANALYST" + } + } + } + }, + "com.amazonaws.guardduty#DetectorFeatureConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#DetectorFeature", + "traits": { + "smithy.api#documentation": "The name of the feature.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "The status of the feature.
", + "smithy.api#jsonName": "status" + } + }, + "AdditionalConfiguration": { + "target": "com.amazonaws.guardduty#DetectorAdditionalConfigurations", + "traits": { + "smithy.api#documentation": "Additional configuration for a resource.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a GuardDuty feature.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can add only one of these two features because Runtime Monitoring already includes the threat detection for Amazon EKS resources. For more information, see Runtime Monitoring.
Indicates the name of the feature that can be enabled for the detector.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the feature that is enabled for the detector.
", + "smithy.api#jsonName": "status" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the feature object was updated.
", + "smithy.api#jsonName": "updatedAt" + } + }, + "AdditionalConfiguration": { + "target": "com.amazonaws.guardduty#DetectorAdditionalConfigurationResults", + "traits": { + "smithy.api#documentation": "Additional configuration for a resource.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a GuardDuty feature.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can add only one of these two features because Runtime Monitoring already includes the threat detection for Amazon EKS resources. For more information, see Runtime Monitoring.
Removes the existing GuardDuty delegated administrator of the organization. Only the organization's management account can run this API operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/admin/disable", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DisableOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "AdminAccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Web Services Account ID for the organizations account to be disabled as a GuardDuty delegated administrator.
", + "smithy.api#jsonName": "adminAccountId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DisableOrganizationAdminAccountResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DisassociateFromAdministratorAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DisassociateFromAdministratorAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DisassociateFromAdministratorAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates the current GuardDuty member account from its administrator account.
When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disable GuardDuty in a member account.
The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DisassociateFromAdministratorAccountResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DisassociateFromMasterAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DisassociateFromMasterAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DisassociateFromMasterAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use DisassociateFromAdministratorAccount instead" + }, + "smithy.api#documentation": "Disassociates the current GuardDuty member account from its administrator account.
When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/master/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DisassociateFromMasterAccountRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This input is deprecated, use DisassociateFromAdministratorAccountRequest instead" + }, + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DisassociateFromMasterAccountResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#deprecated": { + "message": "This output is deprecated, use DisassociateFromAdministratorAccountResponse instead" + }, + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DisassociateMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DisassociateMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DisassociateMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates GuardDuty member accounts (from the current administrator account) specified by the account IDs.
When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disassociate a member account before removing them from your organization.
If you disassociate a member account that was added by invitation, the member account details obtained from this API, including the associated email addresses, will be retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
When the member accounts added through Organizations are later disassociated, you (administrator) can't invite them by calling the InviteMembers API. You can create an association with these member accounts again only by calling the CreateMembers API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DisassociateMembersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account whose members you want to disassociate from the administrator account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of account IDs of the GuardDuty member accounts that you want to disassociate from the administrator account.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DisassociateMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DnsRequestAction": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The domain information for the DNS query.
", + "smithy.api#jsonName": "domain" + } + }, + "Protocol": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The network connection protocol observed in the activity that prompted GuardDuty to generate the finding.
", + "smithy.api#jsonName": "protocol" + } + }, + "Blocked": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the targeted port is blocked.
", + "smithy.api#jsonName": "blocked" + } + }, + "DomainWithSuffix": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The second and top level domain involved in the activity that potentially prompted GuardDuty to generate this finding. For a list of top-level and second-level domains, see public suffix list.
", + "smithy.api#jsonName": "domainWithSuffix" + } + }, + "VpcOwnerAccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the VPC through which the DNS request was made.
", + "smithy.api#jsonName": "vpcOwnerAccountId" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the DNS_REQUEST action described in this finding.
" + } + }, + "com.amazonaws.guardduty#DomainDetails": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The domain information for the Amazon Web Services API call.
", + "smithy.api#jsonName": "domain" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the domain.
" + } + }, + "com.amazonaws.guardduty#Double": { + "type": "double" + }, + "com.amazonaws.guardduty#EbsSnapshot": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The device name of the EBS snapshot that was scanned.
", + "smithy.api#jsonName": "deviceName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an EBS snapshot that was scanned for malware.
" + } + }, + "com.amazonaws.guardduty#EbsSnapshotDetails": { + "type": "structure", + "members": { + "SnapshotArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the EBS snapshot.
", + "smithy.api#jsonName": "snapshotArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the EBS snapshot that was scanned for malware.
" + } + }, + "com.amazonaws.guardduty#EbsSnapshotPreservation": { + "type": "enum", + "members": { + "NO_RETENTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_RETENTION" + } + }, + "RETENTION_WITH_FINDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETENTION_WITH_FINDING" + } + } + } + }, + "com.amazonaws.guardduty#EbsVolumeDetails": { + "type": "structure", + "members": { + "ScannedVolumeDetails": { + "target": "com.amazonaws.guardduty#VolumeDetails", + "traits": { + "smithy.api#documentation": "List of EBS volumes that were scanned.
", + "smithy.api#jsonName": "scannedVolumeDetails" + } + }, + "SkippedVolumeDetails": { + "target": "com.amazonaws.guardduty#VolumeDetails", + "traits": { + "smithy.api#documentation": "List of EBS volumes that were skipped from the malware scan.
", + "smithy.api#jsonName": "skippedVolumeDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains list of scanned and skipped EBS volumes with details.
" + } + }, + "com.amazonaws.guardduty#EbsVolumeScanDetails": { + "type": "structure", + "members": { + "ScanId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Unique Id of the malware scan that generated the finding.
", + "smithy.api#jsonName": "scanId" + } + }, + "ScanStartedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "Returns the start date and time of the malware scan.
", + "smithy.api#jsonName": "scanStartedAt" + } + }, + "ScanCompletedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "Returns the completion date and time of the malware scan.
", + "smithy.api#jsonName": "scanCompletedAt" + } + }, + "TriggerFindingId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "GuardDuty finding ID that triggered a malware scan.
", + "smithy.api#jsonName": "triggerFindingId" + } + }, + "Sources": { + "target": "com.amazonaws.guardduty#Sources", + "traits": { + "smithy.api#documentation": "Contains list of threat intelligence sources used to detect threats.
", + "smithy.api#jsonName": "sources" + } + }, + "ScanDetections": { + "target": "com.amazonaws.guardduty#ScanDetections", + "traits": { + "smithy.api#documentation": "Contains a complete view providing malware scan result details.
", + "smithy.api#jsonName": "scanDetections" + } + }, + "ScanType": { + "target": "com.amazonaws.guardduty#ScanType", + "traits": { + "smithy.api#documentation": "Specifies the scan type that invoked the malware scan.
", + "smithy.api#jsonName": "scanType" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details from the malware scan that created a finding.
" + } + }, + "com.amazonaws.guardduty#EbsVolumesResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#documentation": "Describes whether scanning EBS volumes is enabled as a data source.
", + "smithy.api#jsonName": "status" + } + }, + "Reason": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Specifies the reason why scanning EBS volumes (Malware Protection) was not enabled as a data source.
", + "smithy.api#jsonName": "reason" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration of scanning EBS volumes as a data source.
" + } + }, + "com.amazonaws.guardduty#Ec2Image": { + "type": "structure", + "members": { + "Ec2InstanceUids": { + "target": "com.amazonaws.guardduty#Ec2InstanceUids", + "traits": { + "smithy.api#documentation": "A list of unique identifiers for the compromised Amazon EC2 instances that were launched with the same Amazon Machine Image (AMI).
", + "smithy.api#jsonName": "ec2InstanceUids" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon EC2 Image involved in a GuardDuty finding, including unique identifiers of the Amazon EC2 instances.
" + } + }, + "com.amazonaws.guardduty#Ec2ImageDetails": { + "type": "structure", + "members": { + "ImageArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the EC2 AMI.
", + "smithy.api#jsonName": "imageArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the EC2 AMI that was scanned.
" + } + }, + "com.amazonaws.guardduty#Ec2Instance": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The availability zone of the Amazon EC2 instance. For more information, see Availability zones in the Amazon EC2 User Guide.
", + "smithy.api#jsonName": "availabilityZone" + } + }, + "ImageDescription": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The image description of the Amazon EC2 instance.
", + "smithy.api#jsonName": "imageDescription" + } + }, + "InstanceState": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The state of the Amazon EC2 instance. For more information, see Amazon EC2 instance state changes in the Amazon EC2 User Guide.
", + "smithy.api#jsonName": "instanceState" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.guardduty#IamInstanceProfile" + }, + "InstanceType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Type of the Amazon EC2 instance.
", + "smithy.api#jsonName": "instanceType" + } + }, + "OutpostArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Outpost. This shows applicable Amazon Web Services Outposts instances.
", + "smithy.api#jsonName": "outpostArn" + } + }, + "Platform": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The platform of the Amazon EC2 instance.
", + "smithy.api#jsonName": "platform" + } + }, + "ProductCodes": { + "target": "com.amazonaws.guardduty#ProductCodes", + "traits": { + "smithy.api#documentation": "The product code of the Amazon EC2 instance.
", + "smithy.api#jsonName": "productCodes" + } + }, + "Ec2NetworkInterfaceUids": { + "target": "com.amazonaws.guardduty#Ec2NetworkInterfaceUids", + "traits": { + "smithy.api#documentation": "The ID of the network interface.
", + "smithy.api#jsonName": "ec2NetworkInterfaceUids" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the potentially impacted Amazon EC2 instance resource.
" + } + }, + "com.amazonaws.guardduty#Ec2InstanceUid": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.guardduty#Ec2InstanceUids": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Ec2InstanceUid" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.guardduty#Ec2LaunchTemplate": { + "type": "structure", + "members": { + "Ec2InstanceUids": { + "target": "com.amazonaws.guardduty#Ec2InstanceUids", + "traits": { + "smithy.api#documentation": "A list of unique identifiers for the compromised Amazon EC2 instances that share the same Amazon EC2 launch template.
", + "smithy.api#jsonName": "ec2InstanceUids" + } + }, + "Version": { + "target": "com.amazonaws.guardduty#LaunchTemplateVersion", + "traits": { + "smithy.api#documentation": "Version of the EC2 launch template.
", + "smithy.api#jsonName": "version" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon EC2 launch template involved in a GuardDuty finding, including unique identifiers of the Amazon EC2 instances.
" + } + }, + "com.amazonaws.guardduty#Ec2NetworkInterface": { + "type": "structure", + "members": { + "Ipv6Addresses": { + "target": "com.amazonaws.guardduty#Ipv6Addresses", + "traits": { + "smithy.api#documentation": "A list of IPv6 addresses for the Amazon EC2 instance.
", + "smithy.api#jsonName": "ipv6Addresses" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.guardduty#PrivateIpAddresses", + "traits": { + "smithy.api#documentation": "Other private IP address information of the Amazon EC2 instance.
", + "smithy.api#jsonName": "privateIpAddresses" + } + }, + "PublicIp": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The public IP address of the Amazon EC2 instance.
", + "smithy.api#jsonName": "publicIp" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.guardduty#SecurityGroups", + "traits": { + "smithy.api#documentation": "The security groups associated with the Amazon EC2 instance.
", + "smithy.api#jsonName": "securityGroups" + } + }, + "SubNetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The subnet ID of the Amazon EC2 instance.
", + "smithy.api#jsonName": "subNetId" + } + }, + "VpcId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The VPC ID of the Amazon EC2 instance.
", + "smithy.api#jsonName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the elastic network interface of the Amazon EC2 instance.
" + } + }, + "com.amazonaws.guardduty#Ec2NetworkInterfaceUids": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Ec2Vpc": { + "type": "structure", + "members": { + "Ec2InstanceUids": { + "target": "com.amazonaws.guardduty#Ec2InstanceUids", + "traits": { + "smithy.api#documentation": "A list of unique identifiers for the compromised Amazon EC2 instances that were launched within the same Virtual Private Cloud (VPC).
", + "smithy.api#jsonName": "ec2InstanceUids" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon EC2 VPC involved in a GuardDuty finding, including unique identifiers of the Amazon EC2 instances.
" + } + }, + "com.amazonaws.guardduty#EcsCluster": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#EcsClusterStatus", + "traits": { + "smithy.api#documentation": "The current status of the Amazon ECS cluster.
", + "smithy.api#jsonName": "status" + } + }, + "Ec2InstanceUids": { + "target": "com.amazonaws.guardduty#Ec2InstanceUids", + "traits": { + "smithy.api#documentation": "A list of unique identifiers for the Amazon EC2 instances that serve as container instances in the Amazon ECS cluster.
", + "smithy.api#jsonName": "ec2InstanceUids" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon ECS cluster involved in a GuardDuty finding, including cluster identification and status.
" + } + }, + "com.amazonaws.guardduty#EcsClusterDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the ECS Cluster.
", + "smithy.api#jsonName": "name" + } + }, + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the cluster.
", + "smithy.api#jsonName": "arn" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The status of the ECS cluster.
", + "smithy.api#jsonName": "status" + } + }, + "ActiveServicesCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of services that are running on the cluster in an ACTIVE state.
", + "smithy.api#jsonName": "activeServicesCount" + } + }, + "RegisteredContainerInstancesCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of container instances registered into the cluster.
", + "smithy.api#jsonName": "registeredContainerInstancesCount" + } + }, + "RunningTasksCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of tasks in the cluster that are in the RUNNING state.
", + "smithy.api#jsonName": "runningTasksCount" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "The tags of the ECS Cluster.
", + "smithy.api#jsonName": "tags" + } + }, + "TaskDetails": { + "target": "com.amazonaws.guardduty#EcsTaskDetails", + "traits": { + "smithy.api#documentation": "Contains information about the details of the ECS Task.
", + "smithy.api#jsonName": "taskDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the details of the ECS Cluster.
" + } + }, + "com.amazonaws.guardduty#EcsClusterStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "PROVISIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING" + } + }, + "DEPROVISIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPROVISIONING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } + } + }, + "com.amazonaws.guardduty#EcsLaunchType": { + "type": "enum", + "members": { + "FARGATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FARGATE" + } + }, + "EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2" + } + } + } + }, + "com.amazonaws.guardduty#EcsTask": { + "type": "structure", + "members": { + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp indicating when the Amazon ECS task was created, in UTC format.
", + "smithy.api#jsonName": "createdAt" + } + }, + "TaskDefinitionArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ARN of task definition which describes the container and volume definitions of the Amazon ECS task.
", + "smithy.api#jsonName": "taskDefinitionArn" + } + }, + "LaunchType": { + "target": "com.amazonaws.guardduty#EcsLaunchType", + "traits": { + "smithy.api#documentation": "The infrastructure type on which the Amazon ECS task runs.
", + "smithy.api#jsonName": "launchType" + } + }, + "ContainerUids": { + "target": "com.amazonaws.guardduty#ContainerUids", + "traits": { + "smithy.api#documentation": "A list of unique identifiers for the containers associated with the Amazon ECS task.
", + "smithy.api#jsonName": "containerUids" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about Amazon ECS task involved in a GuardDuty finding, including task definition and container identifiers.
" + } + }, + "com.amazonaws.guardduty#EcsTaskDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task.
", + "smithy.api#jsonName": "arn" + } + }, + "DefinitionArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ARN of the task definition that creates the task.
", + "smithy.api#jsonName": "definitionArn" + } + }, + "Version": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version counter for the task.
", + "smithy.api#jsonName": "version" + } + }, + "TaskCreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task was created.
", + "smithy.api#jsonName": "createdAt" + } + }, + "StartedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task started.
", + "smithy.api#jsonName": "startedAt" + } + }, + "StartedBy": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Contains the tag specified when a task is started.
", + "smithy.api#jsonName": "startedBy" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "The tags of the ECS Task.
", + "smithy.api#jsonName": "tags" + } + }, + "Volumes": { + "target": "com.amazonaws.guardduty#Volumes", + "traits": { + "smithy.api#documentation": "The list of data volume definitions for the task.
", + "smithy.api#jsonName": "volumes" + } + }, + "Containers": { + "target": "com.amazonaws.guardduty#Containers", + "traits": { + "smithy.api#documentation": "The containers that's associated with the task.
", + "smithy.api#jsonName": "containers" + } + }, + "Group": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the task group that's associated with the task.
", + "smithy.api#jsonName": "group" + } + }, + "LaunchType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "A capacity on which the task is running. For example, Fargate and EC2.
Contains information about the task in an ECS cluster.
" + } + }, + "com.amazonaws.guardduty#EksCluster": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the Amazon EKS cluster involved in the finding.
", + "smithy.api#jsonName": "arn" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp indicating when the Amazon EKS cluster was created, in UTC format.
", + "smithy.api#jsonName": "createdAt" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#ClusterStatus", + "traits": { + "smithy.api#documentation": "The current status of the Amazon EKS cluster.
", + "smithy.api#jsonName": "status" + } + }, + "VpcId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Virtual Private Cloud (Amazon VPC) associated with the Amazon EKS cluster.
", + "smithy.api#jsonName": "vpcId" + } + }, + "Ec2InstanceUids": { + "target": "com.amazonaws.guardduty#Ec2InstanceUids", + "traits": { + "smithy.api#documentation": "A list of unique identifiers for the Amazon EC2 instances that serve as worker nodes in the Amazon EKS cluster.
", + "smithy.api#jsonName": "ec2InstanceUids" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon EKS cluster involved in a GuardDuty finding, including cluster identification, status, and network configuration.
" + } + }, + "com.amazonaws.guardduty#EksClusterDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EKS cluster name.
", + "smithy.api#jsonName": "name" + } + }, + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EKS cluster ARN.
", + "smithy.api#jsonName": "arn" + } + }, + "VpcId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The VPC ID to which the EKS cluster is attached.
", + "smithy.api#jsonName": "vpcId" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The EKS cluster status.
", + "smithy.api#jsonName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "The EKS cluster tags.
", + "smithy.api#jsonName": "tags" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the EKS cluster was created.
", + "smithy.api#jsonName": "createdAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the EKS cluster involved in a Kubernetes finding.
" + } + }, + "com.amazonaws.guardduty#Email": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.guardduty#EnableOrganizationAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Designates an Amazon Web Services account within the organization as your GuardDuty delegated administrator. Only the organization's management account can run this API operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/admin/enable", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#EnableOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "AdminAccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Web Services account ID for the organization account to be enabled as a GuardDuty delegated administrator.
", + "smithy.api#jsonName": "adminAccountId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#EnableOrganizationAdminAccountResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#EndpointIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, + "com.amazonaws.guardduty#Eq": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Equals": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Evidence": { + "type": "structure", + "members": { + "ThreatIntelligenceDetails": { + "target": "com.amazonaws.guardduty#ThreatIntelligenceDetails", + "traits": { + "smithy.api#documentation": "A list of threat intelligence details related to the evidence.
", + "smithy.api#jsonName": "threatIntelligenceDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the reason that the finding was generated.
" + } + }, + "com.amazonaws.guardduty#ExpectedBucketOwner": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.guardduty#FargateDetails": { + "type": "structure", + "members": { + "Issues": { + "target": "com.amazonaws.guardduty#Issues", + "traits": { + "smithy.api#documentation": "Runtime coverage issues identified for the resource running on Amazon Web Services Fargate.
", + "smithy.api#jsonName": "issues" + } + }, + "ManagementType": { + "target": "com.amazonaws.guardduty#ManagementType", + "traits": { + "smithy.api#documentation": "Indicates how the GuardDuty security agent is managed for this resource.
AUTO_MANAGED indicates that GuardDuty deploys and manages updates for this resource.
DISABLED indicates that the deployment of the GuardDuty security agent is disabled for this resource.
The MANUAL status doesn't apply to the Amazon Web Services Fargate (Amazon ECS only) woprkloads.
Contains information about Amazon Web Services Fargate details associated with an Amazon ECS cluster.
" + } + }, + "com.amazonaws.guardduty#FeatureAdditionalConfiguration": { + "type": "enum", + "members": { + "EKS_ADDON_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_ADDON_MANAGEMENT" + } + }, + "ECS_FARGATE_AGENT_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS_FARGATE_AGENT_MANAGEMENT" + } + }, + "EC2_AGENT_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_AGENT_MANAGEMENT" + } + } + } + }, + "com.amazonaws.guardduty#FeatureStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.guardduty#Feedback": { + "type": "enum", + "members": { + "USEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USEFUL" + } + }, + "NOT_USEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_USEFUL" + } + } + } + }, + "com.amazonaws.guardduty#FilePaths": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ScanFilePath" + } + }, + "com.amazonaws.guardduty#FilterAction": { + "type": "enum", + "members": { + "NOOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOOP" + } + }, + "ARCHIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVE" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#FilterCondition": { + "type": "structure", + "members": { + "EqualsValue": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "Represents an equal condition to be applied to a single field when querying for scan entries.
", + "smithy.api#jsonName": "equalsValue" + } + }, + "GreaterThan": { + "target": "com.amazonaws.guardduty#LongValue", + "traits": { + "smithy.api#documentation": "Represents a greater than condition to be applied to a single field when querying for scan entries.
", + "smithy.api#jsonName": "greaterThan" + } + }, + "LessThan": { + "target": "com.amazonaws.guardduty#LongValue", + "traits": { + "smithy.api#documentation": "Represents a less than condition to be applied to a single field when querying for scan entries.
", + "smithy.api#jsonName": "lessThan" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the condition.
" + } + }, + "com.amazonaws.guardduty#FilterCriteria": { + "type": "structure", + "members": { + "FilterCriterion": { + "target": "com.amazonaws.guardduty#FilterCriterionList", + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the operation.
", + "smithy.api#jsonName": "filterCriterion" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the criteria to be used in the filter for describing scan entries.
" + } + }, + "com.amazonaws.guardduty#FilterCriterion": { + "type": "structure", + "members": { + "CriterionKey": { + "target": "com.amazonaws.guardduty#CriterionKey", + "traits": { + "smithy.api#documentation": "An enum value representing possible scan properties to match with given scan entries.
", + "smithy.api#jsonName": "criterionKey" + } + }, + "FilterCondition": { + "target": "com.amazonaws.guardduty#FilterCondition", + "traits": { + "smithy.api#documentation": "Contains information about the condition.
", + "smithy.api#jsonName": "filterCondition" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the operation. Irrespective of using any filter criteria, an administrator account can view the scan entries for all of its member accounts. However, each member account can view the scan entries only for their own account.
" + } + }, + "com.amazonaws.guardduty#FilterCriterionList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FilterCriterion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.guardduty#FilterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.guardduty#FilterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + } + } + }, + "com.amazonaws.guardduty#FilterNames": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FilterName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#FilterRank": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.guardduty#FilterVersion": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.guardduty#Finding": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the account in which the finding was generated.
", + "smithy.api#jsonName": "accountId", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the finding.
", + "smithy.api#jsonName": "arn", + "smithy.api#required": {} + } + }, + "Confidence": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#documentation": "The confidence score for the finding.
", + "smithy.api#jsonName": "confidence" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time and date when the finding was created.
", + "smithy.api#jsonName": "createdAt", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The description of the finding.
", + "smithy.api#jsonName": "description" + } + }, + "Id": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the finding.
", + "smithy.api#jsonName": "id", + "smithy.api#required": {} + } + }, + "Partition": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The partition associated with the finding.
", + "smithy.api#jsonName": "partition" + } + }, + "Region": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Region where the finding was generated. For findings generated from Global Service Events, the Region value in the finding might differ from the Region where GuardDuty identifies the potential threat. For more information, see How GuardDuty handles Amazon Web Services CloudTrail global events in the Amazon GuardDuty User Guide.
", + "smithy.api#jsonName": "region", + "smithy.api#required": {} + } + }, + "Resource": { + "target": "com.amazonaws.guardduty#Resource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "resource", + "smithy.api#required": {} + } + }, + "SchemaVersion": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version of the schema used for the finding.
", + "smithy.api#jsonName": "schemaVersion", + "smithy.api#required": {} + } + }, + "Service": { + "target": "com.amazonaws.guardduty#Service", + "traits": { + "smithy.api#jsonName": "service" + } + }, + "Severity": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The severity of the finding.
", + "smithy.api#jsonName": "severity", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The title of the finding.
", + "smithy.api#jsonName": "title" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#FindingType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of finding.
", + "smithy.api#jsonName": "type", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time and date when the finding was last updated.
", + "smithy.api#jsonName": "updatedAt", + "smithy.api#required": {} + } + }, + "AssociatedAttackSequenceArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) associated with the attack sequence finding.
", + "smithy.api#jsonName": "associatedAttackSequenceArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the finding that is generated when abnormal or suspicious activity is detected.
" + } + }, + "com.amazonaws.guardduty#FindingCriteria": { + "type": "structure", + "members": { + "Criterion": { + "target": "com.amazonaws.guardduty#Criterion", + "traits": { + "smithy.api#documentation": "Represents a map of finding properties that match specified conditions and values when querying findings.
", + "smithy.api#jsonName": "criterion" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the criteria used for querying findings.
" + } + }, + "com.amazonaws.guardduty#FindingId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#FindingIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FindingId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#FindingPublishingFrequency": { + "type": "enum", + "members": { + "FIFTEEN_MINUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIFTEEN_MINUTES" + } + }, + "ONE_HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_HOUR" + } + }, + "SIX_HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIX_HOURS" + } + } + } + }, + "com.amazonaws.guardduty#FindingResourceType": { + "type": "enum", + "members": { + "EC2_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_INSTANCE" + } + }, + "EC2_NETWORK_INTERFACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_NETWORK_INTERFACE" + } + }, + "S3_BUCKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_BUCKET" + } + }, + "S3_OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_OBJECT" + } + }, + "ACCESS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_KEY" + } + }, + "EKS_CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_CLUSTER" + } + }, + "KUBERNETES_WORKLOAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KUBERNETES_WORKLOAD" + } + }, + "CONTAINER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINER" + } + }, + "ECS_CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS_CLUSTER" + } + }, + "ECS_TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS_TASK" + } + }, + "AUTOSCALING_AUTO_SCALING_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOSCALING_AUTO_SCALING_GROUP" + } + }, + "IAM_INSTANCE_PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_INSTANCE_PROFILE" + } + }, + "CLOUDFORMATION_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDFORMATION_STACK" + } + }, + "EC2_LAUNCH_TEMPLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_LAUNCH_TEMPLATE" + } + }, + "EC2_VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_VPC" + } + }, + "EC2_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_IMAGE" + } + } + } + }, + "com.amazonaws.guardduty#FindingStatisticType": { + "type": "enum", + "members": { + "COUNT_BY_SEVERITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT_BY_SEVERITY" + } + } + } + }, + "com.amazonaws.guardduty#FindingStatisticTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FindingStatisticType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.guardduty#FindingStatistics": { + "type": "structure", + "members": { + "CountBySeverity": { + "target": "com.amazonaws.guardduty#CountBySeverity", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated. Please set GroupBy to 'SEVERITY' to return GroupedBySeverity instead." + }, + "smithy.api#documentation": "Represents a list of map of severity to count statistics for a set of findings.
", + "smithy.api#jsonName": "countBySeverity" + } + }, + "GroupedByAccount": { + "target": "com.amazonaws.guardduty#GroupedByAccount", + "traits": { + "smithy.api#documentation": "Represents a list of map of accounts with a findings count associated with each account.
", + "smithy.api#jsonName": "groupedByAccount" + } + }, + "GroupedByDate": { + "target": "com.amazonaws.guardduty#GroupedByDate", + "traits": { + "smithy.api#documentation": "Represents a list of map of dates with a count of total findings generated on each date per severity level.
", + "smithy.api#jsonName": "groupedByDate" + } + }, + "GroupedByFindingType": { + "target": "com.amazonaws.guardduty#GroupedByFindingType", + "traits": { + "smithy.api#documentation": "Represents a list of map of finding types with a count of total findings generated for each type.
Based on the orderBy parameter, this request returns either the most occurring finding types or the least occurring finding types. If the orderBy parameter is ASC, this will represent the least occurring finding types in your account; otherwise, this will represent the most occurring finding types. The default value of orderBy is DESC.
Represents a list of map of top resources with a count of total findings.
", + "smithy.api#jsonName": "groupedByResource" + } + }, + "GroupedBySeverity": { + "target": "com.amazonaws.guardduty#GroupedBySeverity", + "traits": { + "smithy.api#documentation": "Represents a list of map of total findings for each severity level.
", + "smithy.api#jsonName": "groupedBySeverity" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about finding statistics.
" + } + }, + "com.amazonaws.guardduty#FindingType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.guardduty#FindingTypeStatistics": { + "type": "structure", + "members": { + "FindingType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Name of the finding type.
", + "smithy.api#jsonName": "findingType" + } + }, + "LastGeneratedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which this finding type was last generated in your environment.
", + "smithy.api#jsonName": "lastGeneratedAt" + } + }, + "TotalFindings": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The total number of findings associated with generated for each distinct finding type.
", + "smithy.api#jsonName": "totalFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about each finding type associated with the groupedByFindingType statistics.
Denotes whether VPC flow logs is enabled as a data source.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the status of VPC flow logs as a data source.
" + } + }, + "com.amazonaws.guardduty#FreeTrialFeatureConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#FreeTrialFeatureResult", + "traits": { + "smithy.api#documentation": "The name of the feature for which the free trial is configured.
", + "smithy.api#jsonName": "name" + } + }, + "FreeTrialDaysRemaining": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of the remaining free trial days for the feature.
", + "smithy.api#jsonName": "freeTrialDaysRemaining" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the free trial period for a feature.
" + } + }, + "com.amazonaws.guardduty#FreeTrialFeatureConfigurationsResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FreeTrialFeatureConfigurationResult" + } + }, + "com.amazonaws.guardduty#FreeTrialFeatureResult": { + "type": "enum", + "members": { + "FLOW_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOW_LOGS" + } + }, + "CLOUD_TRAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUD_TRAIL" + } + }, + "DNS_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DNS_LOGS" + } + }, + "S3_DATA_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_DATA_EVENTS" + } + }, + "EKS_AUDIT_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_AUDIT_LOGS" + } + }, + "EBS_MALWARE_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" + } + }, + "RDS_LOGIN_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_LOGIN_EVENTS" + } + }, + "LAMBDA_NETWORK_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" + } + }, + "EKS_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" + } + }, + "EC2_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_RUNTIME_MONITORING" + } + }, + "FARGATE_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FARGATE_RUNTIME_MONITORING" + } + }, + "AI_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AI_PROTECTION" + } + } + } + }, + "com.amazonaws.guardduty#GeoLocation": { + "type": "structure", + "members": { + "Lat": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#documentation": "The latitude information of the remote IP address.
", + "smithy.api#jsonName": "lat" + } + }, + "Lon": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#documentation": "The longitude information of the remote IP address.
", + "smithy.api#jsonName": "lon" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the location of the remote IP address. By default, GuardDuty returns Geolocation with Lat and Lon as 0.0.
Provides the details of the GuardDuty administrator account associated with the current GuardDuty member account.
Based on the type of account that runs this API, the following list shows how the API behavior varies:
When the GuardDuty administrator account runs this API, it will return success (HTTP 200) but no content.
When a member account runs this API, it will return the details of the GuardDuty administrator account that is associated with this calling member account.
When an individual account (not associated with an organization) runs this API, it will return success (HTTP 200) but no content.
The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetAdministratorAccountResponse": { + "type": "structure", + "members": { + "Administrator": { + "target": "com.amazonaws.guardduty#Administrator", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The administrator account details.
", + "smithy.api#jsonName": "administrator", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetCoverageStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetCoverageStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetCoverageStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves aggregated statistics for your account. If you are a GuardDuty administrator, you can retrieve the statistics for all the resources associated with the active member accounts in your organization who have enabled Runtime Monitoring and have the GuardDuty security agent running on their resources.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/coverage/statistics", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetCoverageStatisticsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the GuardDuty detector.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
Represents the criteria used to filter the coverage statistics.
", + "smithy.api#jsonName": "filterCriteria" + } + }, + "StatisticsType": { + "target": "com.amazonaws.guardduty#CoverageStatisticsTypeList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Represents the statistics type used to aggregate the coverage details.
", + "smithy.api#jsonName": "statisticsType", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetCoverageStatisticsResponse": { + "type": "structure", + "members": { + "CoverageStatistics": { + "target": "com.amazonaws.guardduty#CoverageStatistics", + "traits": { + "smithy.api#documentation": "Represents the count aggregated by the statusCode and resourceType.
Retrieves a GuardDuty detector specified by the detectorId.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetDetectorRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that you want to get.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The timestamp of when the detector was created.
", + "smithy.api#jsonName": "createdAt" + } + }, + "FindingPublishingFrequency": { + "target": "com.amazonaws.guardduty#FindingPublishingFrequency", + "traits": { + "smithy.api#documentation": "The publishing frequency of the finding.
", + "smithy.api#jsonName": "findingPublishingFrequency" + } + }, + "ServiceRole": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The GuardDuty service role.
", + "smithy.api#jsonName": "serviceRole", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.guardduty#DetectorStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The detector status.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The last-updated timestamp for the detector.
", + "smithy.api#jsonName": "updatedAt" + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurationsResult", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Describes which data sources are enabled for the detector.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags of the detector resource.
", + "smithy.api#jsonName": "tags" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#DetectorFeatureConfigurationsResults", + "traits": { + "smithy.api#documentation": "Describes the features that have been enabled for the detector.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetFilterRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the details of the filter specified by the filter name.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/filter/{FilterName}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetFilterRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that is associated with this filter.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The name of the filter you want to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetFilterResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#FilterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the filter.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.guardduty#FilterDescription", + "traits": { + "smithy.api#documentation": "The description of the filter.
", + "smithy.api#jsonName": "description" + } + }, + "Action": { + "target": "com.amazonaws.guardduty#FilterAction", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the action that is to be applied to the findings that match the filter.
", + "smithy.api#jsonName": "action", + "smithy.api#required": {} + } + }, + "Rank": { + "target": "com.amazonaws.guardduty#FilterRank", + "traits": { + "smithy.api#documentation": "Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.
", + "smithy.api#jsonName": "rank" + } + }, + "FindingCriteria": { + "target": "com.amazonaws.guardduty#FindingCriteria", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Represents the criteria to be used in the filter for querying findings.
", + "smithy.api#jsonName": "findingCriteria", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags of the filter resource.
", + "smithy.api#jsonName": "tags" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the filter was created. This field is not available for filters that were created before the lifecycle metadata feature was enabled (legacy filters).
", + "smithy.api#jsonName": "createdAt" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the filter was last updated. For legacy filters, this field is present only after the filter has been updated at least once since the lifecycle metadata feature was enabled.
", + "smithy.api#jsonName": "updatedAt" + } + }, + "Version": { + "target": "com.amazonaws.guardduty#FilterVersion", + "traits": { + "smithy.api#documentation": "The version of the filter. Every time the filter is updated, the version increments by 1. This field is not available for legacy filters that were created before the lifecycle metadata feature was enabled.
", + "smithy.api#jsonName": "version" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetFindingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Describes Amazon GuardDuty findings specified by finding IDs.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/findings/get", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetFindingsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The IDs of the findings that you want to retrieve.
", + "smithy.api#jsonName": "findingIds", + "smithy.api#required": {} + } + }, + "SortCriteria": { + "target": "com.amazonaws.guardduty#SortCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used for sorting findings.
", + "smithy.api#jsonName": "sortCriteria" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetFindingsResponse": { + "type": "structure", + "members": { + "Findings": { + "target": "com.amazonaws.guardduty#Findings", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of findings.
", + "smithy.api#jsonName": "findings", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetFindingsStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetFindingsStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetFindingsStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists GuardDuty findings statistics for the specified detector ID.
You must provide either findingStatisticTypes or groupBy parameter, and not both. You can use the maxResults and orderBy parameters only when using groupBy.
There might be regional differences because some flags might not be available in all the Regions where GuardDuty is currently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/findings/statistics", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetFindingsStatisticsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector whose findings statistics you want to retrieve.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The types of finding statistics to retrieve.
", + "smithy.api#jsonName": "findingStatisticTypes" + } + }, + "FindingCriteria": { + "target": "com.amazonaws.guardduty#FindingCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria that is used for querying findings.
", + "smithy.api#jsonName": "findingCriteria" + } + }, + "GroupBy": { + "target": "com.amazonaws.guardduty#GroupByType", + "traits": { + "smithy.api#documentation": "Displays the findings statistics grouped by one of the listed valid values.
", + "smithy.api#jsonName": "groupBy" + } + }, + "OrderBy": { + "target": "com.amazonaws.guardduty#OrderBy", + "traits": { + "smithy.api#documentation": "Displays the sorted findings in the requested order. The default value of orderBy is DESC.
You can use this parameter only with the groupBy parameter.
The maximum number of results to be returned in the response. The default value is 25.
You can use this parameter only with the groupBy parameter.
The finding statistics object.
", + "smithy.api#jsonName": "findingStatistics", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
This parameter is currently not supported.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetIPSetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the IPSet specified by the ipSetId.
The unique ID of the detector that is associated with the IPSet.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the IPSet to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetIPSetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The user-friendly name for the IPSet.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#IpSetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The format of the file that contains the IPSet.
", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the file that contains the IPSet.
", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.guardduty#IpSetStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of IPSet file that was uploaded.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags of the IPSet resource.
", + "smithy.api#jsonName": "tags" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter. This field appears in the response only if it was provided during IPSet creation or update.
", + "smithy.api#jsonName": "expectedBucketOwner" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetInvestigation": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetInvestigationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetInvestigationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + }, + { + "target": "com.amazonaws.guardduty#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "This API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo).
Retrieves the results and status of a specific GuardDuty investigation.
An administrator account can retrieve any investigation within the organization. Member accounts can only retrieve investigations that belong to them.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/investigation/{InvestigationId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetInvestigationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the GuardDuty detector associated with the investigation.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique identifier of the investigation to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetInvestigationResponse": { + "type": "structure", + "members": { + "Investigation": { + "target": "com.amazonaws.guardduty#Investigation", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The details and results of the requested investigation.
", + "smithy.api#jsonName": "investigation", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetInvitationsCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetInvitationsCountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetInvitationsCountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.
", + "smithy.api#http": { + "method": "GET", + "uri": "/invitation/count", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetInvitationsCountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetInvitationsCountResponse": { + "type": "structure", + "members": { + "InvitationsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of received invitations.
", + "smithy.api#jsonName": "invitationsCount" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetMalwareProtectionPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetMalwareProtectionPlanRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetMalwareProtectionPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + }, + { + "target": "com.amazonaws.guardduty#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the Malware Protection plan details associated with a Malware Protection plan ID.
", + "smithy.api#http": { + "method": "GET", + "uri": "/malware-protection-plan/{MalwareProtectionPlanId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetMalwareProtectionPlanRequest": { + "type": "structure", + "members": { + "MalwareProtectionPlanId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique identifier associated with Malware Protection plan resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetMalwareProtectionPlanResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the protected resource.
", + "smithy.api#jsonName": "arn" + } + }, + "Role": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the IAM role that includes the permissions to scan and add tags to the associated protected resource.
", + "smithy.api#jsonName": "role" + } + }, + "ProtectedResource": { + "target": "com.amazonaws.guardduty#CreateProtectedResource", + "traits": { + "smithy.api#documentation": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource.
Information about whether the tags will be added to the S3 object after scanning.
", + "smithy.api#jsonName": "actions" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the Malware Protection plan resource was created.
", + "smithy.api#jsonName": "createdAt" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#MalwareProtectionPlanStatus", + "traits": { + "smithy.api#documentation": "Malware Protection plan status.
", + "smithy.api#jsonName": "status" + } + }, + "StatusReasons": { + "target": "com.amazonaws.guardduty#MalwareProtectionPlanStatusReasonsList", + "traits": { + "smithy.api#documentation": "Information about the issue code and message associated to the status of your Malware Protection plan.
", + "smithy.api#jsonName": "statusReasons" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "Tags added to the Malware Protection plan resource.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetMalwareScan": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetMalwareScanRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetMalwareScanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + }, + { + "target": "com.amazonaws.guardduty#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the detailed information for a specific malware scan. Each member account can view the malware scan details for their own account. An administrator can view malware scan details for all accounts in the organization.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "GET", + "uri": "/malware-scan/{ScanId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetMalwareScanRequest": { + "type": "structure", + "members": { + "ScanId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetMalwareScanResponse": { + "type": "structure", + "members": { + "ScanId": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "A unique identifier associated with the malware scan. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.
", + "smithy.api#jsonName": "scanId" + } + }, + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that is associated with the request, if it belongs to an account which is a GuardDuty customer.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the AdminDetectorId will be the same as the one used for DetectorId. If the customer is not a GuardDuty customer, this field will not be present..
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
Amazon Resource Name (ARN) of the resource on which a malware scan was invoked.
", + "smithy.api#jsonName": "resourceArn" + } + }, + "ResourceType": { + "target": "com.amazonaws.guardduty#MalwareProtectionResourceType", + "traits": { + "smithy.api#documentation": "The type of resource that was scanned for malware.
", + "smithy.api#jsonName": "resourceType" + } + }, + "ScannedResourcesCount": { + "target": "com.amazonaws.guardduty#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "The total number of resources that were successfully scanned. This is dependent on the resource type.
", + "smithy.api#jsonName": "scannedResourcesCount" + } + }, + "SkippedResourcesCount": { + "target": "com.amazonaws.guardduty#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "The total number of resources that were skipped during the scan.
", + "smithy.api#jsonName": "skippedResourcesCount" + } + }, + "FailedResourcesCount": { + "target": "com.amazonaws.guardduty#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "The total number of resources that failed to be scanned.
", + "smithy.api#jsonName": "failedResourcesCount" + } + }, + "ScannedResources": { + "target": "com.amazonaws.guardduty#ScannedResources", + "traits": { + "smithy.api#documentation": "A list of resources along with their metadata that were scanned as part of the malware scan operation.
", + "smithy.api#jsonName": "scannedResources" + } + }, + "ScanConfiguration": { + "target": "com.amazonaws.guardduty#ScanConfiguration", + "traits": { + "smithy.api#documentation": "Information about the scan configuration used for the malware scan.
", + "smithy.api#jsonName": "scanConfiguration" + } + }, + "ScanCategory": { + "target": "com.amazonaws.guardduty#ScanCategory", + "traits": { + "smithy.api#documentation": "The category of the malware scan, indicating the type of scan performed.
", + "smithy.api#jsonName": "scanCategory" + } + }, + "ScanStatus": { + "target": "com.amazonaws.guardduty#MalwareProtectionScanStatus", + "traits": { + "smithy.api#documentation": "A value representing the current status of the malware scan.
", + "smithy.api#jsonName": "scanStatus" + } + }, + "ScanStatusReason": { + "target": "com.amazonaws.guardduty#ScanStatusReason", + "traits": { + "smithy.api#documentation": "Represents the reason for the current scan status, if applicable.
", + "smithy.api#jsonName": "scanStatusReason" + } + }, + "ScanType": { + "target": "com.amazonaws.guardduty#MalwareProtectionScanType", + "traits": { + "smithy.api#documentation": "A value representing the initiator of the scan.
", + "smithy.api#jsonName": "scanType" + } + }, + "ScanStartedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp representing when the malware scan was started.
", + "smithy.api#jsonName": "scanStartedAt" + } + }, + "ScanCompletedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp representing when the malware scan was completed.
", + "smithy.api#jsonName": "scanCompletedAt" + } + }, + "ScanResultDetails": { + "target": "com.amazonaws.guardduty#GetMalwareScanResultDetails", + "traits": { + "smithy.api#documentation": "Detailed information about the results of the malware scan, if the scan completed.
", + "smithy.api#jsonName": "scanResultDetails" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetMalwareScanResultDetails": { + "type": "structure", + "members": { + "ScanResultStatus": { + "target": "com.amazonaws.guardduty#ScanResultStatus", + "traits": { + "smithy.api#documentation": "Status indicating whether threats were found for a completed scan.
", + "smithy.api#jsonName": "scanResultStatus" + } + }, + "SkippedFileCount": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "The total number of files that were skipped during the scan.
", + "smithy.api#jsonName": "skippedFileCount" + } + }, + "FailedFileCount": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "The total number of files that failed to be scanned.
", + "smithy.api#jsonName": "failedFileCount" + } + }, + "ThreatFoundFileCount": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "The total number of files in which threats were detected.
", + "smithy.api#jsonName": "threatFoundFileCount" + } + }, + "TotalFileCount": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "The total number of files that were processed during the scan.
", + "smithy.api#jsonName": "totalFileCount" + } + }, + "TotalBytes": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "The total number of bytes that were scanned.
", + "smithy.api#jsonName": "totalBytes" + } + }, + "UniqueThreatCount": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "The total number of unique threats that were detected during the scan.
", + "smithy.api#jsonName": "uniqueThreatCount" + } + }, + "Threats": { + "target": "com.amazonaws.guardduty#ScanResultThreats", + "traits": { + "smithy.api#documentation": "The threats that were detected during the malware scan.
", + "smithy.api#jsonName": "threats" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the results of the malware scan.
" + } + }, + "com.amazonaws.guardduty#GetMalwareScanSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetMalwareScanSettingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetMalwareScanSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the details of the malware scan settings.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/malware-scan-settings", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetMalwareScanSettingsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that is associated with this scan.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
Represents the criteria to be used in the filter for scanning resources.
", + "smithy.api#jsonName": "scanResourceCriteria" + } + }, + "EbsSnapshotPreservation": { + "target": "com.amazonaws.guardduty#EbsSnapshotPreservation", + "traits": { + "smithy.api#documentation": "An enum value representing possible snapshot preservation settings.
", + "smithy.api#jsonName": "ebsSnapshotPreservation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetMasterAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetMasterAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetMasterAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use GetAdministratorAccount instead" + }, + "smithy.api#documentation": "Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/master", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetMasterAccountRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The administrator account details.
", + "smithy.api#jsonName": "master", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This output is deprecated, use GetAdministratorAccountResponse instead" + }, + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetMemberDetectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetMemberDetectorsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetMemberDetectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Describes which data sources are enabled for the member account's detector.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member/detector/get", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetMemberDetectorsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detector ID for the administrator account.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A list of member account IDs.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetMemberDetectorsResponse": { + "type": "structure", + "members": { + "MemberDataSourceConfigurations": { + "target": "com.amazonaws.guardduty#MemberDataSourceConfigurations", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object that describes which data sources are enabled for a member account.
", + "smithy.api#jsonName": "members", + "smithy.api#required": {} + } + }, + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of member account IDs that were unable to be processed along with an explanation for why they were not processed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member/get", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetMembersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account whose members you want to retrieve.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A list of account IDs of the GuardDuty member accounts that you want to describe.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetMembersResponse": { + "type": "structure", + "members": { + "Members": { + "target": "com.amazonaws.guardduty#Members", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of members.
", + "smithy.api#jsonName": "members", + "smithy.api#required": {} + } + }, + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetOrganizationStatistics": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.guardduty#GetOrganizationStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves how many active member accounts have each feature enabled within GuardDuty. Only a delegated GuardDuty administrator of an organization can run this API.
When you create a new organization, it might take up to 24 hours to generate the statistics for the entire organization.
", + "smithy.api#http": { + "method": "GET", + "uri": "/organization/statistics", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetOrganizationStatisticsResponse": { + "type": "structure", + "members": { + "OrganizationDetails": { + "target": "com.amazonaws.guardduty#OrganizationDetails", + "traits": { + "smithy.api#documentation": "Information about the statistics report for your organization.
", + "smithy.api#jsonName": "organizationDetails" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetRemainingFreeTrialDays": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDaysRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDaysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Provides the number of days left for each data source used in the free trial period.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/freeTrial/daysRemaining", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetRemainingFreeTrialDaysRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A list of account identifiers of the GuardDuty member account.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetRemainingFreeTrialDaysResponse": { + "type": "structure", + "members": { + "Accounts": { + "target": "com.amazonaws.guardduty#AccountFreeTrialInfos", + "traits": { + "smithy.api#documentation": "The member accounts which were included in a request and were processed successfully.
", + "smithy.api#jsonName": "accounts" + } + }, + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#documentation": "The member account that was included in a request but for which the request could not be processed.
", + "smithy.api#jsonName": "unprocessedAccounts" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetThreatEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetThreatEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetThreatEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the threat entity set associated with the specified threatEntitySetId.
The unique ID of the detector associated with the threat entity set resource.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique ID that helps GuardDuty identify the threat entity set.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetThreatEntitySetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the threat entity set associated with the specified threatEntitySetId.
The format of the file that contains the threat entity set.
", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the file that contains the threat entity set.
", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#ExpectedBucketOwner", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.
", + "smithy.api#jsonName": "expectedBucketOwner" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#ThreatEntitySetStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the associated threat entity set.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags associated with the threat entity set resource.
", + "smithy.api#jsonName": "tags" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the associated threat entity set was created.
", + "smithy.api#jsonName": "createdAt" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the associated threat entity set was updated.
", + "smithy.api#jsonName": "updatedAt" + } + }, + "ErrorDetails": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error details when the status is shown as ERROR.
Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/threatintelset/{ThreatIntelSetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetThreatIntelSetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that is associated with the threatIntelSet.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the threatIntelSet that you want to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetThreatIntelSetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#ThreatIntelSetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The format of the threatIntelSet.
", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the file that contains the ThreatIntelSet.
", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.guardduty#ThreatIntelSetStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of threatIntelSet file uploaded.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags of the threat list resource.
", + "smithy.api#jsonName": "tags" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter. This field appears in the response only if it was provided during ThreatIntelSet creation or update.
", + "smithy.api#jsonName": "expectedBucketOwner" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetTrustedEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetTrustedEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetTrustedEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the trusted entity set associated with the specified trustedEntitySetId.
The unique ID of the GuardDuty detector associated with this trusted entity set.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TrustedEntitySetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID that helps GuardDuty identify the trusted entity set.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetTrustedEntitySetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the threat entity set associated with the specified trustedEntitySetId.
The format of the file that contains the trusted entity set.
", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the file that contains the trusted entity set.
", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#ExpectedBucketOwner", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.
", + "smithy.api#jsonName": "expectedBucketOwner" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#TrustedEntitySetStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the associated trusted entity set.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags associated with trusted entity set resource.
", + "smithy.api#jsonName": "tags" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the associated trusted entity set was created.
", + "smithy.api#jsonName": "createdAt" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the associated trusted entity set was updated.
", + "smithy.api#jsonName": "updatedAt" + } + }, + "ErrorDetails": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error details when the status is shown as ERROR.
Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID. For newly enabled detectors or data sources, the cost returned will include only the usage so far under 30 days. This may differ from the cost metrics in the console, which project usage over 30 days to provide a monthly cost estimate. For more information, see Understanding How Usage Costs are Calculated.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/usage/statistics", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#GetUsageStatisticsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose usage statistics you want to retrieve.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The type of usage statistics to retrieve.
", + "smithy.api#jsonName": "usageStatisticsType", + "smithy.api#required": {} + } + }, + "UsageCriteria": { + "target": "com.amazonaws.guardduty#UsageCriteria", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Represents the criteria used for querying usage.
", + "smithy.api#jsonName": "usageCriteria", + "smithy.api#required": {} + } + }, + "Unit": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The currency unit you would like to view your usage statistics in. Current valid values are USD.
", + "smithy.api#jsonName": "unit" + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetUsageStatisticsResponse": { + "type": "structure", + "members": { + "UsageStatistics": { + "target": "com.amazonaws.guardduty#UsageStatistics", + "traits": { + "smithy.api#documentation": "The usage statistics object. If a UsageStatisticType was provided, the objects representing other types will be null.
", + "smithy.api#jsonName": "usageStatistics" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GroupByType": { + "type": "enum", + "members": { + "ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "FINDING_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINDING_TYPE" + } + }, + "RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE" + } + }, + "SEVERITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEVERITY" + } + } + } + }, + "com.amazonaws.guardduty#GroupedByAccount": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#AccountStatistics" + } + }, + "com.amazonaws.guardduty#GroupedByDate": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#DateStatistics" + } + }, + "com.amazonaws.guardduty#GroupedByFindingType": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FindingTypeStatistics" + } + }, + "com.amazonaws.guardduty#GroupedByResource": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ResourceStatistics" + } + }, + "com.amazonaws.guardduty#GroupedBySeverity": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#SeverityStatistics" + } + }, + "com.amazonaws.guardduty#Groups": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#GuardDutyAPIService": { + "type": "service", + "version": "2017-11-28", + "operations": [ + { + "target": "com.amazonaws.guardduty#AcceptAdministratorInvitation" + }, + { + "target": "com.amazonaws.guardduty#AcceptInvitation" + }, + { + "target": "com.amazonaws.guardduty#ArchiveFindings" + }, + { + "target": "com.amazonaws.guardduty#CreateDetector" + }, + { + "target": "com.amazonaws.guardduty#CreateFilter" + }, + { + "target": "com.amazonaws.guardduty#CreateInvestigation" + }, + { + "target": "com.amazonaws.guardduty#CreateIPSet" + }, + { + "target": "com.amazonaws.guardduty#CreateMalwareProtectionPlan" + }, + { + "target": "com.amazonaws.guardduty#CreateMembers" + }, + { + "target": "com.amazonaws.guardduty#CreatePublishingDestination" + }, + { + "target": "com.amazonaws.guardduty#CreateSampleFindings" + }, + { + "target": "com.amazonaws.guardduty#CreateThreatEntitySet" + }, + { + "target": "com.amazonaws.guardduty#CreateThreatIntelSet" + }, + { + "target": "com.amazonaws.guardduty#CreateTrustedEntitySet" + }, + { + "target": "com.amazonaws.guardduty#DeclineInvitations" + }, + { + "target": "com.amazonaws.guardduty#DeleteDetector" + }, + { + "target": "com.amazonaws.guardduty#DeleteFilter" + }, + { + "target": "com.amazonaws.guardduty#DeleteInvitations" + }, + { + "target": "com.amazonaws.guardduty#DeleteIPSet" + }, + { + "target": "com.amazonaws.guardduty#DeleteMalwareProtectionPlan" + }, + { + "target": "com.amazonaws.guardduty#DeleteMembers" + }, + { + "target": "com.amazonaws.guardduty#DeletePublishingDestination" + }, + { + "target": "com.amazonaws.guardduty#DeleteThreatEntitySet" + }, + { + "target": "com.amazonaws.guardduty#DeleteThreatIntelSet" + }, + { + "target": "com.amazonaws.guardduty#DeleteTrustedEntitySet" + }, + { + "target": "com.amazonaws.guardduty#DescribeMalwareScans" + }, + { + "target": "com.amazonaws.guardduty#DescribeOrganizationConfiguration" + }, + { + "target": "com.amazonaws.guardduty#DescribePublishingDestination" + }, + { + "target": "com.amazonaws.guardduty#DisableOrganizationAdminAccount" + }, + { + "target": "com.amazonaws.guardduty#DisassociateFromAdministratorAccount" + }, + { + "target": "com.amazonaws.guardduty#DisassociateFromMasterAccount" + }, + { + "target": "com.amazonaws.guardduty#DisassociateMembers" + }, + { + "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccount" + }, + { + "target": "com.amazonaws.guardduty#GetAdministratorAccount" + }, + { + "target": "com.amazonaws.guardduty#GetCoverageStatistics" + }, + { + "target": "com.amazonaws.guardduty#GetDetector" + }, + { + "target": "com.amazonaws.guardduty#GetFilter" + }, + { + "target": "com.amazonaws.guardduty#GetFindings" + }, + { + "target": "com.amazonaws.guardduty#GetFindingsStatistics" + }, + { + "target": "com.amazonaws.guardduty#GetInvestigation" + }, + { + "target": "com.amazonaws.guardduty#GetInvitationsCount" + }, + { + "target": "com.amazonaws.guardduty#GetIPSet" + }, + { + "target": "com.amazonaws.guardduty#GetMalwareProtectionPlan" + }, + { + "target": "com.amazonaws.guardduty#GetMalwareScan" + }, + { + "target": "com.amazonaws.guardduty#GetMalwareScanSettings" + }, + { + "target": "com.amazonaws.guardduty#GetMasterAccount" + }, + { + "target": "com.amazonaws.guardduty#GetMemberDetectors" + }, + { + "target": "com.amazonaws.guardduty#GetMembers" + }, + { + "target": "com.amazonaws.guardduty#GetOrganizationStatistics" + }, + { + "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDays" + }, + { + "target": "com.amazonaws.guardduty#GetThreatEntitySet" + }, + { + "target": "com.amazonaws.guardduty#GetThreatIntelSet" + }, + { + "target": "com.amazonaws.guardduty#GetTrustedEntitySet" + }, + { + "target": "com.amazonaws.guardduty#GetUsageStatistics" + }, + { + "target": "com.amazonaws.guardduty#InviteMembers" + }, + { + "target": "com.amazonaws.guardduty#ListCoverage" + }, + { + "target": "com.amazonaws.guardduty#ListDetectors" + }, + { + "target": "com.amazonaws.guardduty#ListFilters" + }, + { + "target": "com.amazonaws.guardduty#ListFindings" + }, + { + "target": "com.amazonaws.guardduty#ListInvestigations" + }, + { + "target": "com.amazonaws.guardduty#ListInvitations" + }, + { + "target": "com.amazonaws.guardduty#ListIPSets" + }, + { + "target": "com.amazonaws.guardduty#ListMalwareProtectionPlans" + }, + { + "target": "com.amazonaws.guardduty#ListMalwareScans" + }, + { + "target": "com.amazonaws.guardduty#ListMembers" + }, + { + "target": "com.amazonaws.guardduty#ListOrganizationAdminAccounts" + }, + { + "target": "com.amazonaws.guardduty#ListPublishingDestinations" + }, + { + "target": "com.amazonaws.guardduty#ListTagsForResource" + }, + { + "target": "com.amazonaws.guardduty#ListThreatEntitySets" + }, + { + "target": "com.amazonaws.guardduty#ListThreatIntelSets" + }, + { + "target": "com.amazonaws.guardduty#ListTrustedEntitySets" + }, + { + "target": "com.amazonaws.guardduty#SendObjectMalwareScan" + }, + { + "target": "com.amazonaws.guardduty#StartMalwareScan" + }, + { + "target": "com.amazonaws.guardduty#StartMonitoringMembers" + }, + { + "target": "com.amazonaws.guardduty#StopMonitoringMembers" + }, + { + "target": "com.amazonaws.guardduty#TagResource" + }, + { + "target": "com.amazonaws.guardduty#UnarchiveFindings" + }, + { + "target": "com.amazonaws.guardduty#UntagResource" + }, + { + "target": "com.amazonaws.guardduty#UpdateDetector" + }, + { + "target": "com.amazonaws.guardduty#UpdateFilter" + }, + { + "target": "com.amazonaws.guardduty#UpdateFindingsFeedback" + }, + { + "target": "com.amazonaws.guardduty#UpdateIPSet" + }, + { + "target": "com.amazonaws.guardduty#UpdateMalwareProtectionPlan" + }, + { + "target": "com.amazonaws.guardduty#UpdateMalwareScanSettings" + }, + { + "target": "com.amazonaws.guardduty#UpdateMemberDetectors" + }, + { + "target": "com.amazonaws.guardduty#UpdateOrganizationConfiguration" + }, + { + "target": "com.amazonaws.guardduty#UpdatePublishingDestination" + }, + { + "target": "com.amazonaws.guardduty#UpdateThreatEntitySet" + }, + { + "target": "com.amazonaws.guardduty#UpdateThreatIntelSet" + }, + { + "target": "com.amazonaws.guardduty#UpdateTrustedEntitySet" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "GuardDuty", + "arnNamespace": "guardduty", + "cloudFormationName": "GuardDuty", + "cloudTrailEventSource": "guardduty.amazonaws.com", + "endpointPrefix": "guardduty" + }, + "aws.auth#sigv4": { + "name": "guardduty" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following foundational data sources - VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event logs, EKS audit logs, DNS logs, Amazon EBS volume data, runtime activity belonging to container workloads, such as Amazon EKS, Amazon ECS (including Amazon Web Services Fargate), and Amazon EC2 instances. It uses threat intelligence feeds, such as lists of malicious IPs and domains, and machine learning to identify unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, domains, or presence of malware on your Amazon EC2 instances and container workloads. For example, GuardDuty can detect compromised EC2 instances and container workloads serving malware, or mining bitcoin.
GuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such as unauthorized infrastructure deployments like EC2 instances deployed in a Region that has never been used, or unusual API calls like a password policy change to reduce password strength.
GuardDuty informs you about the status of your Amazon Web Services environment by producing security findings that you can view in the GuardDuty console or through Amazon EventBridge. For more information, see the Amazon GuardDuty User Guide .
", + "smithy.api#title": "Amazon GuardDuty", + "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-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://guardduty-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://guardduty.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://guardduty-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://guardduty.{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://guardduty.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 14, + "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAgAAAAGAAAABAAAAAcF9eELAAAABQX14QkF9eEKAAAABAAAAAsAAAAJAAAABgAAAAoF9eEIAAAABwX14QYF9eEHAAAABQAAAAwF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAOAAAABAX14QIF9eED" + }, + "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://guardduty-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-us-gov" + ] + } + ], + "endpoint": { + "url": "https://guardduty.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://guardduty-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://guardduty.{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://guardduty.{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://guardduty.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://guardduty.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://guardduty.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://guardduty.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://guardduty.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://guardduty.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://guardduty.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://guardduty.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.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://guardduty.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://guardduty.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://guardduty.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://guardduty.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://guardduty.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://guardduty.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://guardduty.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://guardduty.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://guardduty.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://guardduty-fips.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://guardduty.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://guardduty-fips.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://guardduty.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://guardduty-fips.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://guardduty.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://guardduty-fips.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://guardduty-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://guardduty.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://guardduty.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://guardduty.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://guardduty-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://guardduty-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://guardduty.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.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://guardduty.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://guardduty-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 disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty-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://guardduty.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.guardduty#GuardDutyArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[A-Za-z_.-]{1,20}:guardduty:[A-Za-z0-9_/.-]{0,63}:\\d+:detector/[A-Za-z0-9_/.-]{32,264}$" + } + }, + "com.amazonaws.guardduty#GuardrailAction": { + "type": "enum", + "members": { + "GUARDRAIL_INTERVENED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GUARDRAIL_INTERVENED" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.guardduty#GuardrailSource": { + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPUT" + } + }, + "OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTPUT" + } + } + } + }, + "com.amazonaws.guardduty#HighestSeverityThreatDetails": { + "type": "structure", + "members": { + "Severity": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Severity level of the highest severity threat detected.
", + "smithy.api#jsonName": "severity" + } + }, + "ThreatName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Threat name of the highest severity threat detected as part of the malware scan.
", + "smithy.api#jsonName": "threatName" + } + }, + "Count": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of infected files with the highest severity threat detected.
", + "smithy.api#jsonName": "count" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of the highest severity threat detected during scan and number of infected files.
" + } + }, + "com.amazonaws.guardduty#HostPath": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Path of the file or directory on the host that the volume maps to.
", + "smithy.api#jsonName": "path" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a pre-existing file or directory on the host machine that the volume maps to.
" + } + }, + "com.amazonaws.guardduty#IamInstanceProfile": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The profile ARN of the EC2 instance.
", + "smithy.api#jsonName": "arn" + } + }, + "Id": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The profile ID of the EC2 instance.
", + "smithy.api#jsonName": "id" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the EC2 instance profile.
" + } + }, + "com.amazonaws.guardduty#IamInstanceProfileV2": { + "type": "structure", + "members": { + "Ec2InstanceUids": { + "target": "com.amazonaws.guardduty#Ec2InstanceUids", + "traits": { + "smithy.api#documentation": "A list of unique identifiers for the compromised Amazon EC2 instances that share the same IAM instance profile.
", + "smithy.api#jsonName": "ec2InstanceUids" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the IAM instance profile involved in a GuardDuty finding, including unique identifiers of the Amazon EC2 instances.
" + } + }, + "com.amazonaws.guardduty#ImpersonatedUser": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Information about the username that was being impersonated.
The group to which the user name belongs.
Contains information about the impersonated user.
" + } + }, + "com.amazonaws.guardduty#IncrementalScanDetails": { + "type": "structure", + "members": { + "BaselineResourceArn": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Amazon Resource Name (ARN) of the baseline resource used for incremental scanning. The scan will only process changes since this baseline resource was created.
", + "smithy.api#jsonName": "baselineResourceArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the incremental scan configuration.
" + } + }, + "com.amazonaws.guardduty#Indicator": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.guardduty#IndicatorType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specific indicator keys observed in the attack sequence. For description of the valid values for key, see Attack sequence finding details in the Amazon GuardDuty User Guide.
", + "smithy.api#jsonName": "key", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.guardduty#IndicatorValues", + "traits": { + "smithy.api#documentation": "Values associated with each indicator key. For example, if the indicator key is SUSPICIOUS_NETWORK, then the value will be the name of the network. If the indicator key is ATTACK_TACTIC, then the value will be one of the MITRE tactics.
Title describing the indicator.
", + "smithy.api#jsonName": "title" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the indicators that include a set of signals observed in an attack sequence.
" + } + }, + "com.amazonaws.guardduty#IndicatorTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.guardduty#IndicatorType": { + "type": "enum", + "members": { + "SUSPICIOUS_USER_AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSPICIOUS_USER_AGENT" + } + }, + "SUSPICIOUS_NETWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSPICIOUS_NETWORK" + } + }, + "MALICIOUS_IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MALICIOUS_IP" + } + }, + "TOR_IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOR_IP" + } + }, + "ATTACK_TACTIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACK_TACTIC" + } + }, + "HIGH_RISK_API": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH_RISK_API" + } + }, + "ATTACK_TECHNIQUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACK_TECHNIQUE" + } + }, + "UNUSUAL_API_FOR_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNUSUAL_API_FOR_ACCOUNT" + } + }, + "UNUSUAL_ASN_FOR_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNUSUAL_ASN_FOR_ACCOUNT" + } + }, + "UNUSUAL_ASN_FOR_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNUSUAL_ASN_FOR_USER" + } + }, + "SUSPICIOUS_PROCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSPICIOUS_PROCESS" + } + }, + "MALICIOUS_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MALICIOUS_DOMAIN" + } + }, + "MALICIOUS_PROCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MALICIOUS_PROCESS" + } + }, + "CRYPTOMINING_IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRYPTOMINING_IP" + } + }, + "CRYPTOMINING_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRYPTOMINING_DOMAIN" + } + }, + "CRYPTOMINING_PROCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRYPTOMINING_PROCESS" + } + }, + "MALICIOUS_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MALICIOUS_FILE" + } + }, + "VULNERABILITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VULNERABILITY" + } + }, + "MALICIOUS_PACKAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MALICIOUS_PACKAGE" + } + }, + "MISCONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISCONFIGURATION" + } + }, + "REACHABILITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REACHABILITY" + } + }, + "SENSITIVE_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SENSITIVE_DATA" + } + } + } + }, + "com.amazonaws.guardduty#IndicatorValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.guardduty#IndicatorValues": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#IndicatorValueString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 400 + } + } + }, + "com.amazonaws.guardduty#Indicators": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Indicator" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, + "com.amazonaws.guardduty#InstanceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):[a-z]+:[a-z]+(-[0-9]+|-[a-z]+)+:([0-9]{12}):[a-z\\-]+\\/[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.guardduty#InstanceDetails": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Availability Zone of the EC2 instance.
", + "smithy.api#jsonName": "availabilityZone" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.guardduty#IamInstanceProfile", + "traits": { + "smithy.api#documentation": "The profile information of the EC2 instance.
", + "smithy.api#jsonName": "iamInstanceProfile" + } + }, + "ImageDescription": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The image description of the EC2 instance.
", + "smithy.api#jsonName": "imageDescription" + } + }, + "ImageId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The image ID of the EC2 instance.
", + "smithy.api#jsonName": "imageId" + } + }, + "InstanceId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ID of the EC2 instance.
", + "smithy.api#jsonName": "instanceId" + } + }, + "InstanceState": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The state of the EC2 instance.
", + "smithy.api#jsonName": "instanceState" + } + }, + "InstanceType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The type of the EC2 instance.
", + "smithy.api#jsonName": "instanceType" + } + }, + "OutpostArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Outpost. Only applicable to Amazon Web Services Outposts instances.
", + "smithy.api#jsonName": "outpostArn" + } + }, + "LaunchTime": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The launch time of the EC2 instance.
", + "smithy.api#jsonName": "launchTime" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.guardduty#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "The elastic network interface information of the EC2 instance.
", + "smithy.api#jsonName": "networkInterfaces" + } + }, + "Platform": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The platform of the EC2 instance.
", + "smithy.api#jsonName": "platform" + } + }, + "ProductCodes": { + "target": "com.amazonaws.guardduty#ProductCodes", + "traits": { + "smithy.api#documentation": "The product code of the EC2 instance.
", + "smithy.api#jsonName": "productCodes" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "The tags of the EC2 instance.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the details of an instance.
" + } + }, + "com.amazonaws.guardduty#Integer": { + "type": "integer" + }, + "com.amazonaws.guardduty#IntegerValueWithMax": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#InternalServerErrorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error type.
", + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "An internal server error exception object.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.guardduty#Investigation": { + "type": "structure", + "members": { + "InvestigationId": { + "target": "com.amazonaws.guardduty#InvestigationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the investigation.
", + "smithy.api#jsonName": "investigationId", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.guardduty#InvestigationStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the investigation. Possible values are RUNNING, COMPLETED, and FAILED.
The natural-language prompt that initiated this investigation.
", + "smithy.api#jsonName": "triggerPrompt", + "smithy.api#required": {} + } + }, + "TriggeredBy": { + "target": "com.amazonaws.guardduty#TriggeredBy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The account that initiated the investigation.
", + "smithy.api#jsonName": "triggeredBy", + "smithy.api#required": {} + } + }, + "Metadata": { + "target": "com.amazonaws.guardduty#InvestigationMetadata", + "traits": { + "smithy.api#documentation": "Metadata about the product and version that produced the investigation.
", + "smithy.api#jsonName": "metadata" + } + }, + "Cloud": { + "target": "com.amazonaws.guardduty#CloudDetails", + "traits": { + "smithy.api#documentation": "Details about the cloud environment in which the investigation was performed, including the provider, region, and account.
", + "smithy.api#jsonName": "cloud" + } + }, + "RiskLevel": { + "target": "com.amazonaws.guardduty#RiskLevel", + "traits": { + "smithy.api#documentation": "The assessed risk level of the investigated threat. Possible values are Info, Low, Medium, High, and Critical.
A human-readable description of the assessed risk.
", + "smithy.api#jsonName": "risk" + } + }, + "Confidence": { + "target": "com.amazonaws.guardduty#Confidence", + "traits": { + "smithy.api#documentation": "The confidence level of the investigation's assessment. Possible values are Unknown, Low, Medium, and High.
A structured summary of the investigation findings, including affected resources, threat assessment, and recommended remediation steps.
", + "smithy.api#jsonName": "summary" + } + }, + "StartTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the investigation started.
", + "smithy.api#jsonName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the investigation completed.
", + "smithy.api#jsonName": "endTime" + } + }, + "Error": { + "target": "com.amazonaws.guardduty#InvestigationErrorDetails", + "traits": { + "smithy.api#documentation": "Details about the error if the investigation status is FAILED.
Contains the details and results of a GuardDuty investigation.
" + } + }, + "com.amazonaws.guardduty#InvestigationErrorDetails": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.guardduty#InvestigationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-fA-F0-9\\-]+$" + } + }, + "com.amazonaws.guardduty#InvestigationMetadata": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version of the investigation engine that produced the results.
", + "smithy.api#jsonName": "version", + "smithy.api#required": {} + } + }, + "Product": { + "target": "com.amazonaws.guardduty#Product", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Information about the product that produced the investigation.
", + "smithy.api#jsonName": "product", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains metadata about the product and version that produced an investigation.
" + } + }, + "com.amazonaws.guardduty#InvestigationSortCriteria": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.guardduty#InvestigationSortField", + "traits": { + "smithy.api#documentation": "The attribute by which to sort investigations.
", + "smithy.api#jsonName": "attributeName" + } + }, + "OrderBy": { + "target": "com.amazonaws.guardduty#OrderBy", + "traits": { + "smithy.api#documentation": "The order in which the sorted results are to be displayed.
", + "smithy.api#jsonName": "orderBy" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the criteria used for sorting investigations.
" + } + }, + "com.amazonaws.guardduty#InvestigationSortField": { + "type": "enum", + "members": { + "START_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START_TIME" + } + }, + "END_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "END_TIME" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + }, + "RISK_LEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RISK_LEVEL" + } + }, + "CONFIDENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFIDENCE" + } + } + } + }, + "com.amazonaws.guardduty#InvestigationStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#InvestigationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#InvestigationSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#InvestigationSummary": { + "type": "structure", + "members": { + "InvestigationId": { + "target": "com.amazonaws.guardduty#InvestigationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the investigation.
", + "smithy.api#jsonName": "investigationId" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#InvestigationStatus", + "traits": { + "smithy.api#documentation": "The current status of the investigation.
", + "smithy.api#jsonName": "status" + } + }, + "TriggerPrompt": { + "target": "com.amazonaws.guardduty#TriggerPrompt", + "traits": { + "smithy.api#documentation": "The natural-language prompt that initiated this investigation.
", + "smithy.api#jsonName": "triggerPrompt" + } + }, + "RiskLevel": { + "target": "com.amazonaws.guardduty#RiskLevel", + "traits": { + "smithy.api#documentation": "The assessed risk level of the investigated threat.
", + "smithy.api#jsonName": "riskLevel" + } + }, + "Confidence": { + "target": "com.amazonaws.guardduty#Confidence", + "traits": { + "smithy.api#documentation": "The confidence level of the investigation's assessment.
", + "smithy.api#jsonName": "confidence" + } + }, + "Title": { + "target": "com.amazonaws.guardduty#InvestigationTitle", + "traits": { + "smithy.api#documentation": "A short title summarizing the investigation.
", + "smithy.api#jsonName": "title" + } + }, + "AccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID associated with the investigation.
", + "smithy.api#jsonName": "accountId" + } + }, + "StartTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the investigation started.
", + "smithy.api#jsonName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the investigation completed.
", + "smithy.api#jsonName": "endTime" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a GuardDuty investigation.
" + } + }, + "com.amazonaws.guardduty#InvestigationTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.guardduty#Invitation": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the account that the invitation was sent from.
", + "smithy.api#jsonName": "accountId" + } + }, + "InvitationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ID of the invitation. This value is used to validate the inviter account to the member account.
", + "smithy.api#jsonName": "invitationId" + } + }, + "RelationshipStatus": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The status of the relationship between the inviter and invitee accounts.
", + "smithy.api#jsonName": "relationshipStatus" + } + }, + "InvitedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The timestamp when the invitation was sent.
", + "smithy.api#jsonName": "invitedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the invitation to become a member account.
" + } + }, + "com.amazonaws.guardduty#Invitations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Invitation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#InviteMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#InviteMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#InviteMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account that invokes this API. If you are using Amazon Web Services Organizations to manage your GuardDuty environment, this step is not needed. For more information, see Managing accounts with organizations.
To invite Amazon Web Services accounts, the first step is to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API to add accounts by invitation. The invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can choose to accept the invitation from only one Amazon Web Services account. For more information, see Managing GuardDuty accounts by invitation.
After the invite has been accepted and you choose to disassociate a member account (by using DisassociateMembers) from your account, the details of the member account obtained by invoking CreateMembers, including the associated email addresses, will be retained. This is done so that you can invoke InviteMembers without the need to invoke CreateMembers again. To remove the details associated with a member account, you must also invoke DeleteMembers.
If you disassociate a member account that was added by invitation, the member account details obtained from this API, including the associated email addresses, will be retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.
When the member accounts added through Organizations are later disassociated, you (administrator) can't invite them by calling the InviteMembers API. You can create an association with these member accounts again only by calling the CreateMembers API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member/invite", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#InviteMembersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account with which you want to invite members.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A list of account IDs of the accounts that you want to invite to GuardDuty as members.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + }, + "DisableEmailNotification": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members.
", + "smithy.api#jsonName": "disableEmailNotification" + } + }, + "Message": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.
", + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#InviteMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#IpSetFormat": { + "type": "enum", + "members": { + "TXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TXT" + } + }, + "STIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STIX" + } + }, + "OTX_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTX_CSV" + } + }, + "ALIEN_VAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALIEN_VAULT" + } + }, + "PROOF_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROOF_POINT" + } + }, + "FIRE_EYE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRE_EYE" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#IpSetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#IpSetStatus": { + "type": "enum", + "members": { + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DEACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_PENDING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#Ipv6Addresses": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Issues": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#ItemDetails": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource where the threat was detected.
", + "smithy.api#jsonName": "resourceArn" + } + }, + "ItemPath": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The path where the threat was detected.
", + "smithy.api#jsonName": "itemPath" + } + }, + "Hash": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The hash value of the infected item.
", + "smithy.api#jsonName": "hash" + } + }, + "AdditionalInfo": { + "target": "com.amazonaws.guardduty#AdditionalInfo", + "traits": { + "smithy.api#documentation": "Additional information about the detected threat item.
", + "smithy.api#jsonName": "additionalInfo" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains detailed information about where a threat was detected.
" + } + }, + "com.amazonaws.guardduty#ItemDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ItemDetails" + } + }, + "com.amazonaws.guardduty#ItemPath": { + "type": "structure", + "members": { + "NestedItemPath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The nested item path where the infected file was found.
", + "smithy.api#jsonName": "nestedItemPath" + } + }, + "Hash": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The hash value of the infected resource.
", + "smithy.api#jsonName": "hash" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the nested item path and hash of the protected resource.
" + } + }, + "com.amazonaws.guardduty#ItemPaths": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ItemPath" + } + }, + "com.amazonaws.guardduty#KubernetesApiCallAction": { + "type": "structure", + "members": { + "RequestUri": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Kubernetes API request URI.
", + "smithy.api#jsonName": "requestUri" + } + }, + "Verb": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Kubernetes API request HTTP verb.
", + "smithy.api#jsonName": "verb" + } + }, + "Resource": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The resource component in the Kubernetes API call action.
", + "smithy.api#jsonName": "resource" + } + }, + "Subresource": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the sub-resource in the Kubernetes API call action.
", + "smithy.api#jsonName": "subresource" + } + }, + "Namespace": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the namespace where the Kubernetes API call action takes place.
", + "smithy.api#jsonName": "namespace" + } + }, + "ResourceName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the resource in the Kubernetes API call action.
", + "smithy.api#jsonName": "resourceName" + } + }, + "SourceIps": { + "target": "com.amazonaws.guardduty#SourceIps", + "traits": { + "smithy.api#documentation": "The IP of the Kubernetes API caller and the IPs of any proxies or load balancers between the caller and the API endpoint.
", + "smithy.api#jsonName": "sourceIPs" + } + }, + "UserAgent": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The user agent of the caller of the Kubernetes API.
", + "smithy.api#jsonName": "userAgent" + } + }, + "RemoteIpDetails": { + "target": "com.amazonaws.guardduty#RemoteIpDetails", + "traits": { + "smithy.api#jsonName": "remoteIpDetails" + } + }, + "StatusCode": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The resulting HTTP response code of the Kubernetes API call action.
", + "smithy.api#jsonName": "statusCode" + } + }, + "Parameters": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Parameters related to the Kubernetes API call action.
", + "smithy.api#jsonName": "parameters" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Kubernetes API call action described in this finding.
" + } + }, + "com.amazonaws.guardduty#KubernetesAuditLogsConfiguration": { + "type": "structure", + "members": { + "Enable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of Kubernetes audit logs as a data source.
", + "smithy.api#jsonName": "enable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether Kubernetes audit logs are enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#KubernetesAuditLogsConfigurationResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A value that describes whether Kubernetes audit logs are enabled as a data source.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether Kubernetes audit logs are enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#KubernetesConfiguration": { + "type": "structure", + "members": { + "AuditLogs": { + "target": "com.amazonaws.guardduty#KubernetesAuditLogsConfiguration", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of Kubernetes audit logs as a data source.
", + "smithy.api#jsonName": "auditLogs", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether any Kubernetes data sources are enabled.
" + } + }, + "com.amazonaws.guardduty#KubernetesConfigurationResult": { + "type": "structure", + "members": { + "AuditLogs": { + "target": "com.amazonaws.guardduty#KubernetesAuditLogsConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes whether Kubernetes audit logs are enabled as a data source.
", + "smithy.api#jsonName": "auditLogs", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether any Kubernetes logs will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#KubernetesDataSourceFreeTrial": { + "type": "structure", + "members": { + "AuditLogs": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether Kubernetes audit logs are enabled as a data source.
", + "smithy.api#jsonName": "auditLogs" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides details about the Kubernetes resources when it is enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#KubernetesDetails": { + "type": "structure", + "members": { + "KubernetesUserDetails": { + "target": "com.amazonaws.guardduty#KubernetesUserDetails", + "traits": { + "smithy.api#documentation": "Details about the Kubernetes user involved in a Kubernetes finding.
", + "smithy.api#jsonName": "kubernetesUserDetails" + } + }, + "KubernetesWorkloadDetails": { + "target": "com.amazonaws.guardduty#KubernetesWorkloadDetails", + "traits": { + "smithy.api#documentation": "Details about the Kubernetes workload involved in a Kubernetes finding.
", + "smithy.api#jsonName": "kubernetesWorkloadDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about Kubernetes resources such as a Kubernetes user or workload resource involved in a Kubernetes finding.
" + } + }, + "com.amazonaws.guardduty#KubernetesPermissionCheckedDetails": { + "type": "structure", + "members": { + "Verb": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The verb component of the Kubernetes API call. For example, when you check whether or not you have the permission to call the CreatePod API, the verb component will be Create.
The Kubernetes resource with which your Kubernetes API call will interact.
", + "smithy.api#jsonName": "resource" + } + }, + "Namespace": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The namespace where the Kubernetes API action will take place.
", + "smithy.api#jsonName": "namespace" + } + }, + "Allowed": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Information whether the user has the permission to call the Kubernetes API.
", + "smithy.api#jsonName": "allowed" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Kubernetes API for which you check if you have permission to call.
" + } + }, + "com.amazonaws.guardduty#KubernetesResourcesTypes": { + "type": "enum", + "members": { + "PODS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PODS" + } + }, + "JOBS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JOBS" + } + }, + "CRONJOBS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRONJOBS" + } + }, + "DEPLOYMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYMENTS" + } + }, + "DAEMONSETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAEMONSETS" + } + }, + "STATEFULSETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATEFULSETS" + } + }, + "REPLICASETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLICASETS" + } + }, + "REPLICATIONCONTROLLERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLICATIONCONTROLLERS" + } + } + } + }, + "com.amazonaws.guardduty#KubernetesRoleBindingDetails": { + "type": "structure", + "members": { + "Kind": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The kind of the role. For role binding, this value will be RoleBinding.
The name of the RoleBinding.
The unique identifier of the role binding.
", + "smithy.api#jsonName": "uid" + } + }, + "RoleRefName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the role being referenced. This must match the name of the Role or ClusterRole that you want to bind to.
The type of the role being referenced. This could be either Role or ClusterRole.
Contains information about the role binding that grants the permission defined in a Kubernetes role.
" + } + }, + "com.amazonaws.guardduty#KubernetesRoleDetails": { + "type": "structure", + "members": { + "Kind": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The kind of role. For this API, the value of kind will be Role.
The name of the Kubernetes role.
", + "smithy.api#jsonName": "name" + } + }, + "Uid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the Kubernetes role name.
", + "smithy.api#jsonName": "uid" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Kubernetes role name and role type.
" + } + }, + "com.amazonaws.guardduty#KubernetesUserDetails": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The username of the user who called the Kubernetes API.
", + "smithy.api#jsonName": "username" + } + }, + "Uid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The user ID of the user who called the Kubernetes API.
", + "smithy.api#jsonName": "uid" + } + }, + "Groups": { + "target": "com.amazonaws.guardduty#Groups", + "traits": { + "smithy.api#documentation": "The groups that include the user who called the Kubernetes API.
", + "smithy.api#jsonName": "groups" + } + }, + "SessionName": { + "target": "com.amazonaws.guardduty#SessionNameList", + "traits": { + "smithy.api#documentation": "Entity that assumes the IAM role when Kubernetes RBAC permissions are assigned to that role.
", + "smithy.api#jsonName": "sessionName" + } + }, + "ImpersonatedUser": { + "target": "com.amazonaws.guardduty#ImpersonatedUser", + "traits": { + "smithy.api#documentation": "Information about the impersonated user.
", + "smithy.api#jsonName": "impersonatedUser" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the Kubernetes user involved in a Kubernetes finding.
" + } + }, + "com.amazonaws.guardduty#KubernetesWorkload": { + "type": "structure", + "members": { + "ContainerUids": { + "target": "com.amazonaws.guardduty#ContainerUids", + "traits": { + "smithy.api#documentation": "A list of unique identifiers for the containers that are part of the Kubernetes workload.
", + "smithy.api#jsonName": "containerUids" + } + }, + "Namespace": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Kubernetes namespace in which the workload is running, providing logical isolation within the cluster.
", + "smithy.api#jsonName": "namespace" + } + }, + "KubernetesResourcesTypes": { + "target": "com.amazonaws.guardduty#KubernetesResourcesTypes", + "traits": { + "smithy.api#documentation": "The types of Kubernetes resources involved in the workload.
", + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about Kubernetes workloads involved in a GuardDuty finding, including pods, deployments, and other Kubernetes resources.
" + } + }, + "com.amazonaws.guardduty#KubernetesWorkloadDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Kubernetes workload name.
", + "smithy.api#jsonName": "name" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Kubernetes workload type (e.g. Pod, Deployment, etc.).
", + "smithy.api#jsonName": "type" + } + }, + "Uid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Kubernetes workload ID.
", + "smithy.api#jsonName": "uid" + } + }, + "Namespace": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Kubernetes namespace that the workload is part of.
", + "smithy.api#jsonName": "namespace" + } + }, + "HostNetwork": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether the hostNetwork flag is enabled for the pods included in the workload.
", + "smithy.api#jsonName": "hostNetwork" + } + }, + "ServiceAccountName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The service account name that is associated with a Kubernetes workload.
", + "smithy.api#jsonName": "serviceAccountName" + } + }, + "Containers": { + "target": "com.amazonaws.guardduty#Containers", + "traits": { + "smithy.api#documentation": "Containers running as part of the Kubernetes workload.
", + "smithy.api#jsonName": "containers" + } + }, + "Volumes": { + "target": "com.amazonaws.guardduty#Volumes", + "traits": { + "smithy.api#documentation": "Volumes used by the Kubernetes workload.
", + "smithy.api#jsonName": "volumes" + } + }, + "HostIPC": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether the host IPC flag is enabled for the pods in the workload.
", + "smithy.api#jsonName": "hostIPC" + } + }, + "HostPID": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether the host PID flag is enabled for the pods in the workload.
", + "smithy.api#jsonName": "hostPID" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the Kubernetes workload involved in a Kubernetes finding.
" + } + }, + "com.amazonaws.guardduty#LambdaDetails": { + "type": "structure", + "members": { + "FunctionArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the Lambda function.
", + "smithy.api#jsonName": "functionArn" + } + }, + "FunctionName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Name of the Lambda function.
", + "smithy.api#jsonName": "functionName" + } + }, + "Description": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Description of the Lambda function.
", + "smithy.api#jsonName": "description" + } + }, + "LastModifiedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the Lambda function was last modified. This field is in the UTC date string format (2023-03-22T19:37:20.168Z).
The revision ID of the Lambda function version.
", + "smithy.api#jsonName": "revisionId" + } + }, + "FunctionVersion": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version of the Lambda function.
", + "smithy.api#jsonName": "functionVersion" + } + }, + "Role": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The execution role of the Lambda function.
", + "smithy.api#jsonName": "role" + } + }, + "VpcConfig": { + "target": "com.amazonaws.guardduty#VpcConfig", + "traits": { + "smithy.api#documentation": "Amazon Virtual Private Cloud configuration details associated with your Lambda function.
", + "smithy.api#jsonName": "vpcConfig" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "A list of tags attached to this resource, listed in the format of key:value pair.
Information about the Lambda function involved in the finding.
" + } + }, + "com.amazonaws.guardduty#LaunchTemplateVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + } + } + }, + "com.amazonaws.guardduty#Lineage": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#LineageObject" + } + }, + "com.amazonaws.guardduty#LineageObject": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the process started. This is in UTC format.
", + "smithy.api#jsonName": "startTime" + } + }, + "NamespacePid": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The process ID of the child process.
", + "smithy.api#jsonName": "namespacePid" + } + }, + "UserId": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The user ID of the user that executed the process.
", + "smithy.api#jsonName": "userId" + } + }, + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the process.
", + "smithy.api#jsonName": "name" + } + }, + "Pid": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The ID of the process.
", + "smithy.api#jsonName": "pid" + } + }, + "Uuid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID assigned to the process by GuardDuty.
", + "smithy.api#jsonName": "uuid" + } + }, + "ExecutablePath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The absolute path of the process executable file.
", + "smithy.api#jsonName": "executablePath" + } + }, + "Euid": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The effective user ID that was used to execute the process.
", + "smithy.api#jsonName": "euid" + } + }, + "ParentUuid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID of the parent process. This ID is assigned to the parent process by GuardDuty.
", + "smithy.api#jsonName": "parentUuid" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the runtime process details.
" + } + }, + "com.amazonaws.guardduty#ListCoverage": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListCoverageRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListCoverageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can retrieve all resources associated with the active member accounts in your organization.
Make sure the accounts have Runtime Monitoring enabled and GuardDuty agent running on their resources.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/coverage", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Resources", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListCoverageRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector whose coverage details you want to retrieve.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
", + "smithy.api#jsonName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#jsonName": "maxResults" + } + }, + "FilterCriteria": { + "target": "com.amazonaws.guardduty#CoverageFilterCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used to filter the coverage details.
", + "smithy.api#jsonName": "filterCriteria" + } + }, + "SortCriteria": { + "target": "com.amazonaws.guardduty#CoverageSortCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used to sort the coverage details.
", + "smithy.api#jsonName": "sortCriteria" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListCoverageResponse": { + "type": "structure", + "members": { + "Resources": { + "target": "com.amazonaws.guardduty#CoverageResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of resources and their attributes providing cluster details.
", + "smithy.api#jsonName": "resources", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListDetectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListDetectorsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListDetectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists detectorIds of all the existing Amazon GuardDuty detector resources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DetectorIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListDetectorsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListDetectorsResponse": { + "type": "structure", + "members": { + "DetectorIds": { + "target": "com.amazonaws.guardduty#DetectorIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of detector IDs.
", + "smithy.api#jsonName": "detectorIds", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListFilters": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListFiltersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListFiltersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of the current filters.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/filter", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FilterNames", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListFiltersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that is associated with the filter.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListFiltersResponse": { + "type": "structure", + "members": { + "FilterNames": { + "target": "com.amazonaws.guardduty#FilterNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of filter names.
", + "smithy.api#jsonName": "filterNames", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListFindingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists GuardDuty findings for the specified detector ID.
There might be regional differences because some flags might not be available in all the Regions where GuardDuty is currently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/findings", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FindingIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListFindingsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose findings you want to list.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
Represents the criteria used for querying findings. Valid values include:
JSON field name
accountId
region
confidence
id
resource.accessKeyDetails.accessKeyId
resource.accessKeyDetails.principalId
resource.accessKeyDetails.userName
resource.accessKeyDetails.userType
resource.instanceDetails.iamInstanceProfile.id
resource.instanceDetails.imageId
resource.instanceDetails.instanceId
resource.instanceDetails.networkInterfaces.ipv6Addresses
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
resource.instanceDetails.networkInterfaces.publicDnsName
resource.instanceDetails.networkInterfaces.publicIp
resource.instanceDetails.networkInterfaces.securityGroups.groupId
resource.instanceDetails.networkInterfaces.securityGroups.groupName
resource.instanceDetails.networkInterfaces.subnetId
resource.instanceDetails.networkInterfaces.vpcId
resource.instanceDetails.tags.key
resource.instanceDetails.tags.value
resource.resourceType
service.action.actionType
service.action.awsApiCallAction.api
service.action.awsApiCallAction.callerType
service.action.awsApiCallAction.remoteIpDetails.city.cityName
service.action.awsApiCallAction.remoteIpDetails.country.countryName
service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
service.action.awsApiCallAction.remoteIpDetails.organization.asn
service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
service.action.awsApiCallAction.serviceName
service.action.dnsRequestAction.domain
service.action.dnsRequestAction.domainWithSuffix
service.action.networkConnectionAction.blocked
service.action.networkConnectionAction.connectionDirection
service.action.networkConnectionAction.localPortDetails.port
service.action.networkConnectionAction.protocol
service.action.networkConnectionAction.remoteIpDetails.country.countryName
service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
service.action.networkConnectionAction.remoteIpDetails.organization.asn
service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
service.action.networkConnectionAction.remotePortDetails.port
service.additionalInfo.threatListName
service.archived
When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.
service.ebsVolumeScanDetails.scanId
service.resourceRole
severity
type
updatedAt
Type: Timestamp in Unix Epoch millisecond format: 1486685375000
Represents the criteria used for sorting findings.
", + "smithy.api#jsonName": "sortCriteria" + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListFindingsResponse": { + "type": "structure", + "members": { + "FindingIds": { + "target": "com.amazonaws.guardduty#FindingIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IDs of the findings that you're listing.
", + "smithy.api#jsonName": "findingIds", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListIPSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListIPSetsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListIPSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the IPSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the IPSets returned are the IPSets from the associated administrator account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/ipset", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpSetIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListIPSetsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that is associated with IPSet.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListIPSetsResponse": { + "type": "structure", + "members": { + "IpSetIds": { + "target": "com.amazonaws.guardduty#IpSetIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IDs of the IPSet resources.
", + "smithy.api#jsonName": "ipSetIds", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListInvestigations": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListInvestigationsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListInvestigationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "This API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo).
Returns a list of investigations associated with the specified GuardDuty detector.
An administrator account sees all investigations across the organization. Member accounts see only the investigations that belong to them.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/investigation/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Investigations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListInvestigationsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the GuardDuty detector whose investigations you want to list.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
Represents the criteria used for sorting investigations.
", + "smithy.api#jsonName": "sortCriteria" + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50.
", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#NextToken", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListInvestigationsResponse": { + "type": "structure", + "members": { + "Investigations": { + "target": "com.amazonaws.guardduty#InvestigationSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of investigation summaries associated with the specified detector.
", + "smithy.api#jsonName": "investigations", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#NextToken", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListInvitations": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListInvitationsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListInvitationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all GuardDuty membership invitations that were sent to the current Amazon Web Services account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/invitation", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Invitations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListInvitationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListInvitationsResponse": { + "type": "structure", + "members": { + "Invitations": { + "target": "com.amazonaws.guardduty#Invitations", + "traits": { + "smithy.api#documentation": "A list of invitation descriptions.
", + "smithy.api#jsonName": "invitations" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListMalwareProtectionPlans": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListMalwareProtectionPlansRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListMalwareProtectionPlansResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the Malware Protection plan IDs associated with the protected resources in your Amazon Web Services account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/malware-protection-plan", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#ListMalwareProtectionPlansRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data. The default page size is 100 plans.
A list of unique identifiers associated with each Malware Protection plan.
", + "smithy.api#jsonName": "malwareProtectionPlans" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Returns a list of malware scans. Each member account can view the malware scans for their own accounts. An administrator can view the malware scans for all of its members' accounts.
", + "smithy.api#http": { + "method": "POST", + "uri": "/malware-scan", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Scans", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListMalwareScansCriterionKey": { + "type": "enum", + "members": { + "RESOURCE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_ARN" + } + }, + "SCAN_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_ID" + } + }, + "ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_ID" + } + }, + "GUARDDUTY_FINDING_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GUARDDUTY_FINDING_ID" + } + }, + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_TYPE" + } + }, + "SCAN_START_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_START_TIME" + } + }, + "SCAN_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_STATUS" + } + }, + "SCAN_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_TYPE" + } + } + } + }, + "com.amazonaws.guardduty#ListMalwareScansFilterCriteria": { + "type": "structure", + "members": { + "ListMalwareScansFilterCriterion": { + "target": "com.amazonaws.guardduty#ListMalwareScansFilterCriterionList", + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the operation.
", + "smithy.api#jsonName": "filterCriterion" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the criteria used to filter the malware scan entries.
" + } + }, + "com.amazonaws.guardduty#ListMalwareScansFilterCriterion": { + "type": "structure", + "members": { + "ListMalwareScansCriterionKey": { + "target": "com.amazonaws.guardduty#ListMalwareScansCriterionKey", + "traits": { + "smithy.api#documentation": "An enum value representing possible scan properties to match with given scan entries.
", + "smithy.api#jsonName": "criterionKey" + } + }, + "FilterCondition": { + "target": "com.amazonaws.guardduty#FilterCondition", + "traits": { + "smithy.api#documentation": "Contains information about the condition.
", + "smithy.api#jsonName": "filterCondition" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the operation. Irrespective of using any filter criteria, an administrator account can view the scan entries for all of its member accounts. However, each member account can view the scan entries only for their own account.
" + } + }, + "com.amazonaws.guardduty#ListMalwareScansFilterCriterionList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ListMalwareScansFilterCriterion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.guardduty#ListMalwareScansRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "FilterCriteria": { + "target": "com.amazonaws.guardduty#ListMalwareScansFilterCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used to filter the malware scan entries.
", + "smithy.api#jsonName": "filterCriteria" + } + }, + "SortCriteria": { + "target": "com.amazonaws.guardduty#SortCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used for sorting malware scan entries.
", + "smithy.api#jsonName": "sortCriteria" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListMalwareScansResponse": { + "type": "structure", + "members": { + "Scans": { + "target": "com.amazonaws.guardduty#MalwareScans", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The list of malware scans associated with the provided input parameters.
", + "smithy.api#jsonName": "scans", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more scans.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists details about all member accounts for the current GuardDuty administrator account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/member", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Members", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListMembersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that is associated with the member.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "OnlyAssociated": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Specifies whether to only return associated members or to return all members (including members who haven't been invited yet or have been disassociated). Member accounts must have been previously associated with the GuardDuty administrator account using Create Members .
A list of members.
The values for email and invitedAt are available only if the member accounts are added by invitation.
The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListOrganizationAdminAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListOrganizationAdminAccountsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListOrganizationAdminAccountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the accounts designated as GuardDuty delegated administrators. Only the organization's management account can run this API operation.
", + "smithy.api#http": { + "method": "GET", + "uri": "/admin", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AdminAccounts", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListOrganizationAdminAccountsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
A list of accounts configured as GuardDuty delegated administrators.
", + "smithy.api#jsonName": "adminAccounts" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListPublishingDestinations": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListPublishingDestinationsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListPublishingDestinationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of publishing destinations associated with the specified detectorId.
The detector ID for which you want to retrieve the publishing destination.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
A Destinations object that includes information about each publishing destination returned.
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.guardduty#GuardDutyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the given GuardDuty resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags associated with the resource.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListThreatEntitySets": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListThreatEntitySetsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListThreatEntitySetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the threat entity sets associated with the specified GuardDuty detector ID. If you use this operation from a member account, the threat entity sets that are returned as a response, belong to the administrator account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/threatentityset", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ThreatEntitySetIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListThreatEntitySetsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the GuardDuty detector that is associated with this threat entity set.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListThreatEntitySetsResponse": { + "type": "structure", + "members": { + "ThreatEntitySetIds": { + "target": "com.amazonaws.guardduty#ThreatEntitySetIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IDs of the threat entity set resources.
", + "smithy.api#jsonName": "threatEntitySetIds", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListThreatIntelSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListThreatIntelSetsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListThreatIntelSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the ThreatIntelSets associated with the administrator account are returned.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/threatintelset", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ThreatIntelSetIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListThreatIntelSetsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that is associated with the threatIntelSet.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter to paginate results in the response. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListThreatIntelSetsResponse": { + "type": "structure", + "members": { + "ThreatIntelSetIds": { + "target": "com.amazonaws.guardduty#ThreatIntelSetIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IDs of the ThreatIntelSet resources.
", + "smithy.api#jsonName": "threatIntelSetIds", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListTrustedEntitySets": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListTrustedEntitySetsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListTrustedEntitySetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the trusted entity sets associated with the specified GuardDuty detector ID. If you use this operation from a member account, the trusted entity sets that are returned as a response, belong to the administrator account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/trustedentityset", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrustedEntitySetIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListTrustedEntitySetsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the GuardDuty detector that is associated with this threat entity set.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListTrustedEntitySetsResponse": { + "type": "structure", + "members": { + "TrustedEntitySetIds": { + "target": "com.amazonaws.guardduty#TrustedEntitySetIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IDs of the trusted entity set resources.
", + "smithy.api#jsonName": "trustedEntitySetIds", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#LocalIpDetails": { + "type": "structure", + "members": { + "IpAddressV4": { + "target": "com.amazonaws.guardduty#SensitiveString", + "traits": { + "smithy.api#documentation": "The IPv4 local address of the connection.
", + "smithy.api#jsonName": "ipAddressV4" + } + }, + "IpAddressV6": { + "target": "com.amazonaws.guardduty#SensitiveString", + "traits": { + "smithy.api#documentation": "The IPv6 local address of the connection.
", + "smithy.api#jsonName": "ipAddressV6" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the local IP address of the connection.
" + } + }, + "com.amazonaws.guardduty#LocalPortDetails": { + "type": "structure", + "members": { + "Port": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The port number of the local connection.
", + "smithy.api#jsonName": "port" + } + }, + "PortName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The port name of the local connection.
", + "smithy.api#jsonName": "portName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the port for the local connection.
" + } + }, + "com.amazonaws.guardduty#Location": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#LoginAttribute": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Indicates the user name which attempted to log in.
", + "smithy.api#jsonName": "user" + } + }, + "Application": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Indicates the application name used to attempt log in.
", + "smithy.api#jsonName": "application" + } + }, + "FailedLoginAttempts": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Represents the sum of failed (unsuccessful) login attempts made to establish a connection to the database instance.
", + "smithy.api#jsonName": "failedLoginAttempts" + } + }, + "SuccessfulLoginAttempts": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Represents the sum of successful connections (a correct combination of login attributes) made to the database instance by the actor.
", + "smithy.api#jsonName": "successfulLoginAttempts" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the login attempts.
" + } + }, + "com.amazonaws.guardduty#LoginAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#LoginAttribute" + } + }, + "com.amazonaws.guardduty#Long": { + "type": "long" + }, + "com.amazonaws.guardduty#LongValue": { + "type": "long" + }, + "com.amazonaws.guardduty#MalwareProtectionConfiguration": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#ScanEc2InstanceWithFindings", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection for EC2 instances with findings.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#MalwareProtectionConfigurationResult": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#ScanEc2InstanceWithFindingsResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection for EC2 instances with findings.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + }, + "ServiceRole": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The GuardDuty Malware Protection service role.
", + "smithy.api#jsonName": "serviceRole" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of all Malware Protection data sources.
" + } + }, + "com.amazonaws.guardduty#MalwareProtectionDataSourceFreeTrial": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection for EC2 instances with findings is enabled as a data source.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides details about Malware Protection when it is enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#MalwareProtectionFindingsScanConfiguration": { + "type": "structure", + "members": { + "TriggerType": { + "target": "com.amazonaws.guardduty#TriggerType", + "traits": { + "smithy.api#documentation": "The event that triggered the malware scan.
", + "smithy.api#jsonName": "triggerType" + } + }, + "IncrementalScanDetails": { + "target": "com.amazonaws.guardduty#IncrementalScanDetails", + "traits": { + "smithy.api#jsonName": "incrementalScanDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains finding configuration details about the malware scan.
" + } + }, + "com.amazonaws.guardduty#MalwareProtectionPlanActions": { + "type": "structure", + "members": { + "Tagging": { + "target": "com.amazonaws.guardduty#MalwareProtectionPlanTaggingAction", + "traits": { + "smithy.api#documentation": "Indicates whether the scanned S3 object will have tags about the scan result.
", + "smithy.api#jsonName": "tagging" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about whether the tags will be added to the S3 object after scanning.
" + } + }, + "com.amazonaws.guardduty#MalwareProtectionPlanObjectPrefixesList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.guardduty#MalwareProtectionPlanStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARNING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, + "com.amazonaws.guardduty#MalwareProtectionPlanStatusReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Issue code.
", + "smithy.api#jsonName": "code" + } + }, + "Message": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Issue message that specifies the reason. For information about potential troubleshooting steps, see Troubleshooting Malware Protection for S3 status issues in the Amazon GuardDuty User Guide.
", + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the issue code and message associated to the status of your Malware Protection plan.
" + } + }, + "com.amazonaws.guardduty#MalwareProtectionPlanStatusReasonsList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MalwareProtectionPlanStatusReason" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#MalwareProtectionPlanSummary": { + "type": "structure", + "members": { + "MalwareProtectionPlanId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "A unique identifier associated with Malware Protection plan.
", + "smithy.api#jsonName": "malwareProtectionPlanId" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Malware Protection plan resource.
" + } + }, + "com.amazonaws.guardduty#MalwareProtectionPlanTaggingAction": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#MalwareProtectionPlanTaggingActionStatus", + "traits": { + "smithy.api#documentation": "Indicates whether or not the tags will added.
", + "smithy.api#jsonName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about adding tags to the scanned S3 object after the scan result.
" + } + }, + "com.amazonaws.guardduty#MalwareProtectionPlanTaggingActionStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.guardduty#MalwareProtectionPlansSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MalwareProtectionPlanSummary" + } + }, + "com.amazonaws.guardduty#MalwareProtectionResourceType": { + "type": "enum", + "members": { + "EBS_RECOVERY_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_RECOVERY_POINT" + } + }, + "EBS_SNAPSHOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_SNAPSHOT" + } + }, + "EBS_VOLUME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_VOLUME" + } + }, + "EC2_AMI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_AMI" + } + }, + "EC2_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_INSTANCE" + } + }, + "EC2_RECOVERY_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_RECOVERY_POINT" + } + }, + "S3_RECOVERY_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_RECOVERY_POINT" + } + }, + "S3_BUCKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_BUCKET" + } + }, + "S3_POINT_IN_TIME_RECOVERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_POINT_IN_TIME_RECOVERY" + } + } + } + }, + "com.amazonaws.guardduty#MalwareProtectionScanStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "COMPLETED_WITH_ISSUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED_WITH_ISSUES" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + } + } + }, + "com.amazonaws.guardduty#MalwareProtectionScanType": { + "type": "enum", + "members": { + "BACKUP_INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BACKUP_INITIATED" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + }, + "GUARDDUTY_INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GUARDDUTY_INITIATED" + } + } + } + }, + "com.amazonaws.guardduty#MalwareScan": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource for the given malware scan.
", + "smithy.api#jsonName": "resourceArn" + } + }, + "ResourceType": { + "target": "com.amazonaws.guardduty#MalwareProtectionResourceType", + "traits": { + "smithy.api#documentation": "The type of resource that was scanned for malware.
", + "smithy.api#jsonName": "resourceType" + } + }, + "ScanId": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.
", + "smithy.api#jsonName": "scanId" + } + }, + "ScanStatus": { + "target": "com.amazonaws.guardduty#MalwareProtectionScanStatus", + "traits": { + "smithy.api#documentation": "An enum value representing the current status of the malware scan.
", + "smithy.api#jsonName": "scanStatus" + } + }, + "ScanResultStatus": { + "target": "com.amazonaws.guardduty#ScanResultStatus", + "traits": { + "smithy.api#documentation": "An enum value representing the result of the malware scan.
", + "smithy.api#jsonName": "scanResultStatus" + } + }, + "ScanType": { + "target": "com.amazonaws.guardduty#MalwareProtectionScanType", + "traits": { + "smithy.api#documentation": "An enum value representing the type of scan that was initiated.
", + "smithy.api#jsonName": "scanType" + } + }, + "ScanStartedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp representing when the malware scan was started.
", + "smithy.api#jsonName": "scanStartedAt" + } + }, + "ScanCompletedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp representing when the malware scan was completed.
", + "smithy.api#jsonName": "scanCompletedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a particular malware scan.
" + } + }, + "com.amazonaws.guardduty#MalwareScanDetails": { + "type": "structure", + "members": { + "Threats": { + "target": "com.amazonaws.guardduty#Threats", + "traits": { + "smithy.api#documentation": "Information about the detected threats associated with the generated GuardDuty finding.
", + "smithy.api#jsonName": "threats" + } + }, + "ScanId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the malware scan.
", + "smithy.api#jsonName": "scanId" + } + }, + "ScanType": { + "target": "com.amazonaws.guardduty#MalwareProtectionScanType", + "traits": { + "smithy.api#documentation": "The type of malware scan performed.
", + "smithy.api#jsonName": "scanType" + } + }, + "ScanCategory": { + "target": "com.amazonaws.guardduty#ScanCategory", + "traits": { + "smithy.api#documentation": "The category of the malware scan.
", + "smithy.api#jsonName": "scanCategory" + } + }, + "ScanConfiguration": { + "target": "com.amazonaws.guardduty#MalwareProtectionFindingsScanConfiguration", + "traits": { + "smithy.api#documentation": "The configuration settings used for the malware scan.
", + "smithy.api#jsonName": "scanConfiguration" + } + }, + "UniqueThreatCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of unique malware threats detected during the scan.
", + "smithy.api#jsonName": "uniqueThreatCount" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the malware scan that generated a GuardDuty finding.
" + } + }, + "com.amazonaws.guardduty#MalwareScans": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MalwareScan" + } + }, + "com.amazonaws.guardduty#ManagementType": { + "type": "enum", + "members": { + "AUTO_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_MANAGED" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.guardduty#MapEquals": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ScanConditionPair" + } + }, + "com.amazonaws.guardduty#Master": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the account used as the administrator account.
", + "smithy.api#jsonName": "accountId" + } + }, + "InvitationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The value used to validate the administrator account to the member account.
", + "smithy.api#jsonName": "invitationId" + } + }, + "RelationshipStatus": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The status of the relationship between the administrator and member accounts.
", + "smithy.api#jsonName": "relationshipStatus" + } + }, + "InvitedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The timestamp when the invitation was sent.
", + "smithy.api#jsonName": "invitedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the administrator account and invitation.
" + } + }, + "com.amazonaws.guardduty#Match": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.guardduty#Matches": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Match" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.guardduty#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#MaxResults100": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.guardduty#Member": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the member account.
", + "smithy.api#jsonName": "accountId", + "smithy.api#required": {} + } + }, + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detector ID of the member account.
", + "smithy.api#jsonName": "detectorId" + } + }, + "MasterId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The administrator account ID.
", + "smithy.api#jsonName": "masterId", + "smithy.api#required": {} + } + }, + "Email": { + "target": "com.amazonaws.guardduty#Email", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The email address of the member account.
", + "smithy.api#jsonName": "email", + "smithy.api#required": {} + } + }, + "RelationshipStatus": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the relationship between the member and the administrator.
", + "smithy.api#jsonName": "relationshipStatus", + "smithy.api#required": {} + } + }, + "InvitedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The timestamp when the invitation was sent.
", + "smithy.api#jsonName": "invitedAt" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The last-updated timestamp of the member.
", + "smithy.api#jsonName": "updatedAt", + "smithy.api#required": {} + } + }, + "AdministratorId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The administrator account ID.
", + "smithy.api#jsonName": "administratorId" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the member account.
" + } + }, + "com.amazonaws.guardduty#MemberAdditionalConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "Name of the additional configuration.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "Status of the additional configuration.
", + "smithy.api#jsonName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the additional configuration for the member account.
" + } + }, + "com.amazonaws.guardduty#MemberAdditionalConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "Indicates the name of the additional configuration that is set for the member account.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the additional configuration that is set for the member account.
", + "smithy.api#jsonName": "status" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the additional configuration was set for the member account. This is in UTC format.
", + "smithy.api#jsonName": "updatedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the additional configuration for the member account.
" + } + }, + "com.amazonaws.guardduty#MemberAdditionalConfigurationResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MemberAdditionalConfigurationResult" + } + }, + "com.amazonaws.guardduty#MemberAdditionalConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MemberAdditionalConfiguration" + } + }, + "com.amazonaws.guardduty#MemberDataSourceConfiguration": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The account ID for the member account.
", + "smithy.api#jsonName": "accountId", + "smithy.api#required": {} + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurationsResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Contains information on the status of data sources for the account.
", + "smithy.api#jsonName": "dataSources", + "smithy.api#required": {} + } + }, + "Features": { + "target": "com.amazonaws.guardduty#MemberFeaturesConfigurationsResults", + "traits": { + "smithy.api#documentation": "Contains information about the status of the features for the member account.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on which data sources are enabled for a member account.
" + } + }, + "com.amazonaws.guardduty#MemberDataSourceConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MemberDataSourceConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#MemberFeaturesConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeature", + "traits": { + "smithy.api#documentation": "The name of the feature.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "The status of the feature.
", + "smithy.api#jsonName": "status" + } + }, + "AdditionalConfiguration": { + "target": "com.amazonaws.guardduty#MemberAdditionalConfigurations", + "traits": { + "smithy.api#documentation": "Additional configuration of the feature for the member account.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the features for the member account.
" + } + }, + "com.amazonaws.guardduty#MemberFeaturesConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeature", + "traits": { + "smithy.api#documentation": "Indicates the name of the feature that is enabled for the detector.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the feature that is enabled for the detector.
", + "smithy.api#jsonName": "status" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the feature object was updated.
", + "smithy.api#jsonName": "updatedAt" + } + }, + "AdditionalConfiguration": { + "target": "com.amazonaws.guardduty#MemberAdditionalConfigurationResults", + "traits": { + "smithy.api#documentation": "Indicates the additional configuration of the feature that is configured for the member account.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the features for the member account.
" + } + }, + "com.amazonaws.guardduty#MemberFeaturesConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MemberFeaturesConfiguration" + } + }, + "com.amazonaws.guardduty#MemberFeaturesConfigurationsResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MemberFeaturesConfigurationResult" + } + }, + "com.amazonaws.guardduty#Members": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Member" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#MemoryRegionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#MfaStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.guardduty#ModelDetail": { + "type": "structure", + "members": { + "ModelId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The identifier of the AI model.
", + "smithy.api#jsonName": "modelId", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the AI model involved in a finding.
" + } + }, + "com.amazonaws.guardduty#ModelDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ModelDetail" + } + }, + "com.amazonaws.guardduty#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#Neq": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#NetworkConnection": { + "type": "structure", + "members": { + "Direction": { + "target": "com.amazonaws.guardduty#NetworkDirection", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The direction in which the network traffic is flowing.
", + "smithy.api#jsonName": "direction", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the network connection.
" + } + }, + "com.amazonaws.guardduty#NetworkConnectionAction": { + "type": "structure", + "members": { + "Blocked": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether EC2 blocked the network connection to your instance.
", + "smithy.api#jsonName": "blocked" + } + }, + "ConnectionDirection": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The network connection direction.
", + "smithy.api#jsonName": "connectionDirection" + } + }, + "LocalPortDetails": { + "target": "com.amazonaws.guardduty#LocalPortDetails", + "traits": { + "smithy.api#documentation": "The local port information of the connection.
", + "smithy.api#jsonName": "localPortDetails" + } + }, + "Protocol": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The network connection protocol.
", + "smithy.api#jsonName": "protocol" + } + }, + "LocalIpDetails": { + "target": "com.amazonaws.guardduty#LocalIpDetails", + "traits": { + "smithy.api#documentation": "The local IP information of the connection.
", + "smithy.api#jsonName": "localIpDetails" + } + }, + "LocalNetworkInterface": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The EC2 instance's local elastic network interface utilized for the connection.
", + "smithy.api#jsonName": "localNetworkInterface" + } + }, + "RemoteIpDetails": { + "target": "com.amazonaws.guardduty#RemoteIpDetails", + "traits": { + "smithy.api#documentation": "The remote IP information of the connection.
", + "smithy.api#jsonName": "remoteIpDetails" + } + }, + "RemotePortDetails": { + "target": "com.amazonaws.guardduty#RemotePortDetails", + "traits": { + "smithy.api#documentation": "The remote port information of the connection.
", + "smithy.api#jsonName": "remotePortDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the NETWORK_CONNECTION action described in the finding.
" + } + }, + "com.amazonaws.guardduty#NetworkDirection": { + "type": "enum", + "members": { + "INBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INBOUND" + } + }, + "OUTBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTBOUND" + } + } + } + }, + "com.amazonaws.guardduty#NetworkEndpoint": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the network endpoint.
", + "smithy.api#jsonName": "id", + "smithy.api#required": {} + } + }, + "Ip": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The IP address associated with the network endpoint.
", + "smithy.api#jsonName": "ip" + } + }, + "Domain": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The domain information for the network endpoint.
", + "smithy.api#jsonName": "domain" + } + }, + "Port": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The port number associated with the network endpoint.
", + "smithy.api#jsonName": "port" + } + }, + "Location": { + "target": "com.amazonaws.guardduty#NetworkGeoLocation", + "traits": { + "smithy.api#documentation": "Information about the location of the network endpoint.
", + "smithy.api#jsonName": "location" + } + }, + "AutonomousSystem": { + "target": "com.amazonaws.guardduty#AutonomousSystem", + "traits": { + "smithy.api#documentation": "The Autonomous System (AS) of the network endpoint.
", + "smithy.api#jsonName": "autonomousSystem" + } + }, + "Connection": { + "target": "com.amazonaws.guardduty#NetworkConnection", + "traits": { + "smithy.api#documentation": "Information about the network connection.
", + "smithy.api#jsonName": "connection" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about network endpoints that were observed in the attack sequence.
" + } + }, + "com.amazonaws.guardduty#NetworkEndpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#NetworkEndpoint" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, + "com.amazonaws.guardduty#NetworkGeoLocation": { + "type": "structure", + "members": { + "City": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the city.
", + "smithy.api#jsonName": "city", + "smithy.api#required": {} + } + }, + "Country": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the country.
", + "smithy.api#jsonName": "country", + "smithy.api#required": {} + } + }, + "Latitude": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The latitude information of the endpoint location.
", + "smithy.api#jsonName": "lat", + "smithy.api#required": {} + } + }, + "Longitude": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The longitude information of the endpoint location.
", + "smithy.api#jsonName": "lon", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about network endpoint location.
" + } + }, + "com.amazonaws.guardduty#NetworkInterface": { + "type": "structure", + "members": { + "Ipv6Addresses": { + "target": "com.amazonaws.guardduty#Ipv6Addresses", + "traits": { + "smithy.api#documentation": "A list of IPv6 addresses for the EC2 instance.
", + "smithy.api#jsonName": "ipv6Addresses" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ID of the network interface.
", + "smithy.api#jsonName": "networkInterfaceId" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The private DNS name of the EC2 instance.
", + "smithy.api#jsonName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.guardduty#SensitiveString", + "traits": { + "smithy.api#documentation": "The private IP address of the EC2 instance.
", + "smithy.api#jsonName": "privateIpAddress" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.guardduty#PrivateIpAddresses", + "traits": { + "smithy.api#documentation": "Other private IP address information of the EC2 instance.
", + "smithy.api#jsonName": "privateIpAddresses" + } + }, + "PublicDnsName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The public DNS name of the EC2 instance.
", + "smithy.api#jsonName": "publicDnsName" + } + }, + "PublicIp": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The public IP address of the EC2 instance.
", + "smithy.api#jsonName": "publicIp" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.guardduty#SecurityGroups", + "traits": { + "smithy.api#documentation": "The security groups associated with the EC2 instance.
", + "smithy.api#jsonName": "securityGroups" + } + }, + "SubnetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The subnet ID of the EC2 instance.
", + "smithy.api#jsonName": "subnetId" + } + }, + "VpcId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The VPC ID of the EC2 instance.
", + "smithy.api#jsonName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the elastic network interface of the EC2 instance.
" + } + }, + "com.amazonaws.guardduty#NetworkInterfaces": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#NetworkInterface" + } + }, + "com.amazonaws.guardduty#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9+/=_\\-]+$" + } + }, + "com.amazonaws.guardduty#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.guardduty#NonNegativeInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.guardduty#NotEquals": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#NotMatch": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.guardduty#NotMatches": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#NotMatch" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.guardduty#ObservationNumbers": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Long" + } + }, + "com.amazonaws.guardduty#ObservationTexts": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Observations": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.guardduty#ObservationTexts", + "traits": { + "smithy.api#documentation": "The text that was unusual.
", + "smithy.api#jsonName": "text" + } + }, + "Number": { + "target": "com.amazonaws.guardduty#ObservationNumbers", + "traits": { + "smithy.api#documentation": "The numeric values that were unusual.
", + "smithy.api#jsonName": "number" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the observed behavior.
" + } + }, + "com.amazonaws.guardduty#OrderBy": { + "type": "enum", + "members": { + "ASC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASC" + } + }, + "DESC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESC" + } + } + } + }, + "com.amazonaws.guardduty#OrgFeature": { + "type": "enum", + "members": { + "S3_DATA_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_DATA_EVENTS" + } + }, + "EKS_AUDIT_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_AUDIT_LOGS" + } + }, + "EBS_MALWARE_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" + } + }, + "RDS_LOGIN_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_LOGIN_EVENTS" + } + }, + "LAMBDA_NETWORK_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" + } + }, + "EKS_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" + } + }, + "RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNTIME_MONITORING" + } + }, + "AI_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AI_PROTECTION" + } + } + } + }, + "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration": { + "type": "enum", + "members": { + "EKS_ADDON_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_ADDON_MANAGEMENT" + } + }, + "ECS_FARGATE_AGENT_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS_FARGATE_AGENT_MANAGEMENT" + } + }, + "EC2_AGENT_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_AGENT_MANAGEMENT" + } + } + } + }, + "com.amazonaws.guardduty#OrgFeatureStatus": { + "type": "enum", + "members": { + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.guardduty#Organization": { + "type": "structure", + "members": { + "Asn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Autonomous System Number (ASN) of the internet provider of the remote IP address.
", + "smithy.api#jsonName": "asn" + } + }, + "AsnOrg": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The organization that registered this ASN.
", + "smithy.api#jsonName": "asnOrg" + } + }, + "Isp": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ISP information for the internet provider.
", + "smithy.api#jsonName": "isp" + } + }, + "Org": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the internet provider.
", + "smithy.api#jsonName": "org" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the ISP organization of the remote IP address.
" + } + }, + "com.amazonaws.guardduty#OrganizationAdditionalConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "The name of the additional configuration that will be configured for the organization. These values are applicable to only Runtime Monitoring protection plan.
", + "smithy.api#jsonName": "name" + } + }, + "AutoEnable": { + "target": "com.amazonaws.guardduty#OrgFeatureStatus", + "traits": { + "smithy.api#documentation": "The status of the additional configuration that will be configured for the organization. Use one of the following values to configure the feature status for the entire organization:
NEW: Indicates that when a new account joins the organization, they will have the additional configuration enabled automatically.
ALL: Indicates that all accounts in the organization have the additional configuration enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
NONE: Indicates that the additional configuration will not be automatically enabled for any account in the organization. The administrator must manage the additional configuration for each account individually.
A list of additional configurations which will be configured for the organization.
Additional configuration applies to only GuardDuty Runtime Monitoring protection plan.
" + } + }, + "com.amazonaws.guardduty#OrganizationAdditionalConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "The name of the additional configuration that is configured for the member accounts within the organization. These values are applicable to only Runtime Monitoring protection plan.
", + "smithy.api#jsonName": "name" + } + }, + "AutoEnable": { + "target": "com.amazonaws.guardduty#OrgFeatureStatus", + "traits": { + "smithy.api#documentation": "Describes the status of the additional configuration that is configured for the member accounts within the organization. One of the following values is the status for the entire organization:
NEW: Indicates that when a new account joins the organization, they will have the additional configuration enabled automatically.
ALL: Indicates that all accounts in the organization have the additional configuration enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
NONE: Indicates that the additional configuration will not be automatically enabled for any account in the organization. The administrator must manage the additional configuration for each account individually.
A list of additional configuration which will be configured for the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationAdditionalConfigurationResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#OrganizationAdditionalConfigurationResult" + } + }, + "com.amazonaws.guardduty#OrganizationAdditionalConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#OrganizationAdditionalConfiguration" + } + }, + "com.amazonaws.guardduty#OrganizationDataSourceConfigurations": { + "type": "structure", + "members": { + "S3Logs": { + "target": "com.amazonaws.guardduty#OrganizationS3LogsConfiguration", + "traits": { + "smithy.api#documentation": "Describes whether S3 data event logs are enabled for new members of the organization.
", + "smithy.api#jsonName": "s3Logs" + } + }, + "Kubernetes": { + "target": "com.amazonaws.guardduty#OrganizationKubernetesConfiguration", + "traits": { + "smithy.api#documentation": "Describes the configuration of Kubernetes data sources for new members of the organization.
", + "smithy.api#jsonName": "kubernetes" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#OrganizationMalwareProtectionConfiguration", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection for new members of the organization.
", + "smithy.api#jsonName": "malwareProtection" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on which data sources will be configured to be automatically enabled for new members within the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationDataSourceConfigurationsResult": { + "type": "structure", + "members": { + "S3Logs": { + "target": "com.amazonaws.guardduty#OrganizationS3LogsConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes whether S3 data event logs are enabled as a data source.
", + "smithy.api#jsonName": "s3Logs", + "smithy.api#required": {} + } + }, + "Kubernetes": { + "target": "com.amazonaws.guardduty#OrganizationKubernetesConfigurationResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of Kubernetes data sources.
", + "smithy.api#jsonName": "kubernetes" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#OrganizationMalwareProtectionConfigurationResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection data source for an organization.
", + "smithy.api#jsonName": "malwareProtection" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on which data sources are automatically enabled for new members within the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationDetails": { + "type": "structure", + "members": { + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the organization statistics was last updated. This is in UTC format.
", + "smithy.api#jsonName": "updatedAt" + } + }, + "OrganizationStatistics": { + "target": "com.amazonaws.guardduty#OrganizationStatistics", + "traits": { + "smithy.api#documentation": "Information about the GuardDuty coverage statistics for members in your Amazon Web Services organization.
", + "smithy.api#jsonName": "organizationStatistics" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about GuardDuty coverage statistics for members in your Amazon Web Services organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationEbsVolumes": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether scanning EBS volumes should be auto-enabled for new members joining the organization.
", + "smithy.api#jsonName": "autoEnable" + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide EBS volumes scan configuration.
" + } + }, + "com.amazonaws.guardduty#OrganizationEbsVolumesResult": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "An object that contains the status of whether scanning EBS volumes should be auto-enabled for new members joining the organization.
", + "smithy.api#jsonName": "autoEnable" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of whether EBS volumes scanning will be enabled as a data source for an organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationFeatureConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeature", + "traits": { + "smithy.api#documentation": "The name of the feature that will be configured for the organization.
", + "smithy.api#jsonName": "name" + } + }, + "AutoEnable": { + "target": "com.amazonaws.guardduty#OrgFeatureStatus", + "traits": { + "smithy.api#documentation": "Describes the status of the feature that is configured for the member accounts within the organization. One of the following values is the status for the entire organization:
NEW: Indicates that when a new account joins the organization, they will have the feature enabled automatically.
ALL: Indicates that all accounts in the organization have the feature enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
NONE: Indicates that the feature will not be automatically enabled for any account in the organization. The administrator must manage the feature for each account individually.
The additional information that will be configured for the organization.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of features which will be configured for the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationFeatureConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeature", + "traits": { + "smithy.api#documentation": "The name of the feature that is configured for the member accounts within the organization.
", + "smithy.api#jsonName": "name" + } + }, + "AutoEnable": { + "target": "com.amazonaws.guardduty#OrgFeatureStatus", + "traits": { + "smithy.api#documentation": "Describes the status of the feature that is configured for the member accounts within the organization.
NEW: Indicates that when a new account joins the organization, they will have the feature enabled automatically.
ALL: Indicates that all accounts in the organization have the feature enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.
NONE: Indicates that the feature will not be automatically enabled for any account in the organization. In this case, each account will be managed individually by the administrator.
The additional configuration that is configured for the member accounts within the organization.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of features which will be configured for the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationFeatureStatistics": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeature", + "traits": { + "smithy.api#documentation": "Name of the feature.
", + "smithy.api#jsonName": "name" + } + }, + "EnabledAccountsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of accounts that have enabled a specific feature.
", + "smithy.api#jsonName": "enabledAccountsCount" + } + }, + "AdditionalConfiguration": { + "target": "com.amazonaws.guardduty#OrganizationFeatureStatisticsAdditionalConfigurations", + "traits": { + "smithy.api#documentation": "Name of the additional configuration.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the number of accounts that have enabled a specific feature.
" + } + }, + "com.amazonaws.guardduty#OrganizationFeatureStatisticsAdditionalConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "Name of the additional configuration within a feature.
", + "smithy.api#jsonName": "name" + } + }, + "EnabledAccountsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of accounts that have enabled the additional configuration.
", + "smithy.api#jsonName": "enabledAccountsCount" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the coverage statistic for the additional configuration of the feature.
" + } + }, + "com.amazonaws.guardduty#OrganizationFeatureStatisticsAdditionalConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#OrganizationFeatureStatisticsAdditionalConfiguration" + } + }, + "com.amazonaws.guardduty#OrganizationFeatureStatisticsResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#OrganizationFeatureStatistics" + } + }, + "com.amazonaws.guardduty#OrganizationFeaturesConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#OrganizationFeatureConfiguration" + } + }, + "com.amazonaws.guardduty#OrganizationFeaturesConfigurationsResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#OrganizationFeatureConfigurationResult" + } + }, + "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfiguration": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A value that contains information on whether Kubernetes audit logs should be enabled automatically as a data source for the organization.
", + "smithy.api#jsonName": "autoEnable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide Kubernetes audit logs configuration.
" + } + }, + "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfigurationResult": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Whether Kubernetes audit logs data source should be auto-enabled for new members joining the organization.
", + "smithy.api#jsonName": "autoEnable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The current configuration of Kubernetes audit logs as a data source for the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationKubernetesConfiguration": { + "type": "structure", + "members": { + "AuditLogs": { + "target": "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfiguration", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Whether Kubernetes audit logs data source should be auto-enabled for new members joining the organization.
", + "smithy.api#jsonName": "auditLogs", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide Kubernetes data sources configurations.
" + } + }, + "com.amazonaws.guardduty#OrganizationKubernetesConfigurationResult": { + "type": "structure", + "members": { + "AuditLogs": { + "target": "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current configuration of Kubernetes audit logs as a data source for the organization.
", + "smithy.api#jsonName": "auditLogs", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The current configuration of all Kubernetes data sources for the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationMalwareProtectionConfiguration": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindings", + "traits": { + "smithy.api#documentation": "Whether Malware Protection for EC2 instances with findings should be auto-enabled for new members joining the organization.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide Malware Protection configurations.
" + } + }, + "com.amazonaws.guardduty#OrganizationMalwareProtectionConfigurationResult": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindingsResult", + "traits": { + "smithy.api#documentation": "Describes the configuration for scanning EC2 instances with findings for an organization.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of all Malware Protection data source for an organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationS3LogsConfiguration": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A value that contains information on whether S3 data event logs will be enabled automatically as a data source for the organization.
", + "smithy.api#jsonName": "autoEnable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether S3 data event logs will be automatically enabled for new members of the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationS3LogsConfigurationResult": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A value that describes whether S3 data event logs are automatically enabled for new members of the organization.
", + "smithy.api#jsonName": "autoEnable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The current configuration of S3 data event logs as a data source for the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindings": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.guardduty#OrganizationEbsVolumes", + "traits": { + "smithy.api#documentation": "Whether scanning EBS volumes should be auto-enabled for new members joining the organization.
", + "smithy.api#jsonName": "ebsVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide EC2 instances with findings scan configuration.
" + } + }, + "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindingsResult": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.guardduty#OrganizationEbsVolumesResult", + "traits": { + "smithy.api#documentation": "Describes the configuration for scanning EBS volumes for an organization.
", + "smithy.api#jsonName": "ebsVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of scanning EC2 instances with findings for an organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationStatistics": { + "type": "structure", + "members": { + "TotalAccountsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of accounts in your Amazon Web Services organization.
", + "smithy.api#jsonName": "totalAccountsCount" + } + }, + "MemberAccountsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of accounts in your Amazon Web Services organization that are associated with GuardDuty.
", + "smithy.api#jsonName": "memberAccountsCount" + } + }, + "ActiveAccountsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of active accounts in your Amazon Web Services organization that are associated with GuardDuty.
", + "smithy.api#jsonName": "activeAccountsCount" + } + }, + "EnabledAccountsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of accounts that have enabled GuardDuty.
", + "smithy.api#jsonName": "enabledAccountsCount" + } + }, + "CountByFeature": { + "target": "com.amazonaws.guardduty#OrganizationFeatureStatisticsResults", + "traits": { + "smithy.api#documentation": "Retrieves the coverage statistics for each feature.
", + "smithy.api#jsonName": "countByFeature" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the coverage statistics of the features for the entire Amazon Web Services organization.
When you create a new Amazon Web Services organization, it might take up to 24 hours to generate the statistics summary for this organization.
" + } + }, + "com.amazonaws.guardduty#Owner": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The canonical user ID of the bucket owner. For information about locating your canonical user ID see Finding Your Account Canonical User ID.
", + "smithy.api#jsonName": "id" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the owner of the bucket.
" + } + }, + "com.amazonaws.guardduty#PermissionConfiguration": { + "type": "structure", + "members": { + "BucketLevelPermissions": { + "target": "com.amazonaws.guardduty#BucketLevelPermissions", + "traits": { + "smithy.api#documentation": "Contains information about the bucket level permissions for the S3 bucket.
", + "smithy.api#jsonName": "bucketLevelPermissions" + } + }, + "AccountLevelPermissions": { + "target": "com.amazonaws.guardduty#AccountLevelPermissions", + "traits": { + "smithy.api#documentation": "Contains information about the account level permissions on the S3 bucket.
", + "smithy.api#jsonName": "accountLevelPermissions" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about how permissions are configured for the S3 bucket.
" + } + }, + "com.amazonaws.guardduty#PortProbeAction": { + "type": "structure", + "members": { + "Blocked": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether EC2 blocked the port probe to the instance, such as with an ACL.
", + "smithy.api#jsonName": "blocked" + } + }, + "PortProbeDetails": { + "target": "com.amazonaws.guardduty#PortProbeDetails", + "traits": { + "smithy.api#documentation": "A list of objects related to port probe details.
", + "smithy.api#jsonName": "portProbeDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the PORT_PROBE action described in the finding.
" + } + }, + "com.amazonaws.guardduty#PortProbeDetail": { + "type": "structure", + "members": { + "LocalPortDetails": { + "target": "com.amazonaws.guardduty#LocalPortDetails", + "traits": { + "smithy.api#documentation": "The local port information of the connection.
", + "smithy.api#jsonName": "localPortDetails" + } + }, + "LocalIpDetails": { + "target": "com.amazonaws.guardduty#LocalIpDetails", + "traits": { + "smithy.api#documentation": "The local IP information of the connection.
", + "smithy.api#jsonName": "localIpDetails" + } + }, + "RemoteIpDetails": { + "target": "com.amazonaws.guardduty#RemoteIpDetails", + "traits": { + "smithy.api#documentation": "The remote IP information of the connection.
", + "smithy.api#jsonName": "remoteIpDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the port probe details.
" + } + }, + "com.amazonaws.guardduty#PortProbeDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#PortProbeDetail" + } + }, + "com.amazonaws.guardduty#PositiveLong": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.guardduty#PrivateIpAddressDetails": { + "type": "structure", + "members": { + "PrivateDnsName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The private DNS name of the EC2 instance.
", + "smithy.api#jsonName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.guardduty#SensitiveString", + "traits": { + "smithy.api#documentation": "The private IP address of the EC2 instance.
", + "smithy.api#jsonName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains other private IP address information of the EC2 instance.
" + } + }, + "com.amazonaws.guardduty#PrivateIpAddresses": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#PrivateIpAddressDetails" + } + }, + "com.amazonaws.guardduty#ProcessDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the process.
", + "smithy.api#jsonName": "name" + } + }, + "ExecutablePath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The absolute path of the process executable file.
", + "smithy.api#jsonName": "executablePath" + } + }, + "ExecutableSha256": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The SHA256 hash of the process executable.
The ID of the child process.
", + "smithy.api#jsonName": "namespacePid" + } + }, + "Pwd": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The present working directory of the process.
", + "smithy.api#jsonName": "pwd" + } + }, + "Pid": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The ID of the process.
", + "smithy.api#jsonName": "pid" + } + }, + "StartTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the process started. This is in UTC format.
", + "smithy.api#jsonName": "startTime" + } + }, + "Uuid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID assigned to the process by GuardDuty.
", + "smithy.api#jsonName": "uuid" + } + }, + "ParentUuid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID of the parent process. This ID is assigned to the parent process by GuardDuty.
", + "smithy.api#jsonName": "parentUuid" + } + }, + "User": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The user that executed the process.
", + "smithy.api#jsonName": "user" + } + }, + "UserId": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The unique ID of the user that executed the process.
", + "smithy.api#jsonName": "userId" + } + }, + "Euid": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The effective user ID of the user that executed the process.
", + "smithy.api#jsonName": "euid" + } + }, + "Lineage": { + "target": "com.amazonaws.guardduty#Lineage", + "traits": { + "smithy.api#documentation": "Information about the process's lineage.
", + "smithy.api#jsonName": "lineage" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the observed process.
" + } + }, + "com.amazonaws.guardduty#ProcessName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.guardduty#ProcessPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.guardduty#ProcessSha256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.guardduty#Product": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the product.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Feature": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The specific feature within the product that produced the investigation.
", + "smithy.api#jsonName": "feature" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the product that produced an investigation.
" + } + }, + "com.amazonaws.guardduty#ProductCode": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The product code information.
", + "smithy.api#jsonName": "productCodeId" + } + }, + "ProductType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The product code type.
", + "smithy.api#jsonName": "productCodeType" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the product code for the EC2 instance.
" + } + }, + "com.amazonaws.guardduty#ProductCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ProductCode" + } + }, + "com.amazonaws.guardduty#ProfileSubtype": { + "type": "enum", + "members": { + "FREQUENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FREQUENT" + } + }, + "INFREQUENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFREQUENT" + } + }, + "UNSEEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSEEN" + } + }, + "RARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RARE" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + } + } + }, + "com.amazonaws.guardduty#ProfileType": { + "type": "enum", + "members": { + "FREQUENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FREQUENCY" + } + }, + "VOLUME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOLUME" + } + } + } + }, + "com.amazonaws.guardduty#PublicAccess": { + "type": "structure", + "members": { + "PermissionConfiguration": { + "target": "com.amazonaws.guardduty#PermissionConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about how permissions are configured for the S3 bucket.
", + "smithy.api#jsonName": "permissionConfiguration" + } + }, + "EffectivePermission": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Describes the effective permission on this bucket after factoring all attached policies.
", + "smithy.api#jsonName": "effectivePermission" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the public access policies that apply to the S3 bucket.
" + } + }, + "com.amazonaws.guardduty#PublicAccessConfiguration": { + "type": "structure", + "members": { + "PublicAclAccess": { + "target": "com.amazonaws.guardduty#PublicAccessStatus", + "traits": { + "smithy.api#documentation": "Indicates whether or not there is a setting that allows public access to the Amazon S3 buckets through access control lists (ACLs).
", + "smithy.api#jsonName": "publicAclAccess" + } + }, + "PublicPolicyAccess": { + "target": "com.amazonaws.guardduty#PublicAccessStatus", + "traits": { + "smithy.api#documentation": "Indicates whether or not there is a setting that allows public access to the Amazon S3 bucket policy.
", + "smithy.api#jsonName": "publicPolicyAccess" + } + }, + "PublicAclIgnoreBehavior": { + "target": "com.amazonaws.guardduty#PublicAclIgnoreBehavior", + "traits": { + "smithy.api#documentation": "Indicates whether or not there is a setting that ignores all public access control lists (ACLs) on the Amazon S3 bucket and the objects that it contains.
", + "smithy.api#jsonName": "publicAclIgnoreBehavior" + } + }, + "PublicBucketRestrictBehavior": { + "target": "com.amazonaws.guardduty#PublicBucketRestrictBehavior", + "traits": { + "smithy.api#documentation": "Indicates whether or not there is a setting that restricts access to the bucket with specified policies.
", + "smithy.api#jsonName": "publicBucketRestrictBehavior" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes public access policies that apply to the Amazon S3 bucket.
For information about each of the following settings, see Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.
" + } + }, + "com.amazonaws.guardduty#PublicAccessStatus": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + }, + "ALLOWED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOWED" + } + } + } + }, + "com.amazonaws.guardduty#PublicAclIgnoreBehavior": { + "type": "enum", + "members": { + "IGNORED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGNORED" + } + }, + "NOT_IGNORED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_IGNORED" + } + } + } + }, + "com.amazonaws.guardduty#PublicBucketRestrictBehavior": { + "type": "enum", + "members": { + "RESTRICTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESTRICTED" + } + }, + "NOT_RESTRICTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_RESTRICTED" + } + } + } + }, + "com.amazonaws.guardduty#PublishingStatus": { + "type": "enum", + "members": { + "PENDING_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VERIFICATION" + } + }, + "PUBLISHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLISHING" + } + }, + "UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#RdsDbInstanceDetails": { + "type": "structure", + "members": { + "DbInstanceIdentifier": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The identifier associated to the database instance that was involved in the finding.
", + "smithy.api#jsonName": "dbInstanceIdentifier" + } + }, + "Engine": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The database engine of the database instance involved in the finding.
", + "smithy.api#jsonName": "engine" + } + }, + "EngineVersion": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version of the database engine that was involved in the finding.
", + "smithy.api#jsonName": "engineVersion" + } + }, + "DbClusterIdentifier": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The identifier of the database cluster that contains the database instance ID involved in the finding.
", + "smithy.api#jsonName": "dbClusterIdentifier" + } + }, + "DbInstanceArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the database instance involved in the finding.
", + "smithy.api#jsonName": "dbInstanceArn" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID of the database resource involved in the activity that prompted GuardDuty to generate the finding.
", + "smithy.api#jsonName": "dbiResourceId" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "Information about the tag key-value pairs.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the resource type RDSDBInstance involved in a GuardDuty finding.
The user name used in the anomalous login attempt.
", + "smithy.api#jsonName": "user" + } + }, + "Application": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The application name used in the anomalous login attempt.
", + "smithy.api#jsonName": "application" + } + }, + "Database": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the database instance involved in the anomalous login attempt.
", + "smithy.api#jsonName": "database" + } + }, + "Ssl": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version of the Secure Socket Layer (SSL) used for the network.
", + "smithy.api#jsonName": "ssl" + } + }, + "AuthMethod": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The authentication method used by the user involved in the finding.
", + "smithy.api#jsonName": "authMethod" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the user and authentication details for a database instance involved in the finding.
" + } + }, + "com.amazonaws.guardduty#RdsLimitlessDbDetails": { + "type": "structure", + "members": { + "DbShardGroupIdentifier": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name associated with the Limitless DB shard group.
", + "smithy.api#jsonName": "dbShardGroupIdentifier" + } + }, + "DbShardGroupResourceId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The resource identifier of the DB shard group within the Limitless Database.
", + "smithy.api#jsonName": "dbShardGroupResourceId" + } + }, + "DbShardGroupArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the DB shard group.
", + "smithy.api#jsonName": "dbShardGroupArn" + } + }, + "Engine": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The database engine of the database instance involved in the finding.
", + "smithy.api#jsonName": "engine" + } + }, + "EngineVersion": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version of the database engine.
", + "smithy.api#jsonName": "engineVersion" + } + }, + "DbClusterIdentifier": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the database cluster that is a part of the Limitless Database.
", + "smithy.api#jsonName": "dbClusterIdentifier" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "Information about the tag key-value pair.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the resource type RDSLimitlessDB that is involved in a GuardDuty finding.
Indicates the login attributes used in the login attempt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates that a login attempt was made to the potentially compromised database from a remote IP address.
" + } + }, + "com.amazonaws.guardduty#RecoveryPoint": { + "type": "structure", + "members": { + "BackupVaultName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Amazon Web Services Backup vault that contains the name of the recovery point to be scanned.
", + "smithy.api#jsonName": "backupVaultName", + "smithy.api#required": {} + } + }, + "ContinuousScanDetails": { + "target": "com.amazonaws.guardduty#ContinuousScanDetails", + "traits": { + "smithy.api#documentation": "Contains information about the time range within the continuous backup in Amazon Web Services Backup to scan.
", + "smithy.api#jsonName": "continuousScanDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the recovery point configuration for scanning backup data from Amazon Web Services Backup.
" + } + }, + "com.amazonaws.guardduty#RecoveryPointDetails": { + "type": "structure", + "members": { + "RecoveryPointArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recovery point.
", + "smithy.api#jsonName": "recoveryPointArn" + } + }, + "BackupVaultName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the backup vault containing the recovery point.
", + "smithy.api#jsonName": "backupVaultName" + } + }, + "ContinuousScanDetails": { + "target": "com.amazonaws.guardduty#ScanConfigurationContinuousScanDetails", + "traits": { + "smithy.api#jsonName": "continuousScanDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the backup recovery point.
" + } + }, + "com.amazonaws.guardduty#RelatedFilePathsList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.guardduty#RemoteAccountDetails": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the remote API caller.
", + "smithy.api#jsonName": "accountId" + } + }, + "Affiliated": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Details on whether the Amazon Web Services account of the remote API caller is related to your GuardDuty environment. If this value is True the API caller is affiliated to your account in some way. If it is False the API caller is from outside your environment.
Contains details about the remote Amazon Web Services account that made the API call.
" + } + }, + "com.amazonaws.guardduty#RemoteIpDetails": { + "type": "structure", + "members": { + "City": { + "target": "com.amazonaws.guardduty#City", + "traits": { + "smithy.api#documentation": "The city information of the remote IP address.
", + "smithy.api#jsonName": "city" + } + }, + "Country": { + "target": "com.amazonaws.guardduty#Country", + "traits": { + "smithy.api#documentation": "The country code of the remote IP address.
", + "smithy.api#jsonName": "country" + } + }, + "GeoLocation": { + "target": "com.amazonaws.guardduty#GeoLocation", + "traits": { + "smithy.api#documentation": "The location information of the remote IP address.
", + "smithy.api#jsonName": "geoLocation" + } + }, + "IpAddressV4": { + "target": "com.amazonaws.guardduty#SensitiveString", + "traits": { + "smithy.api#documentation": "The IPv4 remote address of the connection.
", + "smithy.api#jsonName": "ipAddressV4" + } + }, + "IpAddressV6": { + "target": "com.amazonaws.guardduty#SensitiveString", + "traits": { + "smithy.api#documentation": "The IPv6 remote address of the connection.
", + "smithy.api#jsonName": "ipAddressV6" + } + }, + "Organization": { + "target": "com.amazonaws.guardduty#Organization", + "traits": { + "smithy.api#documentation": "The ISP organization information of the remote IP address.
", + "smithy.api#jsonName": "organization" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the remote IP address of the connection.
" + } + }, + "com.amazonaws.guardduty#RemotePortDetails": { + "type": "structure", + "members": { + "Port": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The port number of the remote connection.
", + "smithy.api#jsonName": "port" + } + }, + "PortName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The port name of the remote connection.
", + "smithy.api#jsonName": "portName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the remote port.
" + } + }, + "com.amazonaws.guardduty#Resource": { + "type": "structure", + "members": { + "AccessKeyDetails": { + "target": "com.amazonaws.guardduty#AccessKeyDetails", + "traits": { + "smithy.api#documentation": "The IAM access key details (user information) of a user that engaged in the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "accessKeyDetails" + } + }, + "S3BucketDetails": { + "target": "com.amazonaws.guardduty#S3BucketDetails", + "traits": { + "smithy.api#documentation": "Contains information on the S3 bucket.
", + "smithy.api#jsonName": "s3BucketDetails" + } + }, + "InstanceDetails": { + "target": "com.amazonaws.guardduty#InstanceDetails", + "traits": { + "smithy.api#documentation": "The information about the EC2 instance associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "instanceDetails" + } + }, + "EksClusterDetails": { + "target": "com.amazonaws.guardduty#EksClusterDetails", + "traits": { + "smithy.api#documentation": "Details about the EKS cluster involved in a Kubernetes finding.
", + "smithy.api#jsonName": "eksClusterDetails" + } + }, + "KubernetesDetails": { + "target": "com.amazonaws.guardduty#KubernetesDetails", + "traits": { + "smithy.api#documentation": "Details about the Kubernetes user and workload involved in a Kubernetes finding.
", + "smithy.api#jsonName": "kubernetesDetails" + } + }, + "ResourceType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The type of Amazon Web Services resource.
", + "smithy.api#jsonName": "resourceType" + } + }, + "EbsVolumeDetails": { + "target": "com.amazonaws.guardduty#EbsVolumeDetails", + "traits": { + "smithy.api#documentation": "Contains list of scanned and skipped EBS volumes with details.
", + "smithy.api#jsonName": "ebsVolumeDetails" + } + }, + "EcsClusterDetails": { + "target": "com.amazonaws.guardduty#EcsClusterDetails", + "traits": { + "smithy.api#documentation": "Contains information about the details of the ECS Cluster.
", + "smithy.api#jsonName": "ecsClusterDetails" + } + }, + "ContainerDetails": { + "target": "com.amazonaws.guardduty#Container", + "traits": { + "smithy.api#jsonName": "containerDetails" + } + }, + "LambdaDetails": { + "target": "com.amazonaws.guardduty#LambdaDetails", + "traits": { + "smithy.api#documentation": "Contains information about the Lambda function that was involved in a finding.
", + "smithy.api#jsonName": "lambdaDetails" + } + }, + "RdsDbInstanceDetails": { + "target": "com.amazonaws.guardduty#RdsDbInstanceDetails", + "traits": { + "smithy.api#documentation": "Contains information about the database instance to which an anomalous login attempt was made.
", + "smithy.api#jsonName": "rdsDbInstanceDetails" + } + }, + "RdsLimitlessDbDetails": { + "target": "com.amazonaws.guardduty#RdsLimitlessDbDetails", + "traits": { + "smithy.api#documentation": "Contains information about the RDS Limitless database that was involved in a GuardDuty finding.
", + "smithy.api#jsonName": "rdsLimitlessDbDetails" + } + }, + "RdsDbUserDetails": { + "target": "com.amazonaws.guardduty#RdsDbUserDetails", + "traits": { + "smithy.api#documentation": "Contains information about the user details through which anomalous login attempt was made.
", + "smithy.api#jsonName": "rdsDbUserDetails" + } + }, + "EbsSnapshotDetails": { + "target": "com.amazonaws.guardduty#EbsSnapshotDetails", + "traits": { + "smithy.api#documentation": "Contains details about the EBS snapshot that was scanned.
", + "smithy.api#jsonName": "ebsSnapshotDetails" + } + }, + "Ec2ImageDetails": { + "target": "com.amazonaws.guardduty#Ec2ImageDetails", + "traits": { + "smithy.api#documentation": "Contains details about the EC2 image that was scanned.
", + "smithy.api#jsonName": "ec2ImageDetails" + } + }, + "RecoveryPointDetails": { + "target": "com.amazonaws.guardduty#RecoveryPointDetails", + "traits": { + "smithy.api#documentation": "Contains details about the backup recovery point that was scanned.
", + "smithy.api#jsonName": "recoveryPointDetails" + } + }, + "BedrockGuardrailDetails": { + "target": "com.amazonaws.guardduty#BedrockGuardrailDetails", + "traits": { + "smithy.api#documentation": "Contains information about the Bedrock guardrail that was involved in a finding.
", + "smithy.api#jsonName": "bedrockGuardrailDetails" + } + }, + "ModelDetails": { + "target": "com.amazonaws.guardduty#ModelDetails", + "traits": { + "smithy.api#documentation": "Contains information about the AI models involved in a finding.
", + "smithy.api#jsonName": "modelDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon Web Services resource associated with the activity that prompted GuardDuty to generate a finding.
" + } + }, + "com.amazonaws.guardduty#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[A-Za-z-]+:[A-Za-z0-9]+:[A-Za-z0-9-]+:\\d+:(([A-Za-z0-9-]+)[:\\/])?[A-Za-z0-9:-]*$" + } + }, + "com.amazonaws.guardduty#ResourceData": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.guardduty#S3Bucket", + "traits": { + "smithy.api#documentation": "Contains information about the Amazon S3 bucket.
", + "smithy.api#jsonName": "s3Bucket" + } + }, + "Ec2Instance": { + "target": "com.amazonaws.guardduty#Ec2Instance", + "traits": { + "smithy.api#documentation": "Contains information about the Amazon EC2 instance.
", + "smithy.api#jsonName": "ec2Instance" + } + }, + "AccessKey": { + "target": "com.amazonaws.guardduty#AccessKey", + "traits": { + "smithy.api#documentation": "Contains information about the IAM access key details of a user that involved in the GuardDuty finding.
", + "smithy.api#jsonName": "accessKey" + } + }, + "Ec2NetworkInterface": { + "target": "com.amazonaws.guardduty#Ec2NetworkInterface", + "traits": { + "smithy.api#documentation": "Contains information about the elastic network interface of the Amazon EC2 instance.
", + "smithy.api#jsonName": "ec2NetworkInterface" + } + }, + "S3Object": { + "target": "com.amazonaws.guardduty#S3Object", + "traits": { + "smithy.api#documentation": "Contains information about the Amazon S3 object.
", + "smithy.api#jsonName": "s3Object" + } + }, + "EksCluster": { + "target": "com.amazonaws.guardduty#EksCluster", + "traits": { + "smithy.api#documentation": "Contains detailed information about the Amazon EKS cluster associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "eksCluster" + } + }, + "KubernetesWorkload": { + "target": "com.amazonaws.guardduty#KubernetesWorkload", + "traits": { + "smithy.api#documentation": "Contains detailed information about the Kubernetes workload associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "kubernetesWorkload" + } + }, + "Container": { + "target": "com.amazonaws.guardduty#ContainerFindingResource", + "traits": { + "smithy.api#documentation": "Contains detailed information about the container associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "container" + } + }, + "EcsCluster": { + "target": "com.amazonaws.guardduty#EcsCluster", + "traits": { + "smithy.api#documentation": "Contains detailed information about the Amazon ECS cluster associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "ecsCluster" + } + }, + "EcsTask": { + "target": "com.amazonaws.guardduty#EcsTask", + "traits": { + "smithy.api#documentation": "Contains detailed information about the Amazon ECS task associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "ecsTask" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.guardduty#IamInstanceProfileV2", + "traits": { + "smithy.api#documentation": "Contains detailed information about the IAM instance profile associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "iamInstanceProfile" + } + }, + "AutoscalingAutoScalingGroup": { + "target": "com.amazonaws.guardduty#AutoscalingAutoScalingGroup", + "traits": { + "smithy.api#documentation": "Contains detailed information about the Auto Scaling Group associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "autoscalingAutoScalingGroup" + } + }, + "Ec2LaunchTemplate": { + "target": "com.amazonaws.guardduty#Ec2LaunchTemplate", + "traits": { + "smithy.api#documentation": "Contains detailed information about the EC2 launch template associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "ec2LaunchTemplate" + } + }, + "Ec2Vpc": { + "target": "com.amazonaws.guardduty#Ec2Vpc", + "traits": { + "smithy.api#documentation": "Contains detailed information about the EC2 VPC associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "ec2Vpc" + } + }, + "Ec2Image": { + "target": "com.amazonaws.guardduty#Ec2Image", + "traits": { + "smithy.api#documentation": "Contains detailed information about the EC2 Image associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "ec2Image" + } + }, + "CloudformationStack": { + "target": "com.amazonaws.guardduty#CloudformationStack", + "traits": { + "smithy.api#documentation": "Contains detailed information about the CloudFormation stack associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "cloudformationStack" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon Web Services resource that is associated with the activity that prompted GuardDuty to generate a finding.
" + } + }, + "com.amazonaws.guardduty#ResourceDetails": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.guardduty#InstanceArn", + "traits": { + "smithy.api#documentation": "Instance ARN that was scanned in the scan entry.
", + "smithy.api#jsonName": "instanceArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the resources that were scanned in the scan entry.
" + } + }, + "com.amazonaws.guardduty#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error type.
", + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "The requested resource can't be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.guardduty#ResourceStatistics": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account.
", + "smithy.api#jsonName": "accountId" + } + }, + "LastGeneratedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the statistics for this resource was last generated.
", + "smithy.api#jsonName": "lastGeneratedAt" + } + }, + "ResourceId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "ID associated with each resource. The following list provides the mapping of the resource type and resource ID.
Mapping of resource and resource ID
AccessKey - resource.accessKeyDetails.accessKeyId
Container - resource.containerDetails.id
ECSCluster - resource.ecsClusterDetails.name
EKSCluster - resource.eksClusterDetails.name
Instance - resource.instanceDetails.instanceId
KubernetesCluster - resource.kubernetesDetails.kubernetesWorkloadDetails.name
Lambda - resource.lambdaDetails.functionName
RDSDBInstance - resource.rdsDbInstanceDetails.dbInstanceIdentifier
S3Bucket - resource.s3BucketDetails.name
S3Object - resource.s3BucketDetails.name
The type of resource.
", + "smithy.api#jsonName": "resourceType" + } + }, + "TotalFindings": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The total number of findings associated with this resource.
", + "smithy.api#jsonName": "totalFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about each resource type associated with the groupedByResource statistics.
The unique identifier of the resource.
", + "smithy.api#jsonName": "uid", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the resource.
", + "smithy.api#jsonName": "name" + } + }, + "AccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID to which the resource belongs.
", + "smithy.api#jsonName": "accountId" + } + }, + "ResourceType": { + "target": "com.amazonaws.guardduty#FindingResourceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of the Amazon Web Services resource.
", + "smithy.api#jsonName": "resourceType", + "smithy.api#required": {} + } + }, + "Region": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region where the resource belongs.
", + "smithy.api#jsonName": "region" + } + }, + "Service": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service of the resource.
", + "smithy.api#jsonName": "service" + } + }, + "CloudPartition": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The cloud partition within the Amazon Web Services Region to which the resource belongs.
", + "smithy.api#jsonName": "cloudPartition" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "Contains information about the tags associated with the resource.
", + "smithy.api#jsonName": "tags" + } + }, + "Data": { + "target": "com.amazonaws.guardduty#ResourceData", + "traits": { + "smithy.api#documentation": "Contains information about the Amazon Web Services resource associated with the activity that prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "data" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon Web Services resource that is associated with the GuardDuty finding.
" + } + }, + "com.amazonaws.guardduty#Resources": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ResourceV2" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, + "com.amazonaws.guardduty#RiskDetails": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.guardduty#RiskLevel": { + "type": "enum", + "members": { + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Info" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Low" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Medium" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "High" + } + }, + "CRITICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Critical" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#RuntimeContext": { + "type": "structure", + "members": { + "ModifyingProcess": { + "target": "com.amazonaws.guardduty#ProcessDetails", + "traits": { + "smithy.api#documentation": "Information about the process that modified the current process. This is available for multiple finding types.
", + "smithy.api#jsonName": "modifyingProcess" + } + }, + "ModifiedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the process modified the current process. The timestamp is in UTC date string format.
", + "smithy.api#jsonName": "modifiedAt" + } + }, + "ScriptPath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path to the script that was executed.
", + "smithy.api#jsonName": "scriptPath" + } + }, + "LibraryPath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path to the new library that was loaded.
", + "smithy.api#jsonName": "libraryPath" + } + }, + "LdPreloadValue": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The value of the LD_PRELOAD environment variable.
", + "smithy.api#jsonName": "ldPreloadValue" + } + }, + "SocketPath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path to the docket socket that was accessed.
", + "smithy.api#jsonName": "socketPath" + } + }, + "RuncBinaryPath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path to the leveraged runc implementation.
The path in the container that modified the release agent file.
", + "smithy.api#jsonName": "releaseAgentPath" + } + }, + "MountSource": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path on the host that is mounted by the container.
", + "smithy.api#jsonName": "mountSource" + } + }, + "MountTarget": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path in the container that is mapped to the host directory.
", + "smithy.api#jsonName": "mountTarget" + } + }, + "FileSystemType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Represents the type of mounted fileSystem.
", + "smithy.api#jsonName": "fileSystemType" + } + }, + "Flags": { + "target": "com.amazonaws.guardduty#FlagsList", + "traits": { + "smithy.api#documentation": "Represents options that control the behavior of a runtime operation or action. For example, a filesystem mount operation may contain a read-only flag.
", + "smithy.api#jsonName": "flags" + } + }, + "ModuleName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the module loaded into the kernel.
", + "smithy.api#jsonName": "moduleName" + } + }, + "ModuleFilePath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path to the module loaded into the kernel.
", + "smithy.api#jsonName": "moduleFilePath" + } + }, + "ModuleSha256": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The SHA256 hash of the module.
The path to the modified shell history file.
", + "smithy.api#jsonName": "shellHistoryFilePath" + } + }, + "TargetProcess": { + "target": "com.amazonaws.guardduty#ProcessDetails", + "traits": { + "smithy.api#documentation": "Information about the process that had its memory overwritten by the current process.
", + "smithy.api#jsonName": "targetProcess" + } + }, + "AddressFamily": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Represents the communication protocol associated with the address. For example, the address family AF_INET is used for IP version of 4 protocol.
Specifies a particular protocol within the address family. Usually there is a single protocol in address families. For example, the address family AF_INET only has the IP protocol.
Specifies the Region of a process's address space such as stack and heap.
", + "smithy.api#jsonName": "memoryRegions" + } + }, + "ToolName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Name of the potentially suspicious tool.
", + "smithy.api#jsonName": "toolName" + } + }, + "ToolCategory": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Category that the tool belongs to. Some of the examples are Backdoor Tool, Pentest Tool, Network Scanner, and Network Sniffer.
", + "smithy.api#jsonName": "toolCategory" + } + }, + "ServiceName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Name of the security service that has been potentially disabled.
", + "smithy.api#jsonName": "serviceName" + } + }, + "CommandLineExample": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Example of the command line involved in the suspicious activity.
", + "smithy.api#jsonName": "commandLineExample" + } + }, + "ThreatFilePath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The suspicious file path for which the threat intelligence details were found.
", + "smithy.api#jsonName": "threatFilePath" + } + }, + "FileOperation": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Represents the type of file operation that triggered the finding, such as Write, Delete, Rename, Link, or Symlink.
", + "smithy.api#jsonName": "fileOperation" + } + }, + "FilePath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path of the sensitive file that was modified. Modification includes write, delete, rename, link, or symlink operations. This field is indexed for filtering.
", + "smithy.api#jsonName": "filePath" + } + }, + "RelatedFilePaths": { + "target": "com.amazonaws.guardduty#RelatedFilePathsList", + "traits": { + "smithy.api#documentation": "All file paths modified by the same process that triggered the finding, up to a maximum of 25 paths.
", + "smithy.api#jsonName": "relatedFilePaths" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional information about the suspicious activity.
" + } + }, + "com.amazonaws.guardduty#RuntimeDetails": { + "type": "structure", + "members": { + "Process": { + "target": "com.amazonaws.guardduty#ProcessDetails", + "traits": { + "smithy.api#documentation": "Information about the observed process.
", + "smithy.api#jsonName": "process" + } + }, + "Context": { + "target": "com.amazonaws.guardduty#RuntimeContext", + "traits": { + "smithy.api#documentation": "Additional information about the suspicious activity.
", + "smithy.api#jsonName": "context" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the process and any required context values for a specific finding.
" + } + }, + "com.amazonaws.guardduty#S3Bucket": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The owner ID of the associated S3Amazon S3bucket.
", + "smithy.api#jsonName": "ownerId" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the Amazon S3 bucket was created.
", + "smithy.api#jsonName": "createdAt" + } + }, + "EncryptionType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The type of encryption used for the Amazon S3 buckets and its objects. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
", + "smithy.api#jsonName": "encryptionType" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the encryption key that is used to encrypt the Amazon S3 bucket and its objects.
", + "smithy.api#jsonName": "encryptionKeyArn" + } + }, + "EffectivePermission": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Describes the effective permissions on this S3 bucket, after factoring all the attached policies.
", + "smithy.api#jsonName": "effectivePermission" + } + }, + "PublicReadAccess": { + "target": "com.amazonaws.guardduty#PublicAccessStatus", + "traits": { + "smithy.api#documentation": "Indicates whether or not the public read access is allowed for an Amazon S3 bucket.
", + "smithy.api#jsonName": "publicReadAccess" + } + }, + "PublicWriteAccess": { + "target": "com.amazonaws.guardduty#PublicAccessStatus", + "traits": { + "smithy.api#documentation": "Indicates whether or not the public write access is allowed for an Amazon S3 bucket.
", + "smithy.api#jsonName": "publicWriteAccess" + } + }, + "AccountPublicAccess": { + "target": "com.amazonaws.guardduty#PublicAccessConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the public access policies that apply to the Amazon S3 bucket at the account level.
", + "smithy.api#jsonName": "accountPublicAccess" + } + }, + "BucketPublicAccess": { + "target": "com.amazonaws.guardduty#PublicAccessConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about public access policies that apply to the Amazon S3 bucket.
", + "smithy.api#jsonName": "bucketPublicAccess" + } + }, + "S3ObjectUids": { + "target": "com.amazonaws.guardduty#S3ObjectUids", + "traits": { + "smithy.api#documentation": "Represents a list of Amazon S3 object identifiers.
", + "smithy.api#jsonName": "s3ObjectUids" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon S3 bucket policies and encryption.
" + } + }, + "com.amazonaws.guardduty#S3BucketDetail": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 bucket.
", + "smithy.api#jsonName": "arn" + } + }, + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket.
", + "smithy.api#jsonName": "name" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Describes whether the bucket is a source or destination bucket.
", + "smithy.api#jsonName": "type" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the bucket was created at.
", + "smithy.api#jsonName": "createdAt" + } + }, + "Owner": { + "target": "com.amazonaws.guardduty#Owner", + "traits": { + "smithy.api#documentation": "The owner of the S3 bucket.
", + "smithy.api#jsonName": "owner" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "All tags attached to the S3 bucket
", + "smithy.api#jsonName": "tags" + } + }, + "DefaultServerSideEncryption": { + "target": "com.amazonaws.guardduty#DefaultServerSideEncryption", + "traits": { + "smithy.api#documentation": "Describes the server side encryption method used in the S3 bucket.
", + "smithy.api#jsonName": "defaultServerSideEncryption" + } + }, + "PublicAccess": { + "target": "com.amazonaws.guardduty#PublicAccess", + "traits": { + "smithy.api#documentation": "Describes the public access policies that apply to the S3 bucket.
", + "smithy.api#jsonName": "publicAccess" + } + }, + "S3ObjectDetails": { + "target": "com.amazonaws.guardduty#S3ObjectDetails", + "traits": { + "smithy.api#documentation": "Information about the S3 object that was scanned.
", + "smithy.api#jsonName": "s3ObjectDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the S3 bucket.
" + } + }, + "com.amazonaws.guardduty#S3BucketDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#S3BucketDetail" + } + }, + "com.amazonaws.guardduty#S3LogsConfiguration": { + "type": "structure", + "members": { + "Enable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of S3 data event logs as a data source.
", + "smithy.api#jsonName": "enable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether S3 data event logs will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#S3LogsConfigurationResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A value that describes whether S3 data event logs are automatically enabled for new members of the organization.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether S3 data event logs will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#S3Object": { + "type": "structure", + "members": { + "ETag": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The entity tag is a hash of the Amazon S3 object. The ETag reflects changes only to the contents of an object, and not its metadata.
", + "smithy.api#jsonName": "eTag" + } + }, + "Key": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The key of the Amazon S3 object.
", + "smithy.api#jsonName": "key" + } + }, + "VersionId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version Id of the Amazon S3 object.
", + "smithy.api#jsonName": "versionId" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon S3 object.
" + } + }, + "com.amazonaws.guardduty#S3ObjectDetail": { + "type": "structure", + "members": { + "ObjectArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the S3 object.
", + "smithy.api#jsonName": "objectArn" + } + }, + "Key": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Key of the S3 object.
", + "smithy.api#jsonName": "key" + } + }, + "ETag": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The entity tag is a hash of the S3 object. The ETag reflects changes only to the contents of an object, and not its metadata.
", + "smithy.api#jsonName": "eTag" + } + }, + "Hash": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Hash of the threat detected in this finding.
", + "smithy.api#jsonName": "hash" + } + }, + "VersionId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Version ID of the object.
", + "smithy.api#jsonName": "versionId" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the S3 object that was scanned
" + } + }, + "com.amazonaws.guardduty#S3ObjectDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#S3ObjectDetail" + } + }, + "com.amazonaws.guardduty#S3ObjectForSendObjectMalwareScan": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket containing the object to scan. The bucket must have GuardDuty Malware Protection enabled.
", + "smithy.api#jsonName": "bucket" + } + }, + "Key": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The key (name) of the S3 object to scan for malware. This must be the full key path of the object within the bucket.
", + "smithy.api#jsonName": "key" + } + }, + "VersionId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version ID of the S3 object to scan. If not specified, the latest version of the object is scanned.
", + "smithy.api#jsonName": "versionId" + } + } + }, + "traits": { + "smithy.api#documentation": "The S3 object path to initiate a scan, including bucket name, object key, and optional version ID.
" + } + }, + "com.amazonaws.guardduty#S3ObjectUids": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Scan": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that is associated with the request.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the AdminDetectorId will be the same as the one used for DetectorId.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique scan ID associated with a scan entry.
", + "smithy.api#jsonName": "scanId" + } + }, + "ScanStatus": { + "target": "com.amazonaws.guardduty#ScanStatus", + "traits": { + "smithy.api#documentation": "An enum value representing possible scan statuses.
", + "smithy.api#jsonName": "scanStatus" + } + }, + "FailureReason": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "Represents the reason for FAILED scan status.
The timestamp of when the scan was triggered.
", + "smithy.api#jsonName": "scanStartTime" + } + }, + "ScanEndTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the scan was finished.
", + "smithy.api#jsonName": "scanEndTime" + } + }, + "TriggerDetails": { + "target": "com.amazonaws.guardduty#TriggerDetails", + "traits": { + "smithy.api#documentation": "Specifies the reason why the scan was initiated.
", + "smithy.api#jsonName": "triggerDetails" + } + }, + "ResourceDetails": { + "target": "com.amazonaws.guardduty#ResourceDetails", + "traits": { + "smithy.api#documentation": "Represents the resources that were scanned in the scan entry.
", + "smithy.api#jsonName": "resourceDetails" + } + }, + "ScanResultDetails": { + "target": "com.amazonaws.guardduty#ScanResultDetails", + "traits": { + "smithy.api#documentation": "Represents the result of the scan.
", + "smithy.api#jsonName": "scanResultDetails" + } + }, + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The ID for the account that belongs to the scan.
", + "smithy.api#jsonName": "accountId" + } + }, + "TotalBytes": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "Represents total bytes that were scanned.
", + "smithy.api#jsonName": "totalBytes" + } + }, + "FileCount": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "Represents the number of files that were scanned.
", + "smithy.api#jsonName": "fileCount" + } + }, + "AttachedVolumes": { + "target": "com.amazonaws.guardduty#VolumeDetails", + "traits": { + "smithy.api#documentation": "List of volumes that were attached to the original instance to be scanned.
", + "smithy.api#jsonName": "attachedVolumes" + } + }, + "ScanType": { + "target": "com.amazonaws.guardduty#ScanType", + "traits": { + "smithy.api#documentation": "Specifies the scan type that invoked the malware scan.
", + "smithy.api#jsonName": "scanType" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about malware scans associated with GuardDuty Malware Protection for EC2.
" + } + }, + "com.amazonaws.guardduty#ScanCategory": { + "type": "enum", + "members": { + "FULL_SCAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_SCAN" + } + }, + "INCREMENTAL_SCAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL_SCAN" + } + } + } + }, + "com.amazonaws.guardduty#ScanCondition": { + "type": "structure", + "members": { + "MapEquals": { + "target": "com.amazonaws.guardduty#MapEquals", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Represents an mapEqual condition to be applied to a single field when triggering for malware scan.
", + "smithy.api#jsonName": "mapEquals", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the condition.
" + } + }, + "com.amazonaws.guardduty#ScanConditionPair": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.guardduty#TagKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Represents the key in the map condition.
", + "smithy.api#jsonName": "key", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.guardduty#TagValue", + "traits": { + "smithy.api#documentation": "Represents optional value in the map condition. If not specified, only the key will be matched.
", + "smithy.api#jsonName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the key:value pair to be matched against given resource property.
Amazon Resource Name (ARN) of the IAM role that should contain the required permissions for the scan.
", + "smithy.api#jsonName": "role" + } + }, + "TriggerDetails": { + "target": "com.amazonaws.guardduty#TriggerDetails", + "traits": { + "smithy.api#documentation": "Information about the entity that triggered the malware scan.
", + "smithy.api#jsonName": "triggerDetails" + } + }, + "IncrementalScanDetails": { + "target": "com.amazonaws.guardduty#IncrementalScanDetails", + "traits": { + "smithy.api#documentation": "Information about the incremental scan configuration, if applicable.
", + "smithy.api#jsonName": "incrementalScanDetails" + } + }, + "RecoveryPoint": { + "target": "com.amazonaws.guardduty#ScanConfigurationRecoveryPoint", + "traits": { + "smithy.api#documentation": "Information about the recovery point configuration used for the scan, if applicable.
", + "smithy.api#jsonName": "recoveryPoint" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the configuration used for the malware scan.
" + } + }, + "com.amazonaws.guardduty#ScanConfigurationContinuousScanDetails": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp representing the start of the time range that was scanned.
", + "smithy.api#jsonName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp representing the end of the time range that was scanned.
", + "smithy.api#jsonName": "endTime", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the time range within the continuous backup in Amazon Web Services Backup that was scanned for a point-in-time recovery resource.
" + } + }, + "com.amazonaws.guardduty#ScanConfigurationRecoveryPoint": { + "type": "structure", + "members": { + "BackupVaultName": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the Amazon Web Services Backup vault that contains the recovery point for the scanned.
", + "smithy.api#jsonName": "backupVaultName" + } + }, + "ContinuousScanDetails": { + "target": "com.amazonaws.guardduty#ScanConfigurationContinuousScanDetails", + "traits": { + "smithy.api#documentation": "The time range within the continuous backup in Amazon Web Services Backup that was scanned for a point-in-time recovery resource.
", + "smithy.api#jsonName": "continuousScanDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the recovery point configuration used in the scan.
" + } + }, + "com.amazonaws.guardduty#ScanCriterion": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#ScanCriterionKey" + }, + "value": { + "target": "com.amazonaws.guardduty#ScanCondition" + }, + "traits": { + "smithy.api#documentation": "Represents a map of resource properties that match specified conditions and values when triggering malware scans.
" + } + }, + "com.amazonaws.guardduty#ScanCriterionKey": { + "type": "enum", + "members": { + "EC2_INSTANCE_TAG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_INSTANCE_TAG" + } + } + }, + "traits": { + "smithy.api#documentation": "An enum value representing possible resource properties to match with given scan condition.
" + } + }, + "com.amazonaws.guardduty#ScanDetections": { + "type": "structure", + "members": { + "ScannedItemCount": { + "target": "com.amazonaws.guardduty#ScannedItemCount", + "traits": { + "smithy.api#documentation": "Total number of scanned files.
", + "smithy.api#jsonName": "scannedItemCount" + } + }, + "ThreatsDetectedItemCount": { + "target": "com.amazonaws.guardduty#ThreatsDetectedItemCount", + "traits": { + "smithy.api#documentation": "Total number of infected files.
", + "smithy.api#jsonName": "threatsDetectedItemCount" + } + }, + "HighestSeverityThreatDetails": { + "target": "com.amazonaws.guardduty#HighestSeverityThreatDetails", + "traits": { + "smithy.api#documentation": "Details of the highest severity threat detected during malware scan and number of infected files.
", + "smithy.api#jsonName": "highestSeverityThreatDetails" + } + }, + "ThreatDetectedByName": { + "target": "com.amazonaws.guardduty#ThreatDetectedByName", + "traits": { + "smithy.api#documentation": "Contains details about identified threats organized by threat name.
", + "smithy.api#jsonName": "threatDetectedByName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a complete view providing malware scan result details.
" + } + }, + "com.amazonaws.guardduty#ScanEc2InstanceWithFindings": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Describes the configuration for scanning EBS volumes as data source.
", + "smithy.api#jsonName": "ebsVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection for EC2 instances with findings will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#ScanEc2InstanceWithFindingsResult": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.guardduty#EbsVolumesResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of scanning EBS volumes as a data source.
", + "smithy.api#jsonName": "ebsVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of whether Malware Protection for EC2 instances with findings will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#ScanFilePath": { + "type": "structure", + "members": { + "FilePath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The file path of the infected file.
", + "smithy.api#jsonName": "filePath" + } + }, + "VolumeArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EBS volume ARN details of the infected file.
", + "smithy.api#jsonName": "volumeArn" + } + }, + "Hash": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The hash value of the infected file.
", + "smithy.api#jsonName": "hash" + } + }, + "FileName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "File name of the infected file.
", + "smithy.api#jsonName": "fileName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of infected file including name, file path and hash.
" + } + }, + "com.amazonaws.guardduty#ScanResourceCriteria": { + "type": "structure", + "members": { + "Include": { + "target": "com.amazonaws.guardduty#ScanCriterion", + "traits": { + "smithy.api#documentation": "Represents condition that when matched will allow a malware scan for a certain resource.
", + "smithy.api#jsonName": "include" + } + }, + "Exclude": { + "target": "com.amazonaws.guardduty#ScanCriterion", + "traits": { + "smithy.api#documentation": "Represents condition that when matched will prevent a malware scan for a certain resource.
", + "smithy.api#jsonName": "exclude" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about criteria used to filter resources before triggering malware scan.
" + } + }, + "com.amazonaws.guardduty#ScanResult": { + "type": "enum", + "members": { + "CLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLEAN" + } + }, + "INFECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFECTED" + } + } + } + }, + "com.amazonaws.guardduty#ScanResultDetails": { + "type": "structure", + "members": { + "ScanResult": { + "target": "com.amazonaws.guardduty#ScanResult", + "traits": { + "smithy.api#documentation": "An enum value representing possible scan results.
", + "smithy.api#jsonName": "scanResult" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the result of the scan.
" + } + }, + "com.amazonaws.guardduty#ScanResultStatus": { + "type": "enum", + "members": { + "NO_THREATS_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_THREATS_FOUND" + } + }, + "THREATS_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREATS_FOUND" + } + } + } + }, + "com.amazonaws.guardduty#ScanResultThreat": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the detected threat.
", + "smithy.api#jsonName": "name" + } + }, + "Source": { + "target": "com.amazonaws.guardduty#DetectionSource", + "traits": { + "smithy.api#documentation": "The source that detected this threat.
", + "smithy.api#jsonName": "source" + } + }, + "Count": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "The number of instances of this threat that were detected.
", + "smithy.api#jsonName": "count" + } + }, + "Hash": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The hash value associated with the detected threat.
", + "smithy.api#jsonName": "hash" + } + }, + "ItemDetails": { + "target": "com.amazonaws.guardduty#ItemDetailsList", + "traits": { + "smithy.api#documentation": "Additional information about where this threat was detected.
", + "smithy.api#jsonName": "itemDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a specific threat that was detected during the malware scan.
" + } + }, + "com.amazonaws.guardduty#ScanResultThreats": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ScanResultThreat" + } + }, + "com.amazonaws.guardduty#ScanStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + } + } + }, + "com.amazonaws.guardduty#ScanStatusReason": { + "type": "enum", + "members": { + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_NOT_FOUND" + } + }, + "SNAPSHOT_SIZE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPSHOT_SIZE_LIMIT_EXCEEDED" + } + }, + "RESOURCE_UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_UNAVAILABLE" + } + }, + "INCONSISTENT_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCONSISTENT_SOURCE" + } + }, + "INCREMENTAL_NO_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL_NO_DIFFERENCE" + } + }, + "NO_EBS_VOLUMES_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_EBS_VOLUMES_FOUND" + } + }, + "UNSUPPORTED_PRODUCT_CODE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_PRODUCT_CODE_TYPE" + } + }, + "AMI_SNAPSHOT_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMI_SNAPSHOT_LIMIT_EXCEEDED" + } + }, + "UNRELATED_RESOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNRELATED_RESOURCES" + } + }, + "BASE_RESOURCE_NOT_SCANNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASE_RESOURCE_NOT_SCANNED" + } + }, + "BASE_CREATED_AFTER_TARGET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASE_CREATED_AFTER_TARGET" + } + }, + "UNSUPPORTED_FOR_INCREMENTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_FOR_INCREMENTAL" + } + }, + "UNSUPPORTED_AMI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_AMI" + } + }, + "UNSUPPORTED_SNAPSHOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_SNAPSHOT" + } + }, + "UNSUPPORTED_COMPOSITE_RECOVERY_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_COMPOSITE_RECOVERY_POINT" + } + }, + "ALL_FILES_SKIPPED_OR_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_FILES_SKIPPED_OR_FAILED" + } + } + } + }, + "com.amazonaws.guardduty#ScanThreatName": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the identified threat.
", + "smithy.api#jsonName": "name" + } + }, + "Severity": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Severity of threat identified as part of the malware scan.
", + "smithy.api#jsonName": "severity" + } + }, + "ItemCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of files infected with given threat.
", + "smithy.api#jsonName": "itemCount" + } + }, + "FilePaths": { + "target": "com.amazonaws.guardduty#FilePaths", + "traits": { + "smithy.api#documentation": "List of infected files in EBS volume with details.
", + "smithy.api#jsonName": "filePaths" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains files infected with the given threat providing details of malware name and severity.
" + } + }, + "com.amazonaws.guardduty#ScanThreatNames": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ScanThreatName" + } + }, + "com.amazonaws.guardduty#ScanType": { + "type": "enum", + "members": { + "GUARDDUTY_INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GUARDDUTY_INITIATED" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + } + } + }, + "com.amazonaws.guardduty#ScannedItemCount": { + "type": "structure", + "members": { + "TotalGb": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total GB of files scanned for malware.
", + "smithy.api#jsonName": "totalGb" + } + }, + "Files": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Number of files scanned.
", + "smithy.api#jsonName": "files" + } + }, + "Volumes": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of scanned volumes.
", + "smithy.api#jsonName": "volumes" + } + } + }, + "traits": { + "smithy.api#documentation": "Total number of scanned files.
" + } + }, + "com.amazonaws.guardduty#ScannedResource": { + "type": "structure", + "members": { + "ScannedResourceArn": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the scanned resource.
", + "smithy.api#jsonName": "scannedResourceArn" + } + }, + "ScannedResourceType": { + "target": "com.amazonaws.guardduty#MalwareProtectionResourceType", + "traits": { + "smithy.api#documentation": "The resource type of the scanned resource.
", + "smithy.api#jsonName": "scannedResourceType" + } + }, + "ScannedResourceStatus": { + "target": "com.amazonaws.guardduty#MalwareProtectionScanStatus", + "traits": { + "smithy.api#documentation": "The status of the scanned resource.
", + "smithy.api#jsonName": "scannedResourceStatus" + } + }, + "ScanStatusReason": { + "target": "com.amazonaws.guardduty#ScanStatusReason", + "traits": { + "smithy.api#documentation": "The reason for the scan status of this particular resource, if applicable.
", + "smithy.api#jsonName": "scanStatusReason" + } + }, + "ResourceDetails": { + "target": "com.amazonaws.guardduty#ScannedResourceDetails", + "traits": { + "smithy.api#documentation": "Information about the scanned resource.
", + "smithy.api#jsonName": "resourceDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a resource that was scanned as part of the malware scan operation.
" + } + }, + "com.amazonaws.guardduty#ScannedResourceDetails": { + "type": "structure", + "members": { + "EbsVolume": { + "target": "com.amazonaws.guardduty#VolumeDetail", + "traits": { + "smithy.api#documentation": "Contains information about the EBS volume that was scanned.
", + "smithy.api#jsonName": "ebsVolume" + } + }, + "EbsSnapshot": { + "target": "com.amazonaws.guardduty#EbsSnapshot", + "traits": { + "smithy.api#documentation": "Contains information about the EBS snapshot that was scanned.
", + "smithy.api#jsonName": "ebsSnapshot" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains additional information about a resource that was scanned.
" + } + }, + "com.amazonaws.guardduty#ScannedResources": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ScannedResource" + } + }, + "com.amazonaws.guardduty#Scans": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Scan" + } + }, + "com.amazonaws.guardduty#SecurityContext": { + "type": "structure", + "members": { + "Privileged": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether the container is privileged.
", + "smithy.api#jsonName": "privileged" + } + }, + "AllowPrivilegeEscalation": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent process.
", + "smithy.api#jsonName": "allowPrivilegeEscalation" + } + } + }, + "traits": { + "smithy.api#documentation": "Container security context.
" + } + }, + "com.amazonaws.guardduty#SecurityGroup": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The security group ID of the EC2 instance.
", + "smithy.api#jsonName": "groupId" + } + }, + "GroupName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The security group name of the EC2 instance.
", + "smithy.api#jsonName": "groupName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the security groups associated with the EC2 instance.
" + } + }, + "com.amazonaws.guardduty#SecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#SecurityGroup" + } + }, + "com.amazonaws.guardduty#SendObjectMalwareScan": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#SendObjectMalwareScanRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#SendObjectMalwareScanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Initiates a malware scan for a specific S3 object. This API allows you to perform on-demand malware scanning of individual objects in S3 buckets that have Malware Protection for S3 enabled.
When you use this API, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuardDuty Malware Protection.
", + "smithy.api#http": { + "method": "POST", + "uri": "/object-malware-scan/send", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#SendObjectMalwareScanRequest": { + "type": "structure", + "members": { + "S3Object": { + "target": "com.amazonaws.guardduty#S3ObjectForSendObjectMalwareScan", + "traits": { + "smithy.api#documentation": "The S3 object information for the object you want to scan. The bucket must have a Malware Protection plan configured to use this API.
", + "smithy.api#jsonName": "s3Object" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#SendObjectMalwareScanResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.guardduty#Sequence": { + "type": "structure", + "members": { + "Uid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Unique identifier of the attack sequence.
", + "smithy.api#jsonName": "uid", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.guardduty#SequenceDescription", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Description of the attack sequence.
", + "smithy.api#jsonName": "description", + "smithy.api#required": {} + } + }, + "Actors": { + "target": "com.amazonaws.guardduty#Actors", + "traits": { + "smithy.api#documentation": "Contains information about the actors involved in the attack sequence.
", + "smithy.api#jsonName": "actors" + } + }, + "Resources": { + "target": "com.amazonaws.guardduty#Resources", + "traits": { + "smithy.api#documentation": "Contains information about the resources involved in the attack sequence.
", + "smithy.api#jsonName": "resources" + } + }, + "Endpoints": { + "target": "com.amazonaws.guardduty#NetworkEndpoints", + "traits": { + "smithy.api#documentation": "Contains information about the network endpoints that were used in the attack sequence.
", + "smithy.api#jsonName": "endpoints" + } + }, + "Signals": { + "target": "com.amazonaws.guardduty#Signals", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Contains information about the signals involved in the attack sequence.
", + "smithy.api#jsonName": "signals", + "smithy.api#required": {} + } + }, + "SequenceIndicators": { + "target": "com.amazonaws.guardduty#Indicators", + "traits": { + "smithy.api#documentation": "Contains information about the indicators observed in the attack sequence.
", + "smithy.api#jsonName": "sequenceIndicators" + } + }, + "AdditionalSequenceTypes": { + "target": "com.amazonaws.guardduty#AdditionalSequenceTypes", + "traits": { + "smithy.api#documentation": "Additional types of sequences that may be associated with the attack sequence finding, providing further context about the nature of the detected threat.
", + "smithy.api#jsonName": "additionalSequenceTypes" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the GuardDuty attack sequence finding.
" + } + }, + "com.amazonaws.guardduty#SequenceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.guardduty#Service": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.guardduty#Action", + "traits": { + "smithy.api#documentation": "Information about the activity that is described in a finding.
", + "smithy.api#jsonName": "action" + } + }, + "Evidence": { + "target": "com.amazonaws.guardduty#Evidence", + "traits": { + "smithy.api#documentation": "An evidence object associated with the service.
", + "smithy.api#jsonName": "evidence" + } + }, + "Archived": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether this finding is archived.
", + "smithy.api#jsonName": "archived" + } + }, + "Count": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The total count of the occurrences of this finding type.
", + "smithy.api#jsonName": "count" + } + }, + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detector ID for the GuardDuty service.
", + "smithy.api#jsonName": "detectorId" + } + }, + "EventFirstSeen": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The first-seen timestamp of the activity that prompted GuardDuty to generate this finding.
", + "smithy.api#jsonName": "eventFirstSeen" + } + }, + "EventLastSeen": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The last-seen timestamp of the activity that prompted GuardDuty to generate this finding.
", + "smithy.api#jsonName": "eventLastSeen" + } + }, + "ResourceRole": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The resource role information for this finding.
", + "smithy.api#jsonName": "resourceRole" + } + }, + "ServiceName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon Web Services service (GuardDuty) that generated a finding.
", + "smithy.api#jsonName": "serviceName" + } + }, + "UserFeedback": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Feedback that was submitted about the finding.
", + "smithy.api#jsonName": "userFeedback" + } + }, + "AdditionalInfo": { + "target": "com.amazonaws.guardduty#ServiceAdditionalInfo", + "traits": { + "smithy.api#documentation": "Contains additional information about the generated finding.
", + "smithy.api#jsonName": "additionalInfo" + } + }, + "FeatureName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the feature that generated a finding.
", + "smithy.api#jsonName": "featureName" + } + }, + "EbsVolumeScanDetails": { + "target": "com.amazonaws.guardduty#EbsVolumeScanDetails", + "traits": { + "smithy.api#documentation": "Returns details from the malware scan that created a finding.
", + "smithy.api#jsonName": "ebsVolumeScanDetails" + } + }, + "RuntimeDetails": { + "target": "com.amazonaws.guardduty#RuntimeDetails", + "traits": { + "smithy.api#documentation": "Information about the process and any required context values for a specific finding
", + "smithy.api#jsonName": "runtimeDetails" + } + }, + "Detection": { + "target": "com.amazonaws.guardduty#Detection", + "traits": { + "smithy.api#documentation": "Contains information about the detected unusual behavior.
", + "smithy.api#jsonName": "detection" + } + }, + "MalwareScanDetails": { + "target": "com.amazonaws.guardduty#MalwareScanDetails", + "traits": { + "smithy.api#documentation": "Returns details from the malware scan that generated a GuardDuty finding.
", + "smithy.api#jsonName": "malwareScanDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains additional information about the generated finding.
" + } + }, + "com.amazonaws.guardduty#ServiceAdditionalInfo": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "This field specifies the value of the additional information.
", + "smithy.api#jsonName": "value" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Describes the type of the additional information.
", + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional information about the generated finding.
" + } + }, + "com.amazonaws.guardduty#Session": { + "type": "structure", + "members": { + "Uid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the session.
", + "smithy.api#jsonName": "uid" + } + }, + "MfaStatus": { + "target": "com.amazonaws.guardduty#MfaStatus", + "traits": { + "smithy.api#documentation": "Indicates whether or not multi-factor authencation (MFA) was used during authentication.
In Amazon Web Services CloudTrail, you can find this value as userIdentity.sessionContext.attributes.mfaAuthenticated.
The timestamp for when the session was created.
In Amazon Web Services CloudTrail, you can find this value as userIdentity.sessionContext.attributes.creationDate.
Identifier of the session issuer.
In Amazon Web Services CloudTrail, you can find this value as userIdentity.sessionContext.sessionIssuer.arn.
Contains information about the authenticated session.
" + } + }, + "com.amazonaws.guardduty#SessionNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#SeverityStatistics": { + "type": "structure", + "members": { + "LastGeneratedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which a finding type for a specific severity was last generated.
", + "smithy.api#jsonName": "lastGeneratedAt" + } + }, + "Severity": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#documentation": "The severity level associated with each finding type.
", + "smithy.api#jsonName": "severity" + } + }, + "TotalFindings": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The total number of findings associated with this severity.
", + "smithy.api#jsonName": "totalFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about severity level for each finding type.
" + } + }, + "com.amazonaws.guardduty#Signal": { + "type": "structure", + "members": { + "Uid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the signal.
", + "smithy.api#jsonName": "uid", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.guardduty#SignalType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of the signal used to identify an attack sequence.
Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see Foundational data sources in the Amazon GuardDuty User Guide.
A signal type can be one of the valid values listed in this API. Here are the related descriptions:
FINDING - Individually generated GuardDuty finding.
CLOUD_TRAIL - Activity observed from CloudTrail logs
S3_DATA_EVENTS - Activity observed from CloudTrail data events for S3. Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and steps to enable it, see S3 Protection in the Amazon GuardDuty User Guide.
The description of the signal.
", + "smithy.api#jsonName": "description" + } + }, + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the signal. For example, when signal type is FINDING, the signal name is the name of the finding.
The timestamp when the first finding or activity related to this signal was observed.
", + "smithy.api#jsonName": "createdAt", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The timestamp when this signal was last observed.
", + "smithy.api#jsonName": "updatedAt", + "smithy.api#required": {} + } + }, + "FirstSeenAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The timestamp when the first finding or activity related to this signal was observed.
", + "smithy.api#jsonName": "firstSeenAt", + "smithy.api#required": {} + } + }, + "LastSeenAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The timestamp when the last finding or activity related to this signal was observed.
", + "smithy.api#jsonName": "lastSeenAt", + "smithy.api#required": {} + } + }, + "Severity": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#documentation": "The severity associated with the signal. For more information about severity, see Findings severity levels in the Amazon GuardDuty User Guide.
", + "smithy.api#jsonName": "severity" + } + }, + "Count": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The number of times this signal was observed.
", + "smithy.api#jsonName": "count", + "smithy.api#required": {} + } + }, + "ResourceUids": { + "target": "com.amazonaws.guardduty#ResourceUids", + "traits": { + "smithy.api#documentation": "Information about the unique identifiers of the resources involved in the signal.
", + "smithy.api#jsonName": "resourceUids" + } + }, + "ActorIds": { + "target": "com.amazonaws.guardduty#ActorIds", + "traits": { + "smithy.api#documentation": "Information about the IDs of the threat actors involved in the signal.
", + "smithy.api#jsonName": "actorIds" + } + }, + "EndpointIds": { + "target": "com.amazonaws.guardduty#EndpointIds", + "traits": { + "smithy.api#documentation": "Information about the endpoint IDs associated with this signal.
", + "smithy.api#jsonName": "endpointIds" + } + }, + "SignalIndicators": { + "target": "com.amazonaws.guardduty#Indicators", + "traits": { + "smithy.api#documentation": "Contains information about the indicators associated with the signals.
", + "smithy.api#jsonName": "signalIndicators" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the signals involved in the attack sequence.
" + } + }, + "com.amazonaws.guardduty#SignalDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.guardduty#SignalType": { + "type": "enum", + "members": { + "FINDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINDING" + } + }, + "CLOUD_TRAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUD_TRAIL" + } + }, + "S3_DATA_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_DATA_EVENTS" + } + }, + "EKS_AUDIT_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_AUDIT_LOGS" + } + }, + "FLOW_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOW_LOGS" + } + }, + "DNS_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DNS_LOGS" + } + }, + "RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNTIME_MONITORING" + } + } + } + }, + "com.amazonaws.guardduty#Signals": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Signal" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.guardduty#SortCriteria": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Represents the finding attribute, such as accountId, that sorts the findings.
The order by which the sorted findings are to be displayed.
", + "smithy.api#jsonName": "orderBy" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the criteria used for sorting findings.
" + } + }, + "com.amazonaws.guardduty#SourceIps": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Sources": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#StartMalwareScan": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#StartMalwareScanRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#StartMalwareScanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#ConflictException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Initiates the malware scan. Invoking this API will automatically create the Service-linked role in the corresponding account if the resourceArn belongs to an EC2 instance.
When the malware scan starts, you can use the associated scan ID to track the status of the scan. For more information, see ListMalwareScans and GetMalwareScan.
When you use this API, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuardDuty Malware Protection.
", + "smithy.api#http": { + "method": "POST", + "uri": "/malware-scan/start", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#StartMalwareScanConfiguration": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Amazon Resource Name (ARN) of the IAM role that is used for scanning the resource.
", + "smithy.api#jsonName": "role", + "smithy.api#required": {} + } + }, + "IncrementalScanDetails": { + "target": "com.amazonaws.guardduty#IncrementalScanDetails", + "traits": { + "smithy.api#documentation": "Contains information about the incremental scan configuration. When specified, the scan will only process changes since the baseline resource.
", + "smithy.api#jsonName": "incrementalScanDetails" + } + }, + "RecoveryPoint": { + "target": "com.amazonaws.guardduty#RecoveryPoint", + "traits": { + "smithy.api#documentation": "Contains information about the recovery point configuration for the requested scan.
", + "smithy.api#jsonName": "recoveryPoint" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the configuration to be used for the malware scan.
" + } + }, + "com.amazonaws.guardduty#StartMalwareScanRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.guardduty#ResourceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource for which you invoked the API.
", + "smithy.api#jsonName": "resourceArn", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "ScanConfiguration": { + "target": "com.amazonaws.guardduty#StartMalwareScanConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the configuration to be used for the malware scan.
", + "smithy.api#jsonName": "scanConfiguration" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#StartMalwareScanResponse": { + "type": "structure", + "members": { + "ScanId": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.
", + "smithy.api#jsonName": "scanId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#StartMonitoringMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#StartMonitoringMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#StartMonitoringMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Turns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member/start", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#StartMonitoringMembersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty administrator account associated with the member accounts to monitor.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A list of account IDs of the GuardDuty member accounts to start monitoring.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#StartMonitoringMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#StopMonitoringMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#StopMonitoringMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#StopMonitoringMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Stops GuardDuty monitoring for the specified member accounts. Use the StartMonitoringMembers operation to restart monitoring for those accounts.
With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to stop monitoring the member accounts in your organization.
The unique ID of the detector associated with the GuardDuty administrator account that is monitoring member accounts.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A list of account IDs for the member accounts to stop monitoring.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#StopMonitoringMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain an accountId for each account that could not be processed, and a result string that indicates why the account was not processed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#String": { + "type": "string" + }, + "com.amazonaws.guardduty#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Describes the key associated with the tag.
", + "smithy.api#jsonName": "key" + } + }, + "Value": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Describes the value associated with the tag key.
", + "smithy.api#jsonName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a tag key-value pair.
" + } + }, + "com.amazonaws.guardduty#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.guardduty#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.guardduty#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#TagKey" + }, + "value": { + "target": "com.amazonaws.guardduty#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.guardduty#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Adds tags to a resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.guardduty#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.guardduty#GuardDutyArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the GuardDuty resource to apply a tag to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a resource.
", + "smithy.api#jsonName": "tags", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.guardduty#Tags": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Tag" + } + }, + "com.amazonaws.guardduty#Threat": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Name of the detected threat that caused GuardDuty to generate this finding.
", + "smithy.api#jsonName": "name" + } + }, + "Source": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Source of the threat that generated this finding.
", + "smithy.api#jsonName": "source" + } + }, + "ItemPaths": { + "target": "com.amazonaws.guardduty#ItemPaths", + "traits": { + "smithy.api#documentation": "Information about the nested item path and hash of the protected resource.
", + "smithy.api#jsonName": "itemPaths" + } + }, + "Count": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "The number of occurrences of this specific threat detected during the scan.
", + "smithy.api#jsonName": "count" + } + }, + "Hash": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The hash identifier of the detected malware threat.
", + "smithy.api#jsonName": "hash" + } + }, + "ItemDetails": { + "target": "com.amazonaws.guardduty#ItemDetailsList", + "traits": { + "smithy.api#documentation": "Detailed information about the detected malware threat.
", + "smithy.api#jsonName": "itemDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the detected threats associated with the generated finding.
" + } + }, + "com.amazonaws.guardduty#ThreatDetectedByName": { + "type": "structure", + "members": { + "ItemCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of infected files identified.
", + "smithy.api#jsonName": "itemCount" + } + }, + "UniqueThreatNameCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of unique threats by name identified, as part of the malware scan.
", + "smithy.api#jsonName": "uniqueThreatNameCount" + } + }, + "Shortened": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Flag to determine if the finding contains every single infected file-path and/or every threat.
", + "smithy.api#jsonName": "shortened" + } + }, + "ThreatNames": { + "target": "com.amazonaws.guardduty#ScanThreatNames", + "traits": { + "smithy.api#documentation": "List of identified threats with details, organized by threat name.
", + "smithy.api#jsonName": "threatNames" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about identified threats organized by threat name.
" + } + }, + "com.amazonaws.guardduty#ThreatEntitySetFormat": { + "type": "enum", + "members": { + "TXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TXT" + } + }, + "STIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STIX" + } + }, + "OTX_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTX_CSV" + } + }, + "ALIEN_VAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALIEN_VAULT" + } + }, + "PROOF_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROOF_POINT" + } + }, + "FIRE_EYE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRE_EYE" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#ThreatEntitySetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#ThreatEntitySetStatus": { + "type": "enum", + "members": { + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DEACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_PENDING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#ThreatIntelSetFormat": { + "type": "enum", + "members": { + "TXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TXT" + } + }, + "STIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STIX" + } + }, + "OTX_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTX_CSV" + } + }, + "ALIEN_VAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALIEN_VAULT" + } + }, + "PROOF_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROOF_POINT" + } + }, + "FIRE_EYE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRE_EYE" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#ThreatIntelSetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#ThreatIntelSetStatus": { + "type": "enum", + "members": { + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DEACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_PENDING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#ThreatIntelligenceDetail": { + "type": "structure", + "members": { + "ThreatListName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the threat intelligence list that triggered the finding.
", + "smithy.api#jsonName": "threatListName" + } + }, + "ThreatNames": { + "target": "com.amazonaws.guardduty#ThreatNames", + "traits": { + "smithy.api#documentation": "A list of names of the threats in the threat intelligence list that triggered the finding.
", + "smithy.api#jsonName": "threatNames" + } + }, + "ThreatFileSha256": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "SHA256 of the file that generated the finding.
", + "smithy.api#jsonName": "threatFileSha256" + } + } + }, + "traits": { + "smithy.api#documentation": "An instance of a threat intelligence detail that constitutes evidence for the finding.
" + } + }, + "com.amazonaws.guardduty#ThreatIntelligenceDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ThreatIntelligenceDetail" + } + }, + "com.amazonaws.guardduty#ThreatNames": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Threats": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Threat" + } + }, + "com.amazonaws.guardduty#ThreatsDetectedItemCount": { + "type": "structure", + "members": { + "Files": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of infected files.
", + "smithy.api#jsonName": "files" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains total number of infected files.
" + } + }, + "com.amazonaws.guardduty#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.guardduty#Total": { + "type": "structure", + "members": { + "Amount": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The total usage.
", + "smithy.api#jsonName": "amount" + } + }, + "Unit": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The currency unit that the amount is given in.
", + "smithy.api#jsonName": "unit" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the total usage with the corresponding currency unit for that value.
" + } + }, + "com.amazonaws.guardduty#TriggerDetails": { + "type": "structure", + "members": { + "GuardDutyFindingId": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID of the GuardDuty finding that triggered the malware scan.
", + "smithy.api#jsonName": "guardDutyFindingId" + } + }, + "Description": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The description of the scan trigger.
", + "smithy.api#jsonName": "description" + } + }, + "TriggerType": { + "target": "com.amazonaws.guardduty#TriggerType", + "traits": { + "smithy.api#documentation": "Specifies the trigger type that started the malware scan.
", + "smithy.api#jsonName": "triggerType" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the reason the scan was triggered.
" + } + }, + "com.amazonaws.guardduty#TriggerPrompt": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.guardduty#TriggerType": { + "type": "enum", + "members": { + "BACKUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BACKUP" + } + }, + "GUARDDUTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GUARDDUTY" + } + } + } + }, + "com.amazonaws.guardduty#TriggeredBy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.guardduty#TrustedEntitySetFormat": { + "type": "enum", + "members": { + "TXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TXT" + } + }, + "STIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STIX" + } + }, + "OTX_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTX_CSV" + } + }, + "ALIEN_VAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALIEN_VAULT" + } + }, + "PROOF_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROOF_POINT" + } + }, + "FIRE_EYE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRE_EYE" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#TrustedEntitySetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#TrustedEntitySetStatus": { + "type": "enum", + "members": { + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DEACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_PENDING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#UnarchiveFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UnarchiveFindingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UnarchiveFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Unarchives GuardDuty findings specified by the findingIds.
The ID of the detector associated with the findings to unarchive.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The IDs of the findings to unarchive.
", + "smithy.api#jsonName": "findingIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UnarchiveFindingsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UnprocessedAccount": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#jsonName": "accountId", + "smithy.api#required": {} + } + }, + "Result": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A reason why the account hasn't been processed.
", + "smithy.api#jsonName": "result", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the accounts that weren't processed.
" + } + }, + "com.amazonaws.guardduty#UnprocessedAccounts": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UnprocessedAccount" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#UnprocessedDataSourcesResult": { + "type": "structure", + "members": { + "MalwareProtection": { + "target": "com.amazonaws.guardduty#MalwareProtectionConfigurationResult", + "traits": { + "smithy.api#jsonName": "malwareProtection" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the names of the data sources that couldn't be enabled.
" + } + }, + "com.amazonaws.guardduty#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Removes tags from a resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.guardduty#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.guardduty#GuardDutyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource to remove tags from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.guardduty#TagKeyList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The tag keys to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateDetectorRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateDetectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the GuardDuty detector specified by the detector ID.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can add only one of these two features because Runtime Monitoring already includes the threat detection for Amazon EKS resources. For more information, see Runtime Monitoring.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateDetectorRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector to update.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
Specifies whether the detector is enabled or not enabled.
", + "smithy.api#jsonName": "enable" + } + }, + "FindingPublishingFrequency": { + "target": "com.amazonaws.guardduty#FindingPublishingFrequency", + "traits": { + "smithy.api#documentation": "An enum value that specifies how frequently findings are exported, such as to CloudWatch Events.
", + "smithy.api#jsonName": "findingPublishingFrequency" + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurations", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Describes which data sources will be updated.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#DetectorFeatureConfigurations", + "traits": { + "smithy.api#documentation": "Provides the features that will be updated for the detector.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateDetectorResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateFilterRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the filter specified by the filter name.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/filter/{FilterName}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateFilterRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that specifies the GuardDuty service where you want to update a filter.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The name of the filter.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.guardduty#FilterDescription", + "traits": { + "smithy.api#documentation": "The description of the filter. Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses ({ }, [ ], and ( )), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace.
Specifies the action that is to be applied to the findings that match the filter.
Default: NOOP
", + "smithy.api#jsonName": "action" + } + }, + "Rank": { + "target": "com.amazonaws.guardduty#FilterRank", + "traits": { + "smithy.api#documentation": "Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.
", + "smithy.api#jsonName": "rank" + } + }, + "FindingCriteria": { + "target": "com.amazonaws.guardduty#FindingCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria to be used in the filter for querying findings. The following fields are available for filtering:
accountId
arn
associatedAttackSequenceArn
confidence
createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
id
partition
region
resource.accessKeyDetails.accessKeyId
resource.accessKeyDetails.principalId
resource.accessKeyDetails.userIdentity.accessKeyId
resource.accessKeyDetails.userIdentity.accountId
resource.accessKeyDetails.userIdentity.arn
resource.accessKeyDetails.userIdentity.principalId
resource.accessKeyDetails.userIdentity.sessionContext.attributes.mfaAuthenticated
resource.accessKeyDetails.userIdentity.sessionContext.ec2RoleDelivery
resource.accessKeyDetails.userIdentity.sessionContext.invokedBy
resource.accessKeyDetails.userIdentity.sessionContext.sessionIssuer.accountId
resource.accessKeyDetails.userIdentity.sessionContext.sessionIssuer.arn
resource.accessKeyDetails.userIdentity.sessionContext.sessionIssuer.principalId
resource.accessKeyDetails.userIdentity.sessionContext.sessionIssuer.type
resource.accessKeyDetails.userIdentity.sessionContext.sessionIssuer.userName
resource.accessKeyDetails.userIdentity.sessionContext.sourceIdentity
resource.accessKeyDetails.userIdentity.sessionContext.webIdFederationData.attributes
resource.accessKeyDetails.userIdentity.sessionContext.webIdFederationData.federatedProvider
resource.accessKeyDetails.userIdentity.type
resource.accessKeyDetails.userIdentity.userName
resource.accessKeyDetails.userName
resource.accessKeyDetails.userType
resource.bedrockGuardrailDetails.guardrailArn
resource.bedrockGuardrailDetails.guardrailVersion
resource.containerDetails.containerRuntime
resource.containerDetails.id
resource.containerDetails.image
resource.containerDetails.imagePrefix
resource.containerDetails.name
resource.containerDetails.securityContext.allowPrivilegeEscalation
resource.containerDetails.securityContext.privileged
resource.containerDetails.volumeMounts.mountPath
resource.containerDetails.volumeMounts.name
resource.ebsSnapshotDetails.snapshotArn
resource.ebsVolumeDetails.scannedVolumeDetails.deviceName
resource.ebsVolumeDetails.scannedVolumeDetails.encryptionType
resource.ebsVolumeDetails.scannedVolumeDetails.kmsKeyArn
resource.ebsVolumeDetails.scannedVolumeDetails.snapshotArn
resource.ebsVolumeDetails.scannedVolumeDetails.volumeArn
resource.ebsVolumeDetails.scannedVolumeDetails.volumeSizeInGB
resource.ebsVolumeDetails.scannedVolumeDetails.volumeType
resource.ebsVolumeDetails.skippedVolumeDetails.deviceName
resource.ebsVolumeDetails.skippedVolumeDetails.encryptionType
resource.ebsVolumeDetails.skippedVolumeDetails.kmsKeyArn
resource.ebsVolumeDetails.skippedVolumeDetails.snapshotArn
resource.ebsVolumeDetails.skippedVolumeDetails.volumeArn
resource.ebsVolumeDetails.skippedVolumeDetails.volumeSizeInGB
resource.ebsVolumeDetails.skippedVolumeDetails.volumeType
resource.ec2ImageDetails.imageArn
resource.ecsClusterDetails.activeServicesCount
resource.ecsClusterDetails.arn
resource.ecsClusterDetails.name
resource.ecsClusterDetails.registeredContainerInstancesCount
resource.ecsClusterDetails.runningTasksCount
resource.ecsClusterDetails.status
resource.ecsClusterDetails.tags.key
resource.ecsClusterDetails.tags.value
resource.ecsClusterDetails.taskDetails.arn
resource.ecsClusterDetails.taskDetails.containers.containerRuntime
resource.ecsClusterDetails.taskDetails.containers.id
resource.ecsClusterDetails.taskDetails.containers.image
resource.ecsClusterDetails.taskDetails.containers.imagePrefix
resource.ecsClusterDetails.taskDetails.containers.name
resource.ecsClusterDetails.taskDetails.containers.securityContext.allowPrivilegeEscalation
resource.ecsClusterDetails.taskDetails.containers.securityContext.privileged
resource.ecsClusterDetails.taskDetails.containers.volumeMounts.mountPath
resource.ecsClusterDetails.taskDetails.containers.volumeMounts.name
resource.ecsClusterDetails.taskDetails.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
resource.ecsClusterDetails.taskDetails.definitionArn
resource.ecsClusterDetails.taskDetails.group
resource.ecsClusterDetails.taskDetails.launchType
resource.ecsClusterDetails.taskDetails.startedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
resource.ecsClusterDetails.taskDetails.startedBy
resource.ecsClusterDetails.taskDetails.tags.key
resource.ecsClusterDetails.taskDetails.tags.value
resource.ecsClusterDetails.taskDetails.version
resource.ecsClusterDetails.taskDetails.volumes.hostPath.path
resource.ecsClusterDetails.taskDetails.volumes.name
resource.eksClusterDetails.arn
resource.eksClusterDetails.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
resource.eksClusterDetails.name
resource.eksClusterDetails.status
resource.eksClusterDetails.tags.key
resource.eksClusterDetails.tags.value
resource.eksClusterDetails.vpcId
resource.instanceDetails.availabilityZone
resource.instanceDetails.iamInstanceProfile.arn
resource.instanceDetails.iamInstanceProfile.id
resource.instanceDetails.imageDescription
resource.instanceDetails.imageId
resource.instanceDetails.instanceId
resource.instanceDetails.instanceState
resource.instanceDetails.instanceType
resource.instanceDetails.launchTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
resource.instanceDetails.networkInterfaces.ipv6Addresses
resource.instanceDetails.networkInterfaces.networkInterfaceId
resource.instanceDetails.networkInterfaces.privateDnsName
resource.instanceDetails.networkInterfaces.privateIpAddress
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateDnsName
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
resource.instanceDetails.networkInterfaces.publicDnsName
resource.instanceDetails.networkInterfaces.publicIp
resource.instanceDetails.networkInterfaces.securityGroups.groupId
resource.instanceDetails.networkInterfaces.securityGroups.groupName
resource.instanceDetails.networkInterfaces.subnetId
resource.instanceDetails.networkInterfaces.vpcId
resource.instanceDetails.outpostArn
resource.instanceDetails.platform
resource.instanceDetails.productCodes.productCodeId
resource.instanceDetails.productCodes.productCodeType
resource.instanceDetails.tags.key
resource.instanceDetails.tags.value
resource.kubernetesDetails.kubernetesUserDetails.groups
resource.kubernetesDetails.kubernetesUserDetails.impersonatedUser.groups
resource.kubernetesDetails.kubernetesUserDetails.impersonatedUser.username
resource.kubernetesDetails.kubernetesUserDetails.sessionName
resource.kubernetesDetails.kubernetesUserDetails.uid
resource.kubernetesDetails.kubernetesUserDetails.username
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.containerRuntime
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.id
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.name
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.securityContext.allowPrivilegeEscalation
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.securityContext.privileged
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.volumeMounts.mountPath
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.volumeMounts.name
resource.kubernetesDetails.kubernetesWorkloadDetails.hostIpc
resource.kubernetesDetails.kubernetesWorkloadDetails.hostNetwork
resource.kubernetesDetails.kubernetesWorkloadDetails.hostPid
resource.kubernetesDetails.kubernetesWorkloadDetails.name
resource.kubernetesDetails.kubernetesWorkloadDetails.namespace
resource.kubernetesDetails.kubernetesWorkloadDetails.serviceAccountName
resource.kubernetesDetails.kubernetesWorkloadDetails.type
resource.kubernetesDetails.kubernetesWorkloadDetails.uid
resource.kubernetesDetails.kubernetesWorkloadDetails.volumes.hostPath.path
resource.kubernetesDetails.kubernetesWorkloadDetails.volumes.name
resource.lambdaDetails.description
resource.lambdaDetails.functionArn
resource.lambdaDetails.functionName
resource.lambdaDetails.functionVersion
resource.lambdaDetails.lastModifiedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
resource.lambdaDetails.revisionId
resource.lambdaDetails.role
resource.lambdaDetails.tags.key
resource.lambdaDetails.tags.value
resource.lambdaDetails.vpcConfig.securityGroups.groupId
resource.lambdaDetails.vpcConfig.securityGroups.groupName
resource.lambdaDetails.vpcConfig.subnetIds
resource.lambdaDetails.vpcConfig.vpcId
resource.rdsDbInstanceDetails.dbClusterIdentifier
resource.rdsDbInstanceDetails.dbInstanceArn
resource.rdsDbInstanceDetails.dbInstanceIdentifier
resource.rdsDbInstanceDetails.dbSecurityGroups.name
resource.rdsDbInstanceDetails.dbSecurityGroups.status
resource.rdsDbInstanceDetails.dbiResourceId
resource.rdsDbInstanceDetails.engine
resource.rdsDbInstanceDetails.engineVersion
resource.rdsDbInstanceDetails.iamDatabaseAuthenticationEnabled
resource.rdsDbInstanceDetails.publiclyAccessible
resource.rdsDbInstanceDetails.vpcId
resource.rdsDbInstanceDetails.vpcSecurityGroups.status
resource.rdsDbInstanceDetails.vpcSecurityGroups.vpcSecurityGroupId
resource.rdsDbUserDetails.application
resource.rdsDbUserDetails.authMethod
resource.rdsDbUserDetails.database
resource.rdsDbUserDetails.ssl
resource.rdsDbUserDetails.user
resource.rdsLimitlessDbDetails.dbClusterIdentifier
resource.rdsLimitlessDbDetails.dbShardGroupArn
resource.rdsLimitlessDbDetails.dbShardGroupIdentifier
resource.rdsLimitlessDbDetails.dbShardGroupResourceId
resource.rdsLimitlessDbDetails.engine
resource.rdsLimitlessDbDetails.engineVersion
resource.rdsLimitlessDbDetails.tags.key
resource.rdsLimitlessDbDetails.tags.value
resource.recoveryPointDetails.backupVaultName
resource.recoveryPointDetails.recoveryPointArn
resource.resourceType
resource.s3BucketDetails.arn
resource.s3BucketDetails.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
resource.s3BucketDetails.defaultServerSideEncryption.encryptionType
resource.s3BucketDetails.defaultServerSideEncryption.kmsMasterKeyArn
resource.s3BucketDetails.name
resource.s3BucketDetails.owner.id
resource.s3BucketDetails.publicAccess.effectivePermission
resource.s3BucketDetails.publicAccess.permissionConfiguration.accountLevelPermissions.blockPublicAccess.blockPublicAcls
resource.s3BucketDetails.publicAccess.permissionConfiguration.accountLevelPermissions.blockPublicAccess.blockPublicPolicy
resource.s3BucketDetails.publicAccess.permissionConfiguration.accountLevelPermissions.blockPublicAccess.ignorePublicAcls
resource.s3BucketDetails.publicAccess.permissionConfiguration.accountLevelPermissions.blockPublicAccess.restrictPublicBuckets
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.accessControlList.allowsPublicReadAccess
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.accessControlList.allowsPublicWriteAccess
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.blockPublicAccess.blockPublicAcls
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.blockPublicAccess.blockPublicPolicy
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.blockPublicAccess.ignorePublicAcls
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.blockPublicAccess.restrictPublicBuckets
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.bucketPolicy.allowsPublicReadAccess
resource.s3BucketDetails.publicAccess.permissionConfiguration.bucketLevelPermissions.bucketPolicy.allowsPublicWriteAccess
resource.s3BucketDetails.s3ObjectDetails.eTag
resource.s3BucketDetails.s3ObjectDetails.hash
resource.s3BucketDetails.s3ObjectDetails.key
resource.s3BucketDetails.s3ObjectDetails.objectArn
resource.s3BucketDetails.s3ObjectDetails.versionId
resource.s3BucketDetails.tags.key
resource.s3BucketDetails.tags.value
resource.s3BucketDetails.type
schemaVersion
service.action.actionType
service.action.awsApiCallAction.api
service.action.awsApiCallAction.callerType
service.action.awsApiCallAction.domainDetails.domain
service.action.awsApiCallAction.errorCode
service.action.awsApiCallAction.remoteAccountDetails.accountId
service.action.awsApiCallAction.remoteAccountDetails.affiliated
service.action.awsApiCallAction.remoteAccountDetails.awsServiceName
service.action.awsApiCallAction.remoteIpDetails.city.cityName
service.action.awsApiCallAction.remoteIpDetails.country.countryCode
service.action.awsApiCallAction.remoteIpDetails.country.countryName
service.action.awsApiCallAction.remoteIpDetails.geoLocation.lat
service.action.awsApiCallAction.remoteIpDetails.geoLocation.lon
service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
service.action.awsApiCallAction.remoteIpDetails.ipAddressV6
service.action.awsApiCallAction.remoteIpDetails.organization.asn
service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
service.action.awsApiCallAction.remoteIpDetails.organization.isp
service.action.awsApiCallAction.remoteIpDetails.organization.org
service.action.awsApiCallAction.serviceName
service.action.awsApiCallAction.userAgent
service.action.dnsRequestAction.blocked
service.action.dnsRequestAction.domain
service.action.dnsRequestAction.domainWithSuffix
service.action.dnsRequestAction.protocol
service.action.dnsRequestAction.vpcOwnerAccountId
service.action.kubernetesApiCallAction.namespace
service.action.kubernetesApiCallAction.parameters
service.action.kubernetesApiCallAction.remoteIpDetails.city.cityName
service.action.kubernetesApiCallAction.remoteIpDetails.country.countryCode
service.action.kubernetesApiCallAction.remoteIpDetails.country.countryName
service.action.kubernetesApiCallAction.remoteIpDetails.geoLocation.lat
service.action.kubernetesApiCallAction.remoteIpDetails.geoLocation.lon
service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6
service.action.kubernetesApiCallAction.remoteIpDetails.organization.asn
service.action.kubernetesApiCallAction.remoteIpDetails.organization.asnOrg
service.action.kubernetesApiCallAction.remoteIpDetails.organization.isp
service.action.kubernetesApiCallAction.remoteIpDetails.organization.org
service.action.kubernetesApiCallAction.requestUri
service.action.kubernetesApiCallAction.resource
service.action.kubernetesApiCallAction.resourceName
service.action.kubernetesApiCallAction.sourceIPs
service.action.kubernetesApiCallAction.statusCode
service.action.kubernetesApiCallAction.subresource
service.action.kubernetesApiCallAction.userAgent
service.action.kubernetesApiCallAction.verb
service.action.kubernetesPermissionCheckedDetails.allowed
service.action.kubernetesPermissionCheckedDetails.namespace
service.action.kubernetesPermissionCheckedDetails.resource
service.action.kubernetesPermissionCheckedDetails.verb
service.action.kubernetesRoleBindingDetails.kind
service.action.kubernetesRoleBindingDetails.name
service.action.kubernetesRoleBindingDetails.roleRefKind
service.action.kubernetesRoleBindingDetails.roleRefName
service.action.kubernetesRoleBindingDetails.uid
service.action.kubernetesRoleDetails.kind
service.action.kubernetesRoleDetails.name
service.action.kubernetesRoleDetails.uid
service.action.networkConnectionAction.blocked
service.action.networkConnectionAction.connectionDirection
service.action.networkConnectionAction.localIpDetails.ipAddressV4
service.action.networkConnectionAction.localIpDetails.ipAddressV6
service.action.networkConnectionAction.localNetworkInterface
service.action.networkConnectionAction.localPortDetails.port
service.action.networkConnectionAction.localPortDetails.portName
service.action.networkConnectionAction.protocol
service.action.networkConnectionAction.remoteIpDetails.city.cityName
service.action.networkConnectionAction.remoteIpDetails.country.countryCode
service.action.networkConnectionAction.remoteIpDetails.country.countryName
service.action.networkConnectionAction.remoteIpDetails.geoLocation.lat
service.action.networkConnectionAction.remoteIpDetails.geoLocation.lon
service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
service.action.networkConnectionAction.remoteIpDetails.ipAddressV6
service.action.networkConnectionAction.remoteIpDetails.organization.asn
service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
service.action.networkConnectionAction.remoteIpDetails.organization.isp
service.action.networkConnectionAction.remoteIpDetails.organization.org
service.action.networkConnectionAction.remotePortDetails.port
service.action.networkConnectionAction.remotePortDetails.portName
service.action.portProbeAction.blocked
service.action.portProbeAction.portProbeDetails.localIpDetails.ipAddressV4
service.action.portProbeAction.portProbeDetails.localIpDetails.ipAddressV6
service.action.portProbeAction.portProbeDetails.localPortDetails.port
service.action.portProbeAction.portProbeDetails.localPortDetails.portName
service.action.portProbeAction.portProbeDetails.remoteIpDetails.city.cityName
service.action.portProbeAction.portProbeDetails.remoteIpDetails.country.countryCode
service.action.portProbeAction.portProbeDetails.remoteIpDetails.country.countryName
service.action.portProbeAction.portProbeDetails.remoteIpDetails.geoLocation.lat
service.action.portProbeAction.portProbeDetails.remoteIpDetails.geoLocation.lon
service.action.portProbeAction.portProbeDetails.remoteIpDetails.ipAddressV4
service.action.portProbeAction.portProbeDetails.remoteIpDetails.ipAddressV6
service.action.portProbeAction.portProbeDetails.remoteIpDetails.organization.asn
service.action.portProbeAction.portProbeDetails.remoteIpDetails.organization.asnOrg
service.action.portProbeAction.portProbeDetails.remoteIpDetails.organization.isp
service.action.portProbeAction.portProbeDetails.remoteIpDetails.organization.org
service.action.rdsLoginAttemptAction.loginAttributes.application
service.action.rdsLoginAttemptAction.loginAttributes.failedLoginAttempts
service.action.rdsLoginAttemptAction.loginAttributes.successfulLoginAttempts
service.action.rdsLoginAttemptAction.loginAttributes.user
service.action.rdsLoginAttemptAction.remoteIpDetails.city.cityName
service.action.rdsLoginAttemptAction.remoteIpDetails.country.countryCode
service.action.rdsLoginAttemptAction.remoteIpDetails.country.countryName
service.action.rdsLoginAttemptAction.remoteIpDetails.geoLocation.lat
service.action.rdsLoginAttemptAction.remoteIpDetails.geoLocation.lon
service.action.rdsLoginAttemptAction.remoteIpDetails.ipAddressV4
service.action.rdsLoginAttemptAction.remoteIpDetails.ipAddressV6
service.action.rdsLoginAttemptAction.remoteIpDetails.organization.asn
service.action.rdsLoginAttemptAction.remoteIpDetails.organization.asnOrg
service.action.rdsLoginAttemptAction.remoteIpDetails.organization.isp
service.action.rdsLoginAttemptAction.remoteIpDetails.organization.org
service.additionalInfo.agentDetails.agentId
service.additionalInfo.agentDetails.agentVersion
service.additionalInfo.anomalies.anomalousAPIs
service.additionalInfo.authenticationMethod
service.additionalInfo.averagePacketSizeIn
service.additionalInfo.averagePacketSizeOut
service.additionalInfo.context
service.additionalInfo.domain
service.additionalInfo.inBytes
service.additionalInfo.localNetworkInterfaceOwner
service.additionalInfo.localPort
service.additionalInfo.outBytes
service.additionalInfo.packetsIn
service.additionalInfo.packetsOut
service.additionalInfo.policyArn
service.additionalInfo.policyName
service.additionalInfo.remotePort
service.additionalInfo.sample
service.additionalInfo.scannedPort
service.additionalInfo.threatFileSha256
service.additionalInfo.threatListName
service.additionalInfo.threatName
service.additionalInfo.totalBytesIn
service.additionalInfo.totalBytesOut
service.additionalInfo.type
service.additionalInfo.unusual.asnOrg
service.additionalInfo.unusual.port
service.additionalInfo.unusualProtocol
service.additionalInfo.userAgent.fullUserAgent
service.additionalInfo.userAgent.userAgentCategory
service.additionalInfo.value
service.additionalInfo.vpcOwnerAccountId
service.archived
service.count
service.detection.sequence.actors.id
service.detection.sequence.actors.process.name
service.detection.sequence.actors.process.path
service.detection.sequence.actors.process.sha256
service.detection.sequence.actors.session.createdTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.actors.session.issuer
service.detection.sequence.actors.session.mfaStatus
service.detection.sequence.actors.session.uid
service.detection.sequence.actors.user.account.account
service.detection.sequence.actors.user.account.uid
service.detection.sequence.actors.user.credentialUid
service.detection.sequence.actors.user.name
service.detection.sequence.actors.user.type
service.detection.sequence.actors.user.uid
service.detection.sequence.additionalSequenceTypes
service.detection.sequence.description
service.detection.sequence.endpoints.autonomousSystem.name
service.detection.sequence.endpoints.autonomousSystem.number
service.detection.sequence.endpoints.connection.direction
service.detection.sequence.endpoints.domain
service.detection.sequence.endpoints.id
service.detection.sequence.endpoints.ip
service.detection.sequence.endpoints.location.city
service.detection.sequence.endpoints.location.country
service.detection.sequence.endpoints.location.lat
service.detection.sequence.endpoints.location.lon
service.detection.sequence.endpoints.port
service.detection.sequence.resources.accountId
service.detection.sequence.resources.cloudPartition
service.detection.sequence.resources.data.accessKey.principalId
service.detection.sequence.resources.data.accessKey.userName
service.detection.sequence.resources.data.accessKey.userType
service.detection.sequence.resources.data.autoscalingAutoScalingGroup.ec2InstanceUids
service.detection.sequence.resources.data.cloudformationStack.ec2InstanceUids
service.detection.sequence.resources.data.container.image
service.detection.sequence.resources.data.container.imageUid
service.detection.sequence.resources.data.ec2Image.ec2InstanceUids
service.detection.sequence.resources.data.ec2Instance.availabilityZone
service.detection.sequence.resources.data.ec2Instance.ec2NetworkInterfaceUids
service.detection.sequence.resources.data.ec2Instance.iamInstanceProfile.arn
service.detection.sequence.resources.data.ec2Instance.iamInstanceProfile.id
service.detection.sequence.resources.data.ec2Instance.imageDescription
service.detection.sequence.resources.data.ec2Instance.instanceState
service.detection.sequence.resources.data.ec2Instance.instanceType
service.detection.sequence.resources.data.ec2Instance.outpostArn
service.detection.sequence.resources.data.ec2Instance.platform
service.detection.sequence.resources.data.ec2Instance.productCodes.productCodeId
service.detection.sequence.resources.data.ec2Instance.productCodes.productCodeType
service.detection.sequence.resources.data.ec2LaunchTemplate.ec2InstanceUids
service.detection.sequence.resources.data.ec2LaunchTemplate.version
service.detection.sequence.resources.data.ec2NetworkInterface.ipv6Addresses
service.detection.sequence.resources.data.ec2NetworkInterface.privateIpAddresses.privateDnsName
service.detection.sequence.resources.data.ec2NetworkInterface.privateIpAddresses.privateIpAddress
service.detection.sequence.resources.data.ec2NetworkInterface.publicIp
service.detection.sequence.resources.data.ec2NetworkInterface.securityGroups.groupId
service.detection.sequence.resources.data.ec2NetworkInterface.securityGroups.groupName
service.detection.sequence.resources.data.ec2NetworkInterface.subNetId
service.detection.sequence.resources.data.ec2NetworkInterface.vpcId
service.detection.sequence.resources.data.ec2Vpc.ec2InstanceUids
service.detection.sequence.resources.data.ecsCluster.ec2InstanceUids
service.detection.sequence.resources.data.ecsCluster.status
service.detection.sequence.resources.data.ecsTask.containerUids
service.detection.sequence.resources.data.ecsTask.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.resources.data.ecsTask.launchType
service.detection.sequence.resources.data.ecsTask.taskDefinitionArn
service.detection.sequence.resources.data.eksCluster.arn
service.detection.sequence.resources.data.eksCluster.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.resources.data.eksCluster.ec2InstanceUids
service.detection.sequence.resources.data.eksCluster.status
service.detection.sequence.resources.data.eksCluster.vpcId
service.detection.sequence.resources.data.iamInstanceProfile.ec2InstanceUids
service.detection.sequence.resources.data.iamInstanceProfile.id
service.detection.sequence.resources.data.kubernetesWorkload.containerUids
service.detection.sequence.resources.data.kubernetesWorkload.namespace
service.detection.sequence.resources.data.kubernetesWorkload.type
service.detection.sequence.resources.data.s3Bucket.accountPublicAccess.publicAclAccess
service.detection.sequence.resources.data.s3Bucket.accountPublicAccess.publicAclIgnoreBehavior
service.detection.sequence.resources.data.s3Bucket.accountPublicAccess.publicBucketRestrictBehavior
service.detection.sequence.resources.data.s3Bucket.accountPublicAccess.publicPolicyAccess
service.detection.sequence.resources.data.s3Bucket.bucketPublicAccess.publicAclAccess
service.detection.sequence.resources.data.s3Bucket.bucketPublicAccess.publicAclIgnoreBehavior
service.detection.sequence.resources.data.s3Bucket.bucketPublicAccess.publicBucketRestrictBehavior
service.detection.sequence.resources.data.s3Bucket.bucketPublicAccess.publicPolicyAccess
service.detection.sequence.resources.data.s3Bucket.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.resources.data.s3Bucket.effectivePermission
service.detection.sequence.resources.data.s3Bucket.encryptionKeyArn
service.detection.sequence.resources.data.s3Bucket.encryptionType
service.detection.sequence.resources.data.s3Bucket.ownerId
service.detection.sequence.resources.data.s3Bucket.publicReadAccess
service.detection.sequence.resources.data.s3Bucket.publicWriteAccess
service.detection.sequence.resources.data.s3Bucket.s3ObjectUids
service.detection.sequence.resources.data.s3Object.eTag
service.detection.sequence.resources.data.s3Object.key
service.detection.sequence.resources.data.s3Object.versionId
service.detection.sequence.resources.name
service.detection.sequence.resources.region
service.detection.sequence.resources.resourceType
service.detection.sequence.resources.service
service.detection.sequence.resources.tags.key
service.detection.sequence.resources.tags.value
service.detection.sequence.resources.uid
service.detection.sequence.sequenceIndicators.key
service.detection.sequence.sequenceIndicators.title
service.detection.sequence.sequenceIndicators.values
service.detection.sequence.signals.actorIds
service.detection.sequence.signals.count
service.detection.sequence.signals.createdAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.signals.description
service.detection.sequence.signals.endpointIds
service.detection.sequence.signals.firstSeenAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.signals.lastSeenAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.signals.name
service.detection.sequence.signals.resourceUids
service.detection.sequence.signals.severity
service.detection.sequence.signals.signalIndicators.key
service.detection.sequence.signals.signalIndicators.title
service.detection.sequence.signals.signalIndicators.values
service.detection.sequence.signals.type
service.detection.sequence.signals.uid
service.detection.sequence.signals.updatedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.detection.sequence.uid
service.detectorId
service.ebsVolumeScanDetails.scanCompletedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.ebsVolumeScanDetails.scanDetections.highestSeverityThreatDetails.count
service.ebsVolumeScanDetails.scanDetections.highestSeverityThreatDetails.severity
service.ebsVolumeScanDetails.scanDetections.highestSeverityThreatDetails.threatName
service.ebsVolumeScanDetails.scanDetections.scannedItemCount.files
service.ebsVolumeScanDetails.scanDetections.scannedItemCount.totalGb
service.ebsVolumeScanDetails.scanDetections.scannedItemCount.volumes
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.itemCount
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.shortened
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.fileName
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.filePath
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.volumeArn
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.itemCount
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.uniqueThreatNameCount
service.ebsVolumeScanDetails.scanDetections.threatsDetectedItemCount.files
service.ebsVolumeScanDetails.scanId
service.ebsVolumeScanDetails.scanStartedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.ebsVolumeScanDetails.scanType
service.ebsVolumeScanDetails.sources
service.ebsVolumeScanDetails.triggerFindingId
service.eventFirstSeen
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.eventLastSeen
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.evidence.threatIntelligenceDetails.threatFileSha256
service.evidence.threatIntelligenceDetails.threatListName
service.evidence.threatIntelligenceDetails.threatNames
service.featureName
service.malwareScanDetails.scanCategory
service.malwareScanDetails.scanConfiguration.incrementalScanDetails.baselineResourceArn
service.malwareScanDetails.scanConfiguration.triggerType
service.malwareScanDetails.scanId
service.malwareScanDetails.scanType
service.malwareScanDetails.threats.count
service.malwareScanDetails.threats.hash
service.malwareScanDetails.threats.itemDetails.additionalInfo.deviceName
service.malwareScanDetails.threats.itemDetails.additionalInfo.versionId
service.malwareScanDetails.threats.itemDetails.hash
service.malwareScanDetails.threats.itemDetails.itemPath
service.malwareScanDetails.threats.itemDetails.resourceArn
service.malwareScanDetails.threats.itemPaths.hash
service.malwareScanDetails.threats.itemPaths.nestedItemPath
service.malwareScanDetails.threats.name
service.malwareScanDetails.threats.source
service.malwareScanDetails.uniqueThreatCount
service.resourceRole
service.runtimeDetails.context.addressFamily
service.runtimeDetails.context.commandLineExample
service.runtimeDetails.context.fileOperation
service.runtimeDetails.context.filePath
service.runtimeDetails.context.fileSystemType
service.runtimeDetails.context.flags
service.runtimeDetails.context.ianaProtocolNumber
service.runtimeDetails.context.ldPreloadValue
service.runtimeDetails.context.libraryPath
service.runtimeDetails.context.memoryRegions
service.runtimeDetails.context.modifiedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.context.modifyingProcess.euid
service.runtimeDetails.context.modifyingProcess.executablePath
service.runtimeDetails.context.modifyingProcess.executableSha256
service.runtimeDetails.context.modifyingProcess.lineage.euid
service.runtimeDetails.context.modifyingProcess.lineage.executablePath
service.runtimeDetails.context.modifyingProcess.lineage.name
service.runtimeDetails.context.modifyingProcess.lineage.namespacePid
service.runtimeDetails.context.modifyingProcess.lineage.parentUuid
service.runtimeDetails.context.modifyingProcess.lineage.pid
service.runtimeDetails.context.modifyingProcess.lineage.startTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.context.modifyingProcess.lineage.userId
service.runtimeDetails.context.modifyingProcess.lineage.uuid
service.runtimeDetails.context.modifyingProcess.name
service.runtimeDetails.context.modifyingProcess.namespacePid
service.runtimeDetails.context.modifyingProcess.parentUuid
service.runtimeDetails.context.modifyingProcess.pid
service.runtimeDetails.context.modifyingProcess.pwd
service.runtimeDetails.context.modifyingProcess.startTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.context.modifyingProcess.user
service.runtimeDetails.context.modifyingProcess.userId
service.runtimeDetails.context.modifyingProcess.uuid
service.runtimeDetails.context.moduleFilePath
service.runtimeDetails.context.moduleName
service.runtimeDetails.context.moduleSha256
service.runtimeDetails.context.mountSource
service.runtimeDetails.context.mountTarget
service.runtimeDetails.context.relatedFilePaths
service.runtimeDetails.context.releaseAgentPath
service.runtimeDetails.context.runcBinaryPath
service.runtimeDetails.context.scriptPath
service.runtimeDetails.context.serviceName
service.runtimeDetails.context.shellHistoryFilePath
service.runtimeDetails.context.socketPath
service.runtimeDetails.context.targetProcess.euid
service.runtimeDetails.context.targetProcess.executablePath
service.runtimeDetails.context.targetProcess.executableSha256
service.runtimeDetails.context.targetProcess.lineage.euid
service.runtimeDetails.context.targetProcess.lineage.executablePath
service.runtimeDetails.context.targetProcess.lineage.name
service.runtimeDetails.context.targetProcess.lineage.namespacePid
service.runtimeDetails.context.targetProcess.lineage.parentUuid
service.runtimeDetails.context.targetProcess.lineage.pid
service.runtimeDetails.context.targetProcess.lineage.startTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.context.targetProcess.lineage.userId
service.runtimeDetails.context.targetProcess.lineage.uuid
service.runtimeDetails.context.targetProcess.name
service.runtimeDetails.context.targetProcess.namespacePid
service.runtimeDetails.context.targetProcess.parentUuid
service.runtimeDetails.context.targetProcess.pid
service.runtimeDetails.context.targetProcess.pwd
service.runtimeDetails.context.targetProcess.startTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.context.targetProcess.user
service.runtimeDetails.context.targetProcess.userId
service.runtimeDetails.context.targetProcess.uuid
service.runtimeDetails.context.threatFilePath
service.runtimeDetails.context.toolCategory
service.runtimeDetails.context.toolName
service.runtimeDetails.process.euid
service.runtimeDetails.process.executablePath
service.runtimeDetails.process.executableSha256
service.runtimeDetails.process.lineage.euid
service.runtimeDetails.process.lineage.executablePath
service.runtimeDetails.process.lineage.name
service.runtimeDetails.process.lineage.namespacePid
service.runtimeDetails.process.lineage.parentUuid
service.runtimeDetails.process.lineage.pid
service.runtimeDetails.process.lineage.startTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.process.lineage.userId
service.runtimeDetails.process.lineage.uuid
service.runtimeDetails.process.name
service.runtimeDetails.process.namespacePid
service.runtimeDetails.process.parentUuid
service.runtimeDetails.process.pid
service.runtimeDetails.process.pwd
service.runtimeDetails.process.startTime
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
service.runtimeDetails.process.user
service.runtimeDetails.process.userId
service.runtimeDetails.process.uuid
service.serviceName
service.userFeedback
severity
To configure severity based filters, use the following for the FindingCriteria condition:
Low: [\"1\", \"2\", \"3\"]
Medium: [\"4\", \"5\", \"6\"]
High: [\"7\", \"8\"]
Critical: [\"9\", \"10\"]
For more information, see Findings severity levels in the Amazon GuardDuty User Guide.
type
updatedAt
Type: Timestamp in Unix Epoch millisecond format. Ex: 1486685375000
The name of the filter.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateFindingsFeedback": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateFindingsFeedbackRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateFindingsFeedbackResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Marks the specified GuardDuty findings as useful or not useful.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/findings/feedback", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateFindingsFeedbackRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector that is associated with the findings for which you want to update the feedback.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The IDs of the findings that you want to mark as useful or not useful.
", + "smithy.api#jsonName": "findingIds", + "smithy.api#required": {} + } + }, + "Feedback": { + "target": "com.amazonaws.guardduty#Feedback", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The feedback for the finding.
", + "smithy.api#jsonName": "feedback", + "smithy.api#required": {} + } + }, + "Comments": { + "target": "com.amazonaws.guardduty#SensitiveString", + "traits": { + "smithy.api#documentation": "Additional feedback about the GuardDuty findings.
", + "smithy.api#jsonName": "comments" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateFindingsFeedbackResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateIPSetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the IPSet specified by the IPSet ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/ipset/{IpSetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateIPSetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detectorID that specifies the GuardDuty service whose IPSet you want to update.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique ID that specifies the IPSet that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#documentation": "The unique ID that specifies the IPSet that you want to update.
", + "smithy.api#jsonName": "name" + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#documentation": "The updated URI of the file that contains the IPSet.
", + "smithy.api#jsonName": "location" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "The updated Boolean value that specifies whether the IPSet is active or not.
", + "smithy.api#jsonName": "activate" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.
", + "smithy.api#jsonName": "expectedBucketOwner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateIPSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateMalwareProtectionPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateMalwareProtectionPlanRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + }, + { + "target": "com.amazonaws.guardduty#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Malware Protection plan resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/malware-protection-plan/{MalwareProtectionPlanId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateMalwareProtectionPlanRequest": { + "type": "structure", + "members": { + "MalwareProtectionPlanId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "A unique identifier associated with the Malware Protection plan.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the IAM role with permissions to scan and add tags to the associated protected resource.
", + "smithy.api#jsonName": "role" + } + }, + "Actions": { + "target": "com.amazonaws.guardduty#MalwareProtectionPlanActions", + "traits": { + "smithy.api#documentation": "Information about whether the tags will be added to the S3 object after scanning.
", + "smithy.api#jsonName": "actions" + } + }, + "ProtectedResource": { + "target": "com.amazonaws.guardduty#UpdateProtectedResource", + "traits": { + "smithy.api#documentation": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource.
Updates the malware scan settings.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/malware-scan-settings", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateMalwareScanSettingsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that specifies the GuardDuty service where you want to update scan settings.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
Represents the criteria to be used in the filter for selecting resources to scan.
", + "smithy.api#jsonName": "scanResourceCriteria" + } + }, + "EbsSnapshotPreservation": { + "target": "com.amazonaws.guardduty#EbsSnapshotPreservation", + "traits": { + "smithy.api#documentation": "An enum value representing possible snapshot preservation settings.
", + "smithy.api#jsonName": "ebsSnapshotPreservation" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateMalwareScanSettingsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateMemberDetectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateMemberDetectorsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateMemberDetectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Contains information on member accounts to be updated.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can add only one of these two features because Runtime Monitoring already includes the threat detection for Amazon EKS resources. For more information, see Runtime Monitoring.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member/detector/update", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateMemberDetectorsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detector ID of the administrator account.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
A list of member account IDs to be updated.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurations", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Describes which data sources will be updated.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#MemberFeaturesConfigurations", + "traits": { + "smithy.api#documentation": "A list of features that will be updated for the specified member accounts.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateMemberDetectorsResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of member account IDs that were unable to be processed along with an explanation for why they were not processed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateOrganizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateOrganizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateOrganizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Configures the delegated administrator account with the provided values. You must provide a value for either autoEnableOrganizationMembers or autoEnable, but not both.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can add only one of these two features because Runtime Monitoring already includes the threat detection for Amazon EKS resources. For more information, see Runtime Monitoring.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/admin", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateOrganizationConfigurationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector that configures the delegated administrator.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
Represents whether to automatically enable member accounts in the organization. This applies to only new member accounts, not the existing member accounts. When a new account joins the organization, the chosen features will be enabled for them by default.
Even though this is still supported, we recommend using AutoEnableOrganizationMembers to achieve the similar results. You must provide a value for either autoEnableOrganizationMembers or autoEnable.
Describes which data sources will be updated.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#OrganizationFeaturesConfigurations", + "traits": { + "smithy.api#documentation": "A list of features that will be configured for the organization.
", + "smithy.api#jsonName": "features" + } + }, + "AutoEnableOrganizationMembers": { + "target": "com.amazonaws.guardduty#AutoEnableMembers", + "traits": { + "smithy.api#documentation": "Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.
Use one of the following configuration values for autoEnableOrganizationMembers:
NEW: Indicates that when a new account joins the organization, they will have GuardDuty enabled automatically.
ALL: Indicates that all accounts in the organization have GuardDuty enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
NONE: Indicates that GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.
When you update the auto-enable setting from ALL or NEW to NONE, this action doesn't disable the corresponding option for your existing accounts. This configuration will apply to the new accounts that join the organization. After you update the auto-enable settings, no new account will have the corresponding option as enabled.
Information about the protected S3 bucket resource.
", + "smithy.api#jsonName": "s3Bucket" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource.
Updates information about the publishing destination specified by the destinationId.
The ID of the detector associated with the publishing destinations to update.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The ID of the publishing destination to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DestinationProperties": { + "target": "com.amazonaws.guardduty#DestinationProperties", + "traits": { + "smithy.api#documentation": "A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.
Information about the specified object prefixes. The S3 object will be scanned only if it belongs to any of the specified object prefixes.
", + "smithy.api#jsonName": "objectPrefixes" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the protected S3 bucket resource.
" + } + }, + "com.amazonaws.guardduty#UpdateThreatEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateThreatEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateThreatEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the threat entity set associated with the specified threatEntitySetId.
The unique ID of the GuardDuty detector associated with the threat entity set that you want to update.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The ID returned by GuardDuty after updating the threat entity set resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#documentation": "A user-friendly name to identify the trusted entity set.
The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).
", + "smithy.api#jsonName": "name" + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#documentation": "The URI of the file that contains the trusted entity set.
", + "smithy.api#jsonName": "location" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#ExpectedBucketOwner", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.
", + "smithy.api#jsonName": "expectedBucketOwner" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "A boolean value that indicates whether GuardDuty is to start using this updated threat entity set. After you update an entity set, you will need to activate it again. It might take up to 15 minutes for the updated entity set to be effective.
", + "smithy.api#jsonName": "activate" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateThreatEntitySetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateThreatIntelSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateThreatIntelSetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateThreatIntelSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the ThreatIntelSet specified by the ThreatIntelSet ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/threatintelset/{ThreatIntelSetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateThreatIntelSetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The unique ID that specifies the ThreatIntelSet that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#documentation": "The unique ID that specifies the ThreatIntelSet that you want to update.
", + "smithy.api#jsonName": "name" + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#documentation": "The updated URI of the file that contains the ThreateIntelSet.
", + "smithy.api#jsonName": "location" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "The updated Boolean value that specifies whether the ThreateIntelSet is active or not.
", + "smithy.api#jsonName": "activate" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.
", + "smithy.api#jsonName": "expectedBucketOwner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateThreatIntelSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateTrustedEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateTrustedEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateTrustedEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the trusted entity set associated with the specified trustedEntitySetId.
The unique ID of the GuardDuty detector associated with the threat entity set that you want to update.
To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
The ID returned by GuardDuty after updating the trusted entity set resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#documentation": "A user-friendly name to identify the trusted entity set.
The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).
", + "smithy.api#jsonName": "name" + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#documentation": "The URI of the file that contains the trusted entity set.
", + "smithy.api#jsonName": "location" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#ExpectedBucketOwner", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.
", + "smithy.api#jsonName": "expectedBucketOwner" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "A boolean value that indicates whether GuardDuty is to start using this updated trusted entity set. After you update an entity set, you will need to activate it again. It might take up to 15 minutes for the updated entity set to be effective.
", + "smithy.api#jsonName": "activate" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateTrustedEntitySetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UsageAccountResult": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The Account ID that generated usage.
", + "smithy.api#jsonName": "accountId" + } + }, + "Total": { + "target": "com.amazonaws.guardduty#Total", + "traits": { + "smithy.api#documentation": "Represents the total of usage for the Account ID.
", + "smithy.api#jsonName": "total" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the total of usage based on account IDs.
" + } + }, + "com.amazonaws.guardduty#UsageAccountResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageAccountResult" + } + }, + "com.amazonaws.guardduty#UsageCriteria": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#documentation": "The account IDs to aggregate usage statistics from.
", + "smithy.api#jsonName": "accountIds" + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceList", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "The data sources to aggregate usage statistics from.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Resources": { + "target": "com.amazonaws.guardduty#ResourceList", + "traits": { + "smithy.api#documentation": "The resources to aggregate usage statistics from. Only accepts exact resource names.
", + "smithy.api#jsonName": "resources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#UsageFeatureList", + "traits": { + "smithy.api#documentation": "The features to aggregate usage statistics from.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the criteria used to query usage statistics.
" + } + }, + "com.amazonaws.guardduty#UsageDataSourceResult": { + "type": "structure", + "members": { + "DataSource": { + "target": "com.amazonaws.guardduty#DataSource", + "traits": { + "smithy.api#documentation": "The data source type that generated usage.
", + "smithy.api#jsonName": "dataSource" + } + }, + "Total": { + "target": "com.amazonaws.guardduty#Total", + "traits": { + "smithy.api#documentation": "Represents the total of usage for the specified data source.
", + "smithy.api#jsonName": "total" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the result of usage based on data source type.
" + } + }, + "com.amazonaws.guardduty#UsageDataSourceResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageDataSourceResult" + } + }, + "com.amazonaws.guardduty#UsageFeature": { + "type": "enum", + "members": { + "FLOW_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOW_LOGS" + } + }, + "CLOUD_TRAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUD_TRAIL" + } + }, + "DNS_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DNS_LOGS" + } + }, + "S3_DATA_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_DATA_EVENTS" + } + }, + "EKS_AUDIT_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_AUDIT_LOGS" + } + }, + "EBS_MALWARE_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" + } + }, + "RDS_LOGIN_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_LOGIN_EVENTS" + } + }, + "LAMBDA_NETWORK_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" + } + }, + "EKS_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" + } + }, + "EC2_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_RUNTIME_MONITORING" + } + }, + "FARGATE_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FARGATE_RUNTIME_MONITORING" + } + }, + "RDS_DBI_PROTECTION_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_DBI_PROTECTION_PROVISIONED" + } + }, + "RDS_DBI_PROTECTION_SERVERLESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_DBI_PROTECTION_SERVERLESS" + } + }, + "AI_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AI_PROTECTION" + } + } + } + }, + "com.amazonaws.guardduty#UsageFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageFeature" + } + }, + "com.amazonaws.guardduty#UsageFeatureResult": { + "type": "structure", + "members": { + "Feature": { + "target": "com.amazonaws.guardduty#UsageFeature", + "traits": { + "smithy.api#documentation": "The feature that generated the usage cost.
", + "smithy.api#jsonName": "feature" + } + }, + "Total": { + "target": "com.amazonaws.guardduty#Total", + "traits": { + "smithy.api#jsonName": "total" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the result of the total usage based on the feature.
" + } + }, + "com.amazonaws.guardduty#UsageFeatureResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageFeatureResult" + } + }, + "com.amazonaws.guardduty#UsageResourceResult": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services resource that generated usage.
", + "smithy.api#jsonName": "resource" + } + }, + "Total": { + "target": "com.amazonaws.guardduty#Total", + "traits": { + "smithy.api#documentation": "Represents the sum total of usage for the specified resource type.
", + "smithy.api#jsonName": "total" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the sum of usage based on an Amazon Web Services resource.
" + } + }, + "com.amazonaws.guardduty#UsageResourceResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageResourceResult" + } + }, + "com.amazonaws.guardduty#UsageStatisticType": { + "type": "enum", + "members": { + "SUM_BY_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM_BY_ACCOUNT" + } + }, + "SUM_BY_DATA_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM_BY_DATA_SOURCE" + } + }, + "SUM_BY_RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM_BY_RESOURCE" + } + }, + "TOP_RESOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP_RESOURCES" + } + }, + "SUM_BY_FEATURES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM_BY_FEATURES" + } + }, + "TOP_ACCOUNTS_BY_FEATURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP_ACCOUNTS_BY_FEATURE" + } + } + } + }, + "com.amazonaws.guardduty#UsageStatistics": { + "type": "structure", + "members": { + "SumByAccount": { + "target": "com.amazonaws.guardduty#UsageAccountResultList", + "traits": { + "smithy.api#documentation": "The usage statistic sum organized by account ID.
", + "smithy.api#jsonName": "sumByAccount" + } + }, + "TopAccountsByFeature": { + "target": "com.amazonaws.guardduty#UsageTopAccountsResultList", + "traits": { + "smithy.api#documentation": "Lists the top 50 accounts by feature that have generated the most GuardDuty usage, in the order from most to least expensive.
Currently, this doesn't support RDS_LOGIN_EVENTS.
The usage statistic sum organized by on data source.
", + "smithy.api#jsonName": "sumByDataSource" + } + }, + "SumByResource": { + "target": "com.amazonaws.guardduty#UsageResourceResultList", + "traits": { + "smithy.api#documentation": "The usage statistic sum organized by resource.
", + "smithy.api#jsonName": "sumByResource" + } + }, + "TopResources": { + "target": "com.amazonaws.guardduty#UsageResourceResultList", + "traits": { + "smithy.api#documentation": "Lists the top 50 resources that have generated the most GuardDuty usage, in order from most to least expensive.
", + "smithy.api#jsonName": "topResources" + } + }, + "SumByFeature": { + "target": "com.amazonaws.guardduty#UsageFeatureResultList", + "traits": { + "smithy.api#documentation": "The usage statistic sum organized by feature.
", + "smithy.api#jsonName": "sumByFeature" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the result of GuardDuty usage. If a UsageStatisticType is provided the result for other types will be null.
" + } + }, + "com.amazonaws.guardduty#UsageTopAccountResult": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The unique account ID.
", + "smithy.api#jsonName": "accountId" + } + }, + "Total": { + "target": "com.amazonaws.guardduty#Total", + "traits": { + "smithy.api#jsonName": "total" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the total of usage based on the topmost 50 account IDs.
" + } + }, + "com.amazonaws.guardduty#UsageTopAccountsByFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageTopAccountResult" + } + }, + "com.amazonaws.guardduty#UsageTopAccountsResult": { + "type": "structure", + "members": { + "Feature": { + "target": "com.amazonaws.guardduty#UsageFeature", + "traits": { + "smithy.api#documentation": "Features by which you can generate the usage statistics.
RDS_LOGIN_EVENTS is currently not supported with topAccountsByFeature.
The accounts that contributed to the total usage cost.
", + "smithy.api#jsonName": "accounts" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the usage statistics, calculated by top accounts by feature.
" + } + }, + "com.amazonaws.guardduty#UsageTopAccountsResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageTopAccountsResult" + } + }, + "com.amazonaws.guardduty#User": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the user.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Uid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the user.
", + "smithy.api#jsonName": "uid", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of the user.
", + "smithy.api#jsonName": "type", + "smithy.api#required": {} + } + }, + "CredentialUid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The credentials of the user ID.
", + "smithy.api#jsonName": "credentialUid" + } + }, + "Account": { + "target": "com.amazonaws.guardduty#Account", + "traits": { + "smithy.api#documentation": "Contains information about the Amazon Web Services account within which the activity took place. This is not necessarily the account that owns the user identity.
", + "smithy.api#jsonName": "account" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the user involved in the attack sequence.
" + } + }, + "com.amazonaws.guardduty#Volume": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Volume name.
", + "smithy.api#jsonName": "name" + } + }, + "HostPath": { + "target": "com.amazonaws.guardduty#HostPath", + "traits": { + "smithy.api#documentation": "Represents a pre-existing file or directory on the host machine that the volume maps to.
", + "smithy.api#jsonName": "hostPath" + } + } + }, + "traits": { + "smithy.api#documentation": "Volume used by the Kubernetes workload.
" + } + }, + "com.amazonaws.guardduty#VolumeDetail": { + "type": "structure", + "members": { + "VolumeArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EBS volume ARN information.
", + "smithy.api#jsonName": "volumeArn" + } + }, + "VolumeType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The EBS volume type.
", + "smithy.api#jsonName": "volumeType" + } + }, + "DeviceName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The device name for the EBS volume.
", + "smithy.api#jsonName": "deviceName" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "EBS volume size in GB.
", + "smithy.api#jsonName": "volumeSizeInGB" + } + }, + "EncryptionType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EBS volume encryption type.
", + "smithy.api#jsonName": "encryptionType" + } + }, + "SnapshotArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Snapshot ARN of the EBS volume.
", + "smithy.api#jsonName": "snapshotArn" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "KMS key ARN used to encrypt the EBS volume.
", + "smithy.api#jsonName": "kmsKeyArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains EBS volume details.
" + } + }, + "com.amazonaws.guardduty#VolumeDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#VolumeDetail" + } + }, + "com.amazonaws.guardduty#VolumeMount": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Volume mount name.
", + "smithy.api#jsonName": "name" + } + }, + "MountPath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Volume mount path.
", + "smithy.api#jsonName": "mountPath" + } + } + }, + "traits": { + "smithy.api#documentation": "Container volume mount.
" + } + }, + "com.amazonaws.guardduty#VolumeMounts": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#VolumeMount" + } + }, + "com.amazonaws.guardduty#Volumes": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Volume" + } + }, + "com.amazonaws.guardduty#VpcConfig": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.guardduty#SubnetIds", + "traits": { + "smithy.api#documentation": "The identifiers of the subnets that are associated with your Lambda function.
", + "smithy.api#jsonName": "subnetIds" + } + }, + "VpcId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Virtual Private Cloud.
", + "smithy.api#jsonName": "vpcId" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.guardduty#SecurityGroups", + "traits": { + "smithy.api#documentation": "The identifier of the security group attached to the Lambda function.
", + "smithy.api#jsonName": "securityGroups" + } + } + }, + "traits": { + "smithy.api#documentation": "Amazon Virtual Private Cloud configuration details associated with your Lambda function.
" + } + } + } +} \ No newline at end of file diff --git a/codegen/aws-models/lambda.json b/codegen/aws-models/lambda.json new file mode 100644 index 0000000..4d6e5f6 --- /dev/null +++ b/codegen/aws-models/lambda.json @@ -0,0 +1,27085 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.lambda#AWSGirApiService": { + "type": "service", + "version": "2015-03-31", + "operations": [ + { + "target": "com.amazonaws.lambda#DeleteFunction" + }, + { + "target": "com.amazonaws.lambda#DeleteFunctionEventInvokeConfig" + }, + { + "target": "com.amazonaws.lambda#GetAccountSettings" + }, + { + "target": "com.amazonaws.lambda#GetFunctionEventInvokeConfig" + }, + { + "target": "com.amazonaws.lambda#ListFunctionEventInvokeConfigs" + }, + { + "target": "com.amazonaws.lambda#ListTags" + }, + { + "target": "com.amazonaws.lambda#PutFunctionEventInvokeConfig" + }, + { + "target": "com.amazonaws.lambda#SendDurableExecutionCallbackFailure" + }, + { + "target": "com.amazonaws.lambda#SendDurableExecutionCallbackHeartbeat" + }, + { + "target": "com.amazonaws.lambda#SendDurableExecutionCallbackSuccess" + }, + { + "target": "com.amazonaws.lambda#TagResource" + }, + { + "target": "com.amazonaws.lambda#UntagResource" + }, + { + "target": "com.amazonaws.lambda#UpdateFunctionEventInvokeConfig" + } + ], + "resources": [ + { + "target": "com.amazonaws.lambda#CapacityProviderResource" + }, + { + "target": "com.amazonaws.lambda#CodeSigningConfigResource" + }, + { + "target": "com.amazonaws.lambda#DurableExecution" + }, + { + "target": "com.amazonaws.lambda#EventSourceMapping" + }, + { + "target": "com.amazonaws.lambda#Function" + }, + { + "target": "com.amazonaws.lambda#FunctionAlias" + }, + { + "target": "com.amazonaws.lambda#FunctionVersionResource" + }, + { + "target": "com.amazonaws.lambda#LayerResource" + }, + { + "target": "com.amazonaws.lambda#LayerVersion" + }, + { + "target": "com.amazonaws.lambda#Permission" + }, + { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyConfig" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Lambda", + "arnNamespace": "lambda", + "cloudFormationName": "Lambda", + "cloudTrailEventSource": "lambda.amazonaws.com", + "endpointPrefix": "lambda" + }, + "aws.api#tagEnabled": { + "disableDefaultOperations": true + }, + "aws.auth#sigv4": { + "name": "lambda" + }, + "aws.iam#defineConditionKeys": { + "lambda:VpcIds": { + "type": "String", + "documentation": "Filters access by the ID of the VPC configured for the AWS Lambda function", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:SubnetIds": { + "type": "ArrayOfString", + "documentation": "Filters access by the ID of subnets configured for the AWS Lambda function", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:Layer": { + "type": "ArrayOfString", + "documentation": "Filters access by the ARN of a version of an AWS Lambda layer", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:EventSourceToken": { + "type": "String", + "documentation": "Filters access by the ID from a non-AWS event source configured for the AWS Lambda function", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:FunctionUrlAuthType": { + "type": "String", + "documentation": "Filters access by authorization type specified in request. Available during CreateFunctionUrlConfig, UpdateFunctionUrlConfig, DeleteFunctionUrlConfig, GetFunctionUrlConfig, ListFunctionUrlConfig, AddPermission and RemovePermission operations", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the tags that are passed in the request", + "externalDocumentation": "${DocHomeURL}/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag", + "required": false + }, + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the tags associated with the resource", + "externalDocumentation": "${DocHomeURL}/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag", + "required": false + }, + "lambda:CodeSigningConfigArn": { + "type": "ARN", + "documentation": "Filters access by the ARN of an AWS Lambda code signing config", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:FunctionArn": { + "type": "ARN", + "documentation": "Filters access by the ARN of an AWS Lambda function", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by the tag keys that are passed in the request", + "externalDocumentation": "${DocHomeURL}/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys", + "required": false + }, + "lambda:SourceFunctionArn": { + "type": "ARN", + "documentation": "Filters access by the ARN of the AWS Lambda function from which the request originated", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:SecurityGroupIds": { + "type": "ArrayOfString", + "documentation": "Filters access by the ID of security groups configured for the AWS Lambda function", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:Principal": { + "type": "String", + "documentation": "Filters access by restricting the AWS service or account that can invoke a function", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + } + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Overview
Lambda is a compute service that lets you run code without provisioning or managing servers. Lambda runs your code on a high-availability compute infrastructure and performs all of the administration of the compute resources, including server and operating system maintenance, capacity provisioning and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.
The Lambda API Reference provides information about each of the API methods, including details about the parameters in each API request and response.
You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools to access the API. For installation instructions, see Tools for Amazon Web Services.
For a list of Region-specific endpoints that Lambda supports, see Lambda endpoints and quotas in the Amazon Web Services General Reference..
When making the API calls, you will need to authenticate your request by providing a signature. Lambda supports signature version 4. For more information, see Signature Version 4 signing process in the Amazon Web Services General Reference..
CA certificates
Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate environment and do not manage your own computer, you might need to ask an administrator to assist with the update process. The following list shows minimum operating system and Java versions:
Microsoft Windows versions that have updates from January 2005 or later installed contain at least one of the required CAs in their trust list.
Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and later versions contain at least one of the required CAs in their trust list.
Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the required CAs in their default trusted CA list.
Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list.
When accessing the Lambda management console or Lambda API endpoints, whether through browsers or programmatically, you will need to ensure your client machines support any of the following CAs:
Amazon Root CA 1
Starfield Services Root Certificate Authority - G2
Starfield Class 2 Certification Authority
Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "pageSize": "MaxItems" + }, + "smithy.api#suppress": [ + "ServiceTagging" + ], + "smithy.api#tags": [ + "feature:public" + ], + "smithy.api#title": "AWS Lambda", + "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 + ] + } + ], + "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://lambda-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://lambda-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://lambda.{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://lambda.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 13, + "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" + }, + "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://lambda-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": [], + "endpoint": { + "url": "https://lambda-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://lambda.{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://lambda.{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://lambda.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.af-south-1.api.aws" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-east-1.api.aws" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-northeast-1.api.aws" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-northeast-2.api.aws" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-northeast-3.api.aws" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-south-1.api.aws" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-southeast-1.api.aws" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-southeast-2.api.aws" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.ca-central-1.api.aws" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-central-1.api.aws" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-north-1.api.aws" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-south-1.api.aws" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-west-1.api.aws" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-west-2.api.aws" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.eu-west-3.api.aws" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.me-south-1.api.aws" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.sa-east-1.api.aws" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.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://lambda-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.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://lambda-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.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://lambda-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-west-1.api.aws" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.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://lambda-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-west-2.api.aws" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda-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://lambda-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.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://lambda-fips.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://lambda-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 disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda-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 disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lambda-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "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.lambda#AccountLimit": { + "type": "structure", + "members": { + "TotalCodeSize": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The amount of storage space that you can use for all deployment packages and layer archives.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSizeUnzipped": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum size of a function's deployment package and layers when they're extracted.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSizeZipped": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum size of a deployment package when it's uploaded directly to Lambda. Use Amazon S3 for larger files.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ConcurrentExecutions": { + "target": "com.amazonaws.lambda#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of simultaneous function executions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "UnreservedConcurrentExecutions": { + "target": "com.amazonaws.lambda#UnreservedConcurrentExecutions", + "traits": { + "smithy.api#documentation": "The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with PutFunctionConcurrency.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Limits that are related to concurrency and storage. All file and storage sizes are in bytes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AccountUsage": { + "type": "structure", + "members": { + "TotalCodeSize": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The amount of storage space, in bytes, that's being used by deployment packages and layer archives.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionCount": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of Lambda functions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The number of functions and amount of storage in use.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Action": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + }, + "smithy.api#pattern": "^(lambda:[*]|lambda:[a-zA-Z]+|[*])$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AddLayerVersionPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#AddLayerVersionPermissionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#AddLayerVersionPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PolicyLengthExceededException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to add permissions to the resource-based policy of a version of an AWS Lambda layer", + "relativeDocumentation": "API_AddLayerVersionPermission.html", + "resources": { + "required": { + "layerVersion": {} + } + } + }, + "smithy.api#documentation": "Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts.
To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
", + "smithy.api#examples": [ + { + "documentation": "The following example grants permission for the account 223456789012 to use version 1 of a layer named my-layer.", + "input": { + "Action": "lambda:GetLayerVersion", + "LayerName": "my-layer", + "Principal": "223456789012", + "StatementId": "xaccount", + "VersionNumber": 1 + }, + "output": { + "RevisionId": "35d87451-f796-4a3f-a618-95a3671b0a0c", + "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:GetLayerVersion\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1\"}" + }, + "title": "To add permissions to a layer version" + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", + "code": 201 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AddLayerVersionPermissionRequest": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the layer.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VersionNumber": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The version number.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StatementId": { + "target": "com.amazonaws.lambda#StatementId", + "traits": { + "smithy.api#documentation": "An identifier that distinguishes the policy from others on the same layer version.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Action": { + "target": "com.amazonaws.lambda#LayerPermissionAllowedAction", + "traits": { + "smithy.api#documentation": "The API action that grants access to the layer. For example, lambda:GetLayerVersion.
An account ID, or * to grant layer usage permission to all accounts in an organization, or all Amazon Web Services accounts (if organizationId is not specified). For the last case, make sure that you really do want all Amazon Web Services accounts to have usage permission to this layer.
With the principal set to *, grant permission to all accounts in the specified organization.
Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
", + "smithy.api#httpQuery": "RevisionId", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "aws.api#data": "permissions", + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AddLayerVersionPermissionResponse": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The permission statement.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "A unique identifier for the current revision of the policy.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AddPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#AddPermissionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#AddPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PolicyLengthExceededException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#PublicPolicyException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:FunctionUrlAuthType", + "lambda:Principal" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to give an AWS service or another account permission to use an AWS Lambda function", + "relativeDocumentation": "API_AddPermission.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Grants a principal permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.
To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.
", + "smithy.api#examples": [ + { + "documentation": "The following example adds permission for Amazon S3 to invoke a Lambda function named my-function for notifications from a bucket named my-bucket-1xpuxmplzrlbh in account 123456789012.", + "input": { + "Action": "lambda:InvokeFunction", + "FunctionName": "my-function", + "Principal": "s3.amazonaws.com", + "SourceAccount": "123456789012", + "SourceArn": "arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*", + "StatementId": "s3" + }, + "output": { + "Statement": "{\"Sid\":\"s3\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"s3.amazonaws.com\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\",\"Condition\":{\"StringEquals\":{\"AWS:SourceAccount\":\"123456789012\"},\"ArnLike\":{\"AWS:SourceArn\":\"arn:aws:s3:::my-bucket-1xpuxmplzrlbh\"}}}" + }, + "title": "To grant Amazon S3 permission to invoke a function" + }, + { + "documentation": "The following example adds permission for account 223456789012 invoke a Lambda function named my-function.", + "input": { + "Action": "lambda:InvokeFunction", + "FunctionName": "my-function", + "Principal": "223456789012", + "StatementId": "xaccount" + }, + "output": { + "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\"}" + }, + "title": "To grant another account permission to invoke a function" + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2015-03-31/functions/{FunctionName}/policy", + "code": 201 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AddPermissionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
Name formats
Function name – my-function (name-only), my-function:v1 (with alias).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StatementId": { + "target": "com.amazonaws.lambda#StatementId", + "traits": { + "smithy.api#documentation": "A statement identifier that differentiates the statement from others in the same policy.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Action": { + "target": "com.amazonaws.lambda#Action", + "traits": { + "smithy.api#documentation": "The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.
The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
Note that Lambda configures the comparison using the StringLike operator.
The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.
Indicates whether the permission applies when the function is invoked through a function URL.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SourceAccount": { + "target": "com.amazonaws.lambda#SourceOwner", + "traits": { + "smithy.api#documentation": "For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.
For Alexa Smart Home functions, a token that the invoker must supply.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "Specify a version or alias to add permissions to a published version of the function.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PrincipalOrgID": { + "target": "com.amazonaws.lambda#PrincipalOrgID", + "traits": { + "smithy.api#documentation": "The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "aws.api#data": "permissions", + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AddPermissionResponse": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The permission statement that's added to the function policy.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AdditionalVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[0-9]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AdditionalVersionWeights": { + "type": "map", + "key": { + "target": "com.amazonaws.lambda#AdditionalVersion", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "value": { + "target": "com.amazonaws.lambda#Weight", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Alias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!^[0-9]+$)([a-zA-Z0-9-_]+)$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AliasConfiguration": { + "type": "structure", + "members": { + "AliasArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Name": { + "target": "com.amazonaws.lambda#Alias", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionVersion": { + "target": "com.amazonaws.lambda#Version", + "traits": { + "smithy.api#documentation": "The function version that the alias invokes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "A description of the alias.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RoutingConfig": { + "target": "com.amazonaws.lambda#AliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "The routing configuration of the alias.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "A unique identifier that changes when you update the alias.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Provides configuration information about a Lambda function alias.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AliasLimitExceededException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda couldn't create the alias because your Amazon Web Services account has exceeded the maximum number of aliases allowed per Lambda function. For more information, see Lambda quotas.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AliasList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#AliasConfiguration", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AliasRoutingConfiguration": { + "type": "structure", + "members": { + "AdditionalVersionWeights": { + "target": "com.amazonaws.lambda#AdditionalVersionWeights", + "traits": { + "smithy.api#documentation": "The second version, and the percentage of traffic that's routed to it.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The traffic-shifting configuration of a Lambda function alias.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AllowCredentials": { + "type": "boolean", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AllowMethodsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Method", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AllowOriginsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Origin", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AllowedPublishers": { + "type": "structure", + "members": { + "SigningProfileVersionArns": { + "target": "com.amazonaws.lambda#SigningProfileVersionArns", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "List of signing profiles that can sign a code package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AmazonManagedKafkaEventSourceConfig": { + "type": "structure", + "members": { + "ConsumerGroupId": { + "target": "com.amazonaws.lambda#URI", + "traits": { + "smithy.api#documentation": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SchemaRegistryConfig": { + "target": "com.amazonaws.lambda#KafkaSchemaRegistryConfig", + "traits": { + "smithy.api#documentation": "Specific configuration settings for a Kafka schema registry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ApplicationLogLevel": { + "type": "enum", + "members": { + "Trace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRACE", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Debug": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Info": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Warn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARN", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Fatal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FATAL", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Architecture": { + "type": "enum", + "members": { + "x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_64", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "arm64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arm64", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ArchitecturesList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Architecture", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#AttemptCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#BatchSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#BinaryOperationPayload": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 262144 + }, + "smithy.api#sensitive": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#BisectBatchOnFunctionError": { + "type": "boolean", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Blob": { + "type": "blob", + "traits": { + "smithy.api#sensitive": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#BlobStream": { + "type": "blob", + "traits": { + "smithy.api#streaming": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CallbackDetails": { + "type": "structure", + "members": { + "CallbackId": { + "target": "com.amazonaws.lambda#CallbackId", + "traits": { + "smithy.api#documentation": "The callback ID. Callback IDs are generated by the DurableContext when a durable function calls ctx.waitForCallback.
The response payload from the callback operation as a string.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Error": { + "target": "com.amazonaws.lambda#ErrorObject", + "traits": { + "smithy.api#documentation": "An error object that contains details about the failure.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a callback operation in a durable execution, including the callback token and timeout configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CallbackFailedDetails": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.lambda#EventError", + "traits": { + "smithy.api#documentation": "An error object that contains details about the failure.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a failed callback operation, including error information and the reason for failure.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CallbackId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[A-Za-z0-9+/]+={0,2}$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CallbackOptions": { + "type": "structure", + "members": { + "TimeoutSeconds": { + "target": "com.amazonaws.lambda#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The timeout for the callback operation in seconds. If not specified or set to 0, the callback has no timeout.
", + "smithy.api#range": { + "min": 0, + "max": 99999999 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "HeartbeatTimeoutSeconds": { + "target": "com.amazonaws.lambda#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The heartbeat timeout for the callback operation, in seconds. If not specified or set to 0, heartbeat timeout is disabled.
", + "smithy.api#range": { + "min": 0, + "max": 99999999 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration options for callback operations in durable executions, including timeout settings and retry behavior.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CallbackStartedDetails": { + "type": "structure", + "members": { + "CallbackId": { + "target": "com.amazonaws.lambda#CallbackId", + "traits": { + "smithy.api#documentation": "The callback ID. Callback IDs are generated by the DurableContext when a durable function calls ctx.waitForCallback.
The heartbeat timeout value, in seconds.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Timeout": { + "target": "com.amazonaws.lambda#DurationSeconds", + "traits": { + "smithy.api#documentation": "The timeout value, in seconds.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a callback operation that has started, including timing information and callback metadata.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CallbackSucceededDetails": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.lambda#EventResult", + "traits": { + "smithy.api#documentation": "The response payload from the successful operation.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a successfully completed callback operation, including the result data and completion timestamp.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CallbackTimedOutDetails": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.lambda#EventError", + "traits": { + "smithy.api#documentation": "Details about the callback timeout.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a callback operation that timed out, including timeout duration and any partial results.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CallbackTimeoutException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The callback ID token has either expired or the callback associated with the token has already been closed.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProvider": { + "type": "structure", + "members": { + "CapacityProviderArn": { + "target": "com.amazonaws.lambda#CapacityProviderArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the capacity provider.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "State": { + "target": "com.amazonaws.lambda#CapacityProviderState", + "traits": { + "smithy.api#documentation": "The current state of the capacity provider.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VpcConfig": { + "target": "com.amazonaws.lambda#CapacityProviderVpcConfig", + "traits": { + "smithy.api#documentation": "The VPC configuration for the capacity provider.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PermissionsConfig": { + "target": "com.amazonaws.lambda#CapacityProviderPermissionsConfig", + "traits": { + "smithy.api#documentation": "The permissions configuration for the capacity provider.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.lambda#InstanceRequirements", + "traits": { + "smithy.api#documentation": "The instance requirements for compute resources managed by the capacity provider.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CapacityProviderScalingConfig": { + "target": "com.amazonaws.lambda#CapacityProviderScalingConfig", + "traits": { + "smithy.api#documentation": "The scaling configuration for the capacity provider.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key used to encrypt the capacity provider's resources.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the capacity provider was last modified.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PropagateTags": { + "target": "com.amazonaws.lambda#PropagateTags", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TelemetryConfig": { + "target": "com.amazonaws.lambda#CapacityProviderTelemetryConfig", + "traits": { + "smithy.api#documentation": "The telemetry configuration for the capacity provider, including logging settings.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "A capacity provider manages compute resources for Lambda functions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:capacity-provider:[a-zA-Z0-9-_]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderConfig": { + "type": "structure", + "members": { + "LambdaManagedInstancesCapacityProviderConfig": { + "target": "com.amazonaws.lambda#LambdaManagedInstancesCapacityProviderConfig", + "traits": { + "smithy.api#documentation": "Configuration for Lambda-managed instances used by the capacity provider.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for the capacity provider that manages compute resources for Lambda functions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderLimitExceededException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The maximum number of capacity providers for your account has been exceeded. For more information, see Lambda quotas
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderLoggingConfig": { + "type": "structure", + "members": { + "SystemLogLevel": { + "target": "com.amazonaws.lambda#SystemLogLevel", + "traits": { + "smithy.api#documentation": "Set this property to filter the system logs for your capacity provider that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.
The name of the Amazon CloudWatch log group the capacity provider sends logs to. By default, Lambda capacity providers send logs to a default log group named /aws/lambda/capacity-provider/<capacity provider name>. To use a different log group, enter an existing log group or enter a new log group name.
The capacity provider's Amazon CloudWatch Logs configuration settings.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderMaxVCpuCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 2, + "max": 15000 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^(arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:capacity-provider:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderPermissionsConfig": { + "type": "structure", + "members": { + "CapacityProviderOperatorRoleArn": { + "target": "com.amazonaws.lambda#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that the capacity provider uses to manage compute instances and other Amazon Web Services resources.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration that specifies the permissions required for the capacity provider to manage compute resources.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderPredefinedMetricType": { + "type": "enum", + "members": { + "LambdaCapacityProviderAverageCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LambdaCapacityProviderAverageCPUUtilization", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderResource": { + "type": "resource", + "identifiers": { + "CapacityProviderName": { + "target": "com.amazonaws.lambda#CapacityProviderName" + } + }, + "put": { + "target": "com.amazonaws.lambda#CreateCapacityProvider" + }, + "read": { + "target": "com.amazonaws.lambda#GetCapacityProvider" + }, + "update": { + "target": "com.amazonaws.lambda#UpdateCapacityProvider" + }, + "delete": { + "target": "com.amazonaws.lambda#DeleteCapacityProvider" + }, + "list": { + "target": "com.amazonaws.lambda#ListCapacityProviders" + }, + "operations": [ + { + "target": "com.amazonaws.lambda#ListFunctionVersionsByCapacityProvider" + } + ], + "traits": { + "aws.api#arn": { + "template": "capacity-provider:{CapacityProviderName}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "capacityProvider", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "Represents an AWS Lambda capacity provider", + "smithy.api#suppress": [ + "IamResourceTrait" + ], + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderScalingConfig": { + "type": "structure", + "members": { + "MaxVCpuCount": { + "target": "com.amazonaws.lambda#CapacityProviderMaxVCpuCount", + "traits": { + "smithy.api#documentation": "The maximum number of vCPUs that the capacity provider can provision across all compute instances.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ScalingMode": { + "target": "com.amazonaws.lambda#CapacityProviderScalingMode", + "traits": { + "smithy.api#documentation": "The scaling mode that determines how the capacity provider responds to changes in demand.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ScalingPolicies": { + "target": "com.amazonaws.lambda#CapacityProviderScalingPoliciesList", + "traits": { + "smithy.api#documentation": "A list of scaling policies that define how the capacity provider scales compute instances based on metrics and thresholds.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration that defines how the capacity provider scales compute instances based on demand and policies.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderScalingMode": { + "type": "enum", + "members": { + "Auto": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Auto", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Manual": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Manual", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderScalingPoliciesList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#TargetTrackingScalingPolicy", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#SecurityGroupId", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderState": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderSubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#SubnetId", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderTelemetryConfig": { + "type": "structure", + "members": { + "LoggingConfig": { + "target": "com.amazonaws.lambda#CapacityProviderLoggingConfig", + "traits": { + "smithy.api#documentation": "The capacity provider's Amazon CloudWatch Logs configuration settings.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration that specifies the telemetry collection for the capacity provider.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProviderVpcConfig": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.lambda#CapacityProviderSubnetIds", + "traits": { + "smithy.api#documentation": "A list of subnet IDs where the capacity provider launches compute instances.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.lambda#CapacityProviderSecurityGroupIds", + "traits": { + "smithy.api#documentation": "A list of security group IDs that control network access for compute instances managed by the capacity provider.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "VPC configuration that specifies the network settings for compute instances managed by the capacity provider.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CapacityProvidersList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#CapacityProvider", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ChainedInvokeDetails": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.lambda#OperationPayload", + "traits": { + "smithy.api#documentation": "The response payload from the chained invocation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Error": { + "target": "com.amazonaws.lambda#ErrorObject", + "traits": { + "smithy.api#documentation": "Details about the chained invocation failure.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a chained function invocation in a durable execution, including the target function and invocation parameters.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ChainedInvokeFailedDetails": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.lambda#EventError", + "traits": { + "smithy.api#documentation": "Details about the chained invocation failure.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a failed chained function invocation, including error information and failure reason.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ChainedInvokeOptions": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function to invoke.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TenantId": { + "target": "com.amazonaws.lambda#TenantId", + "traits": { + "smithy.api#documentation": "The tenant identifier for the chained invocation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration options for chained function invocations in durable executions, including retry settings and timeout configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ChainedInvokeStartedDetails": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function being invoked.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TenantId": { + "target": "com.amazonaws.lambda#TenantId", + "traits": { + "smithy.api#documentation": "The tenant identifier for the chained invocation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Input": { + "target": "com.amazonaws.lambda#EventInput", + "traits": { + "smithy.api#documentation": "The JSON input payload provided to the chained invocation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutedVersion": { + "target": "com.amazonaws.lambda#VersionWithLatestPublished", + "traits": { + "smithy.api#documentation": "The version of the function that was executed.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DurableExecutionArn": { + "target": "com.amazonaws.lambda#DurableExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the durable execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a chained function invocation that has started execution, including start time and execution context.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ChainedInvokeStoppedDetails": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.lambda#EventError", + "traits": { + "smithy.api#documentation": "Details about why the chained invocation stopped.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a chained invocation that was stopped.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ChainedInvokeSucceededDetails": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.lambda#EventResult", + "traits": { + "smithy.api#documentation": "The response payload from the successful operation.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a chained invocation that succeeded.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ChainedInvokeTimedOutDetails": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.lambda#EventError", + "traits": { + "smithy.api#documentation": "Details about the chained invocation timeout.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a chained invocation that timed out.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CheckpointDurableExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#CheckpointDurableExecutionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#CheckpointDurableExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to save the progress of an AWS Lambda durable execution", + "relativeDocumentation": "API_CheckpointDurableExecution.html", + "resources": { + "required": { + "durable execution": {} + } + } + }, + "smithy.api#documentation": "Saves the progress of a durable function execution during runtime. This API is used by the Lambda durable functions SDK to checkpoint completed steps and schedule asynchronous operations. You typically don't need to call this API directly as the SDK handles checkpointing automatically.
Each checkpoint operation consumes the current checkpoint token and returns a new one for the next checkpoint. This ensures that checkpoints are applied in the correct order and prevents duplicate or out-of-order state updates.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2025-12-01/durable-executions/{DurableExecutionArn}/checkpoint", + "code": 200 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CheckpointDurableExecutionRequest": { + "type": "structure", + "members": { + "DurableExecutionArn": { + "target": "com.amazonaws.lambda#DurableExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the durable execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CheckpointToken": { + "target": "com.amazonaws.lambda#CheckpointToken", + "traits": { + "smithy.api#documentation": "A unique token that identifies the current checkpoint state. This token is provided by the Lambda runtime and must be used to ensure checkpoints are applied in the correct order. Each checkpoint operation consumes this token and returns a new one.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Updates": { + "target": "com.amazonaws.lambda#OperationUpdates", + "traits": { + "smithy.api#documentation": "An array of state updates to apply during this checkpoint. Each update represents a change to the execution state, such as completing a step, starting a callback, or scheduling a timer. Updates are applied atomically as part of the checkpoint operation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ClientToken": { + "target": "com.amazonaws.lambda#ClientToken", + "traits": { + "smithy.api#documentation": "An optional idempotency token to ensure that duplicate checkpoint requests are handled correctly. If provided, Lambda uses this token to detect and handle duplicate requests within a 15-minute window.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CheckpointDurableExecutionResponse": { + "type": "structure", + "members": { + "CheckpointToken": { + "target": "com.amazonaws.lambda#CheckpointToken", + "traits": { + "smithy.api#documentation": "A new checkpoint token to use for the next checkpoint operation. This token replaces the one provided in the request and must be used for subsequent checkpoints to maintain proper ordering.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "NewExecutionState": { + "target": "com.amazonaws.lambda#CheckpointUpdatedExecutionState", + "traits": { + "smithy.api#documentation": "Updated execution state information that includes any changes that occurred since the last checkpoint, such as completed callbacks or expired timers. This allows the SDK to update its internal state during replay.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The response from the CheckpointDurableExecution operation.
", + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CheckpointToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[A-Za-z0-9+/]+={0,2}$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CheckpointUpdatedExecutionState": { + "type": "structure", + "members": { + "Operations": { + "target": "com.amazonaws.lambda#Operations", + "traits": { + "smithy.api#documentation": "A list of operations that have been updated since the last checkpoint.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Indicates that more results are available. Use this value in a subsequent call to retrieve the next page of results.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Contains operations that have been updated since the last checkpoint, such as completed asynchronous work like timers or callbacks.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\x21-\\x7E]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CodeArtifactUserDeletedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda function couldn't be invoked because its code artifact user has been deleted. Wait for Lambda to provision a new code artifact user, or update the function's code package to recreate it.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CodeArtifactUserFailedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda function couldn't be invoked because provisioning of its code artifact user failed. Update the function's code package or check the Lambda function's State and StateReasonCode for additional context.
The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda function couldn't be invoked because its code artifact user is still being provisioned. Wait for the function's State to become Active and try the request again.
Unique identifer for the Code signing configuration.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Code signing configuration.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "Code signing configuration description.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AllowedPublishers": { + "target": "com.amazonaws.lambda#AllowedPublishers", + "traits": { + "smithy.api#documentation": "List of allowed publishers.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSigningPolicies": { + "target": "com.amazonaws.lambda#CodeSigningPolicies", + "traits": { + "smithy.api#documentation": "The code signing policy controls the validation failure action for signature mismatch or expiry.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the Code signing configuration was last modified, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a Code signing configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CodeSigningConfigArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:code-signing-config:csc-[a-z0-9]{17}$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CodeSigningConfigId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^csc-[a-zA-Z0-9-_\\.]{17}$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CodeSigningConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#CodeSigningConfig", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CodeSigningConfigNotFoundException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The specified code signing configuration does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CodeSigningConfigResource": { + "type": "resource", + "identifiers": { + "CodeSigningConfigId": { + "target": "com.amazonaws.lambda#CodeSigningConfigId" + } + }, + "create": { + "target": "com.amazonaws.lambda#CreateCodeSigningConfig" + }, + "list": { + "target": "com.amazonaws.lambda#ListCodeSigningConfigs" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.lambda#DeleteCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#GetCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#ListFunctionsByCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#UpdateCodeSigningConfig" + } + ], + "traits": { + "aws.api#arn": { + "template": "code-signing-config:{CodeSigningConfigId}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "code signing config", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "Represents an AWS Lambda code signing config", + "smithy.api#suppress": [ + "IamResourceTrait" + ], + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CodeSigningPolicies": { + "type": "structure", + "members": { + "UntrustedArtifactOnDeployment": { + "target": "com.amazonaws.lambda#CodeSigningPolicy", + "traits": { + "smithy.api#documentation": "Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to Warn, Lambda allows the deployment and issues a new Amazon CloudWatch metric (SignatureValidationErrors) and also stores the warning in the CloudTrail log.
Default value: Warn
Code signing configuration policies specify the validation failure action for signature mismatch or expiry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CodeSigningPolicy": { + "type": "enum", + "members": { + "Warn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warn", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Enforce": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enforce", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CodeStorageExceededException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Your Amazon Web Services account has exceeded its maximum total code size. For more information, see Lambda quotas.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CodeVerificationFailedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The code signature failed one or more of the validation checks for signature mismatch or expiry, and the code signing policy is set to ENFORCE. Lambda blocks the deployment.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CollectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 57 + }, + "smithy.api#pattern": "^(^(?!(system\\x2e)))(^[_a-zA-Z0-9])([^$]*)$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CompatibleArchitectures": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Architecture", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CompatibleRuntimes": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Concurrency": { + "type": "structure", + "members": { + "ReservedConcurrentExecutions": { + "target": "com.amazonaws.lambda#ReservedConcurrentExecutions", + "traits": { + "smithy.api#documentation": "The number of concurrent executions that are reserved for this function. For more information, see Managing Lambda reserved concurrency.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ContextDetails": { + "type": "structure", + "members": { + "ReplayChildren": { + "target": "com.amazonaws.lambda#ReplayChildren", + "traits": { + "smithy.api#documentation": "Whether the state data of child operations of this completed context should be included in the invoke payload and GetDurableExecutionState response.
The response payload from the context.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Error": { + "target": "com.amazonaws.lambda#ErrorObject", + "traits": { + "smithy.api#documentation": "Details about the context failure.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a durable execution context.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ContextFailedDetails": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.lambda#EventError", + "traits": { + "smithy.api#documentation": "Details about the context failure.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a context that failed.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ContextOptions": { + "type": "structure", + "members": { + "ReplayChildren": { + "target": "com.amazonaws.lambda#ReplayChildren", + "traits": { + "smithy.api#documentation": "Whether the state data of children of the completed context should be included in the invoke payload and GetDurableExecutionState response.
Configuration options for a durable execution context.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ContextStartedDetails": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Details about a context that has started.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ContextSucceededDetails": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.lambda#EventResult", + "traits": { + "smithy.api#documentation": "The JSON response payload from the successful context.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a context that succeeded.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Cors": { + "type": "structure", + "members": { + "AllowCredentials": { + "target": "com.amazonaws.lambda#AllowCredentials", + "traits": { + "smithy.api#documentation": "Whether to allow cookies or other credentials in requests to your function URL. The default is false.
The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.
The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).
The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com, http://localhost:60905.
Alternatively, you can grant access to all origins using the wildcard character (*).
The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date, Keep-Alive, X-Custom-Header.
The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn't cache results.
The cross-origin resource sharing (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CreateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#CreateAliasRequest" + }, + "output": { + "target": "com.amazonaws.lambda#AliasConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#AliasLimitExceededException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create an alias for a Lambda function version", + "relativeDocumentation": "API_CreateAlias.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.
You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.
The name or ARN of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Name": { + "target": "com.amazonaws.lambda#Alias", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Alias", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionVersion": { + "target": "com.amazonaws.lambda#VersionWithLatestPublished", + "traits": { + "smithy.api#documentation": "The function version that the alias invokes.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "A description of the alias.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RoutingConfig": { + "target": "com.amazonaws.lambda#AliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "The routing configuration of the alias.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CreateCapacityProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#CreateCapacityProviderRequest" + }, + "output": { + "target": "com.amazonaws.lambda#CreateCapacityProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CapacityProviderLimitExceededException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "aws:RequestTag/${TagKey}", + "aws:TagKeys", + "lambda:SubnetIds", + "lambda:SecurityGroupIds" + ], + "aws.iam#iamAction": { + "createsResources": [ + "capacityProvider" + ], + "documentation": "Grants permission to create an AWS Lambda capacity provider", + "relativeDocumentation": "API_CreateCapacityProvider.html", + "requiredActions": [ + "iam:PassRole", + "iam:CreateServiceLinkedRole", + "kms:DescribeKey" + ], + "resources": { + "required": { + "capacityProvider": {} + } + } + }, + "smithy.api#documentation": "Creates a capacity provider that manages compute resources for Lambda functions
", + "smithy.api#http": { + "method": "POST", + "uri": "/2025-11-30/capacity-providers", + "code": 202 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CreateCapacityProviderRequest": { + "type": "structure", + "members": { + "CapacityProviderName": { + "target": "com.amazonaws.lambda#CapacityProviderName", + "traits": { + "smithy.api#documentation": "The name of the capacity provider.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VpcConfig": { + "target": "com.amazonaws.lambda#CapacityProviderVpcConfig", + "traits": { + "smithy.api#documentation": "The VPC configuration for the capacity provider, including subnet IDs and security group IDs where compute instances will be launched.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PermissionsConfig": { + "target": "com.amazonaws.lambda#CapacityProviderPermissionsConfig", + "traits": { + "smithy.api#documentation": "The permissions configuration that specifies the IAM role ARN used by the capacity provider to manage compute resources.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.lambda#InstanceRequirements", + "traits": { + "smithy.api#documentation": "The instance requirements that specify the compute instance characteristics, including architectures and allowed or excluded instance types.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CapacityProviderScalingConfig": { + "target": "com.amazonaws.lambda#CapacityProviderScalingConfig", + "traits": { + "smithy.api#documentation": "The scaling configuration that defines how the capacity provider scales compute instances, including maximum vCPU count and scaling policies.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArnNonEmpty", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key used to encrypt data associated with the capacity provider.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "A list of tags to associate with the capacity provider.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PropagateTags": { + "target": "com.amazonaws.lambda#PropagateTags", + "traits": { + "smithy.api#documentation": "The tag propagation configuration for the capacity provider. Specifies tags to apply to managed resources at launch.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TelemetryConfig": { + "target": "com.amazonaws.lambda#CapacityProviderTelemetryConfig", + "traits": { + "smithy.api#documentation": "The telemetry configuration for the capacity provider. Specifies logging settings for managed resources.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CreateCapacityProviderResponse": { + "type": "structure", + "members": { + "CapacityProvider": { + "target": "com.amazonaws.lambda#CapacityProvider", + "traits": { + "smithy.api#documentation": "Information about the capacity provider that was created.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CreateCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#CreateCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#CreateCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], + "aws.iam#iamAction": { + "createsResources": [ + "code signing config" + ], + "documentation": "Grants permission to create an AWS Lambda code signing config", + "relativeDocumentation": "API_CreateCodeSigningConfig.html" + }, + "smithy.api#documentation": "Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).
", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-04-22/code-signing-configs", + "code": 201 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CreateCodeSigningConfigRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "Descriptive name for this code signing configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AllowedPublishers": { + "target": "com.amazonaws.lambda#AllowedPublishers", + "traits": { + "smithy.api#documentation": "Signing profiles for this code signing configuration.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSigningPolicies": { + "target": "com.amazonaws.lambda#CodeSigningPolicies", + "traits": { + "smithy.api#documentation": "The code signing policies define the actions to take if the validation checks fail.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "A list of tags to add to the code signing configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CreateCodeSigningConfigResponse": { + "type": "structure", + "members": { + "CodeSigningConfig": { + "target": "com.amazonaws.lambda#CodeSigningConfig", + "traits": { + "smithy.api#documentation": "The code signing configuration.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CreateEventSourceMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#CreateEventSourceMappingRequest" + }, + "output": { + "target": "com.amazonaws.lambda#EventSourceMappingConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "aws:RequestTag/${TagKey}", + "lambda:FunctionArn", + "aws:TagKeys" + ], + "aws.iam#iamAction": { + "createsResources": [ + "eventSourceMapping" + ], + "documentation": "Grants permission to create a mapping between an event source and an AWS Lambda function", + "relativeDocumentation": "API_CreateEventSourceMapping.html" + }, + "smithy.api#documentation": "Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.
For details about how to configure different event sources, see the following topics.
The following error handling options are available for stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka):
BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.
MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, Kafka topic, or Amazon S3 bucket. For more information, see Adding a destination.
The following option is available only for DynamoDB and Kinesis event sources:
ParallelizationFactor – Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.
The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis – The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams – The ARN of the stream.
Amazon Simple Queue Service – The ARN of the queue.
Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).
Amazon MQ – The ARN of the broker.
Amazon DocumentDB – The ARN of the DocumentDB change stream.
The name or ARN of the Lambda function.
Name formats
Function name – MyFunction.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Enabled": { + "target": "com.amazonaws.lambda#Enabled", + "traits": { + "smithy.api#documentation": "When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "BatchSize": { + "target": "com.amazonaws.lambda#BatchSize", + "traits": { + "smithy.api#documentation": "The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
Amazon Kinesis – Default 100. Max 10,000.
Amazon DynamoDB Streams – Default 100. Max 10,000.
Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
Self-managed Apache Kafka – Default 100. Max 10,000.
Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
DocumentDB – Default 100. Max 10,000.
An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MetricsConfig": { + "target": "com.amazonaws.lambda#EventSourceMappingMetricsConfig", + "traits": { + "smithy.api#documentation": "The metrics configuration for your event source. For more information, see Event source mapping metrics.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LoggingConfig": { + "target": "com.amazonaws.lambda#EventSourceMappingLoggingConfig", + "traits": { + "smithy.api#documentation": "(Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. For more information, see Event source mapping logging.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ScalingConfig": { + "target": "com.amazonaws.lambda#ScalingConfig", + "traits": { + "smithy.api#documentation": "(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.
Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StartingPosition": { + "target": "com.amazonaws.lambda#EventSourcePosition", + "traits": { + "smithy.api#documentation": "The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.
With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumRecordAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is infinite (-1).
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "BisectBatchOnFunctionError": { + "target": "com.amazonaws.lambda#BisectBatchOnFunctionError", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "A list of tags to apply to the event source mapping.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TumblingWindowInSeconds": { + "target": "com.amazonaws.lambda#TumblingWindowInSeconds", + "traits": { + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Topics": { + "target": "com.amazonaws.lambda#Topics", + "traits": { + "smithy.api#documentation": "The name of the Kafka topic.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Queues": { + "target": "com.amazonaws.lambda#Queues", + "traits": { + "smithy.api#documentation": "(MQ) The name of the Amazon MQ broker destination queue to consume.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SourceAccessConfigurations": { + "target": "com.amazonaws.lambda#SourceAccessConfigurations", + "traits": { + "smithy.api#documentation": "An array of authentication protocols or VPC components required to secure your event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SelfManagedEventSource": { + "target": "com.amazonaws.lambda#SelfManagedEventSource", + "traits": { + "smithy.api#documentation": "The self-managed Apache Kafka cluster to receive records from.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionResponseTypes": { + "target": "com.amazonaws.lambda#FunctionResponseTypeList", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS) A list of current response type enums applied to the event source mapping.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AmazonManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#AmazonManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#documentation": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SelfManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#SelfManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#documentation": "Specific configuration settings for a self-managed Apache Kafka event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DocumentDBEventSourceConfig": { + "target": "com.amazonaws.lambda#DocumentDBEventSourceConfig", + "traits": { + "smithy.api#documentation": "Specific configuration settings for a DocumentDB event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ProvisionedPollerConfig": { + "target": "com.amazonaws.lambda#ProvisionedPollerConfig", + "traits": { + "smithy.api#documentation": "(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CreateFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#CreateFunctionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeSigningConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#CodeStorageExceededException" + }, + { + "target": "com.amazonaws.lambda#CodeVerificationFailedException" + }, + { + "target": "com.amazonaws.lambda#FunctionVersionsPerCapacityProviderLimitExceededException" + }, + { + "target": "com.amazonaws.lambda#InvalidCodeSignatureException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:VpcIds", + "lambda:SubnetIds", + "lambda:CodeSigningConfigArn", + "lambda:Layer", + "aws:RequestTag/${TagKey}", + "aws:TagKeys", + "lambda:SecurityGroupIds" + ], + "aws.iam#iamAction": { + "createsResources": [ + "function" + ], + "documentation": "Grants permission to create an AWS Lambda function", + "relativeDocumentation": "API_CreateFunction.html", + "requiredActions": [ + "iam:PassRole", + "lambda:PassCapacityProvider" + ], + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.
If the deployment package is a container image, then you set the package type to Image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.
If the deployment package is a .zip file archive, then you set the package type to Zip. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, then the default value is x86-64.
When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Lambda function states.
A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).
You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted publishers for this function.
If another Amazon Web Services account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.
", + "smithy.api#examples": [ + { + "documentation": "The following example creates a function with a deployment package in Amazon S3 and enables X-Ray tracing and environment variable encryption.", + "input": { + "Code": { + "S3Bucket": "my-bucket-1xpuxmplzrlbh", + "S3Key": "function.zip" + }, + "Description": "Process image objects from Amazon S3.", + "DurableConfig": { + "ExecutionTimeout": 31622400, + "RetentionPeriodInDays": 30 + }, + "Environment": { + "Variables": { + "BUCKET": "my-bucket-1xpuxmplzrlbh", + "PREFIX": "inbound" + } + }, + "FunctionName": "my-function", + "Handler": "index.handler", + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "MemorySize": 256, + "Publish": true, + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Runtime": "nodejs12.x", + "Tags": { + "DEPARTMENT": "Assets" + }, + "Timeout": 15, + "TracingConfig": { + "Mode": "Active" + } + }, + "output": { + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "DurableConfig": { + "ExecutionTimeout": 31622400, + "RetentionPeriodInDays": 30 + }, + "Environment": { + "Variables": { + "BUCKET": "my-bucket-1xpuxmplzrlbh", + "PREFIX": "inbound" + } + }, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "FunctionName": "my-function", + "Handler": "index.handler", + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "LastModified": "2020-04-10T19:06:32.563+0000", + "LastUpdateStatus": "Successful", + "MemorySize": 256, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Runtime": "nodejs12.x", + "State": "Active", + "Timeout": 15, + "TracingConfig": { + "Mode": "Active" + }, + "Version": "1" + }, + "title": "To create a function" + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2015-03-31/functions", + "code": 201 + }, + "smithy.api#idempotent": {}, + "smithy.api#suppress": [ + "TaggableResource" + ], + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CreateFunctionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Runtime": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#documentation": "The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Role": { + "target": "com.amazonaws.lambda#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function's execution role.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Handler": { + "target": "com.amazonaws.lambda#Handler", + "traits": { + "smithy.api#documentation": "The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Code": { + "target": "com.amazonaws.lambda#FunctionCode", + "traits": { + "smithy.api#documentation": "The code for the function.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "A description of the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Timeout": { + "target": "com.amazonaws.lambda#Timeout", + "traits": { + "smithy.api#documentation": "The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MemorySize": { + "target": "com.amazonaws.lambda#MemorySize", + "traits": { + "smithy.api#documentation": "The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Publish": { + "target": "com.amazonaws.lambda#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Set to true to publish the first version of the function during creation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PublishTo": { + "target": "com.amazonaws.lambda#FunctionVersionLatestPublished", + "traits": { + "smithy.api#documentation": "Specifies where to publish the function version or configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VpcConfig": { + "target": "com.amazonaws.lambda#VpcConfig", + "traits": { + "smithy.api#documentation": "For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PackageType": { + "target": "com.amazonaws.lambda#PackageType", + "traits": { + "smithy.api#documentation": "The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.
A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Environment": { + "target": "com.amazonaws.lambda#Environment", + "traits": { + "smithy.api#documentation": "Environment variables that are accessible from function code during execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:
The function's environment variables.
The function's Lambda SnapStart snapshots.
When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.
The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.
If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TracingConfig": { + "target": "com.amazonaws.lambda#TracingConfig", + "traits": { + "smithy.api#documentation": "Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
A list of tags to apply to the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Layers": { + "target": "com.amazonaws.lambda#LayerList", + "traits": { + "smithy.api#documentation": "A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FileSystemConfigs": { + "target": "com.amazonaws.lambda#FileSystemConfigList", + "traits": { + "smithy.api#documentation": "Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ImageConfig": { + "target": "com.amazonaws.lambda#ImageConfig", + "traits": { + "smithy.api#documentation": "Container image configuration values that override the values in the container image Dockerfile.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Architectures": { + "target": "com.amazonaws.lambda#ArchitecturesList", + "traits": { + "smithy.api#documentation": "The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).
The function's SnapStart setting.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LoggingConfig": { + "target": "com.amazonaws.lambda#LoggingConfig", + "traits": { + "smithy.api#documentation": "The function's Amazon CloudWatch Logs configuration settings.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TenancyConfig": { + "target": "com.amazonaws.lambda#TenancyConfig", + "traits": { + "smithy.api#documentation": "Configuration for multi-tenant applications that use Lambda functions. Defines tenant isolation settings and resource allocations. Required for functions supporting multiple tenants.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CapacityProviderConfig": { + "target": "com.amazonaws.lambda#CapacityProviderConfig", + "traits": { + "smithy.api#documentation": "Configuration for the capacity provider that manages compute resources for Lambda functions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DurableConfig": { + "target": "com.amazonaws.lambda#DurableConfig", + "traits": { + "smithy.api#documentation": "Configuration settings for durable functions. Enables creating functions with durability that can remember their state and continue execution even after interruptions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CreateFunctionUrlConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#CreateFunctionUrlConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#CreateFunctionUrlConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:FunctionArn", + "lambda:FunctionUrlAuthType" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to create a function url configuration for a Lambda function", + "relativeDocumentation": "API_CreateFunctionUrlConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2021-10-31/functions/{FunctionName}/url", + "code": 201 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#CreateFunctionUrlConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionUrlFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#FunctionUrlQualifier", + "traits": { + "smithy.api#documentation": "The alias name.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.
The cross-origin resource sharing (CORS) settings for your function URL.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.
The HTTP URL endpoint for your function.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of your function.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.
The cross-origin resource sharing (CORS) settings for your function URL.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CreationTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The dead-letter queue for failed asynchronous invocations.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteAliasRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Lambda function alias", + "relativeDocumentation": "API_DeleteAlias.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Deletes a Lambda function alias.
", + "smithy.api#examples": [ + { + "documentation": "The following example deletes an alias named BLUE from a function named my-function", + "input": { + "FunctionName": "my-function", + "Name": "BLUE" + }, + "title": "To delete a Lambda function alias" + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "code": 204 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteAliasRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Name": { + "target": "com.amazonaws.lambda#Alias", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Alias", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteCapacityProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteCapacityProviderRequest" + }, + "output": { + "target": "com.amazonaws.lambda#DeleteCapacityProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Lambda capacity provider", + "relativeDocumentation": "API_DeleteCapacityProvider.html", + "resources": { + "required": { + "capacityProvider": {} + } + } + }, + "smithy.api#documentation": "Deletes a capacity provider. You cannot delete a capacity provider that is currently being used by Lambda functions.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2025-11-30/capacity-providers/{CapacityProviderName}", + "code": 202 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteCapacityProviderRequest": { + "type": "structure", + "members": { + "CapacityProviderName": { + "target": "com.amazonaws.lambda#CapacityProviderName", + "traits": { + "smithy.api#documentation": "The name of the capacity provider to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteCapacityProviderResponse": { + "type": "structure", + "members": { + "CapacityProvider": { + "target": "com.amazonaws.lambda#CapacityProvider", + "traits": { + "smithy.api#documentation": "Information about the deleted capacity provider.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#DeleteCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Lambda code signing config", + "relativeDocumentation": "API_DeleteCodeSigningConfig.html", + "resources": { + "required": { + "code signing config": {} + } + } + }, + "smithy.api#documentation": "Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", + "code": 204 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteCodeSigningConfigRequest": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "The The Amazon Resource Name (ARN) of the code signing configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteCodeSigningConfigResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteEventSourceMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteEventSourceMappingRequest" + }, + "output": { + "target": "com.amazonaws.lambda#EventSourceMappingConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceInUseException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:FunctionArn" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Lambda event source mapping", + "relativeDocumentation": "API_DeleteEventSourceMapping.html", + "resources": { + "required": { + "eventSourceMapping": {} + } + } + }, + "smithy.api#documentation": "Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds.
The identifier of the event source mapping.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteFunctionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#DeleteFunctionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Lambda function", + "relativeDocumentation": "API_DeleteFunction.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit permissions for DeleteAlias.
A deleted Lambda function cannot be recovered. Ensure that you specify the correct function name and version before deleting.
To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
", + "smithy.api#examples": [ + { + "documentation": "The following example deletes version 1 of a Lambda function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "1" + }, + "title": "To delete a version of a Lambda function" + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2015-03-31/functions/{FunctionName}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteFunctionCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteFunctionCodeSigningConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeSigningConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to detach a code signing config from an AWS Lambda function", + "relativeDocumentation": "API_DeleteFunctionCodeSigningConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Removes the code signing configuration from the function.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2020-06-30/functions/{FunctionName}/code-signing-config", + "code": 204 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteFunctionCodeSigningConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteFunctionConcurrency": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteFunctionConcurrencyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to remove a concurrent execution limit from an AWS Lambda function", + "relativeDocumentation": "API_DeleteFunctionConcurrency.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Removes a concurrent execution limit from a function.
", + "smithy.api#examples": [ + { + "documentation": "The following example deletes the reserved concurrent execution limit from a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "title": "To remove the reserved concurrent execution limit from a function" + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2017-10-31/functions/{FunctionName}/concurrency", + "code": 204 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteFunctionConcurrencyRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteFunctionEventInvokeConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteFunctionEventInvokeConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete the configuration for asynchronous invocation for an AWS Lambda function, version, or alias", + "relativeDocumentation": "API_DeleteFunctionEventInvokeConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Deletes the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
", + "smithy.api#examples": [ + { + "documentation": "The following example deletes the asynchronous invocation configuration for the GREEN alias of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "GREEN" + }, + "title": "To delete an asynchronous invocation configuration" + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config", + "code": 204 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteFunctionEventInvokeConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "A version number or alias name.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteFunctionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function or version.
Name formats
Function name – my-function (name-only), my-function:1 (with version).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "Specify a version to delete. You can't delete a version that an alias references.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteFunctionResponse": { + "type": "structure", + "members": { + "StatusCode": { + "target": "com.amazonaws.lambda#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status code returned by the operation.
", + "smithy.api#httpResponseCode": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteFunctionUrlConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteFunctionUrlConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:FunctionArn", + "lambda:FunctionUrlAuthType" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to delete function url configuration for a Lambda function", + "relativeDocumentation": "API_DeleteFunctionUrlConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Deletes a Lambda function URL. When you delete a function URL, you can't recover it. Creating a new function URL results in a different URL address.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2021-10-31/functions/{FunctionName}/url", + "code": 204 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteFunctionUrlConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionUrlFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#FunctionUrlQualifier", + "traits": { + "smithy.api#documentation": "The alias name.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteLayerVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteLayerVersionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete a version of an AWS Lambda layer", + "relativeDocumentation": "API_DeleteLayerVersion.html", + "resources": { + "required": { + "layerVersion": {} + } + } + }, + "smithy.api#documentation": "Deletes a version of an Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.
", + "smithy.api#examples": [ + { + "documentation": "The following example deletes version 2 of a layer named my-layer.", + "input": { + "LayerName": "my-layer", + "VersionNumber": 2 + }, + "title": "To delete a version of a Lambda layer" + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", + "code": 204 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteLayerVersionRequest": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the layer.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VersionNumber": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The version number.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteProvisionedConcurrencyConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#DeleteProvisionedConcurrencyConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete the provisioned concurrency configuration for an AWS Lambda function", + "relativeDocumentation": "API_DeleteProvisionedConcurrencyConfig.html", + "resources": { + "optional": { + "function version": {}, + "function alias": {} + } + } + }, + "smithy.api#documentation": "Deletes the provisioned concurrency configuration for a function.
", + "smithy.api#examples": [ + { + "documentation": "The following example deletes the provisioned concurrency configuration for the GREEN alias of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "GREEN" + }, + "title": "To delete a provisioned concurrency configuration" + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency", + "code": 204 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DeleteProvisionedConcurrencyConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "The version number or alias name.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DestinationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 350 + }, + "smithy.api#pattern": "^$|kafka://([^.]([a-zA-Z0-9\\-_.]{0,248}))|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DestinationConfig": { + "type": "structure", + "members": { + "OnSuccess": { + "target": "com.amazonaws.lambda#OnSuccess", + "traits": { + "smithy.api#documentation": "The destination configuration for successful invocations. Not supported in CreateEventSourceMapping or UpdateEventSourceMapping.
The destination configuration for failed invocations.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "A configuration object that specifies the destination of an event after Lambda processes it. For more information, see Adding a destination.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DocumentDBEventSourceConfig": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.lambda#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the database to consume within the DocumentDB cluster.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CollectionName": { + "target": "com.amazonaws.lambda#CollectionName", + "traits": { + "smithy.api#documentation": "The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FullDocument": { + "target": "com.amazonaws.lambda#FullDocument", + "traits": { + "smithy.api#documentation": "Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Specific configuration settings for a DocumentDB event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DurableConfig": { + "type": "structure", + "members": { + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RetentionPeriodInDays": { + "target": "com.amazonaws.lambda#RetentionPeriodInDays", + "traits": { + "smithy.api#documentation": "The number of days to retain execution history after a durable execution completes. After this period, execution history is no longer available through the GetDurableExecutionHistory API.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionTimeout": { + "target": "com.amazonaws.lambda#ExecutionTimeout", + "traits": { + "smithy.api#documentation": "The maximum time (in seconds) that a durable execution can run before timing out. This timeout applies to the entire durable execution, not individual function invocations.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for durable functions, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DurableExecution": { + "type": "resource", + "identifiers": { + "DurableExecutionArn": { + "target": "com.amazonaws.lambda#DurableExecutionArn" + } + }, + "read": { + "target": "com.amazonaws.lambda#GetDurableExecution" + }, + "operations": [ + { + "target": "com.amazonaws.lambda#CheckpointDurableExecution" + }, + { + "target": "com.amazonaws.lambda#GetDurableExecutionHistory" + }, + { + "target": "com.amazonaws.lambda#GetDurableExecutionState" + }, + { + "target": "com.amazonaws.lambda#StopDurableExecution" + } + ], + "traits": { + "aws.api#arn": { + "template": "durable-execution:{DurableExecutionArn}", + "absolute": true + }, + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "durable execution", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "Represents an AWS Lambda Durable Execution", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DurableExecutionAlreadyStartedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The durable execution with the specified name has already been started. Each durable execution name must be unique within the function. Use a different name or check the status of the existing execution.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DurableExecutionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^arn:([a-zA-Z0-9-]+):lambda:([a-zA-Z0-9-]+):(\\d{12}):function:([a-zA-Z0-9_-]+):(\\$LATEST(?:\\.PUBLISHED)?|[0-9]+)/durable-execution/([a-zA-Z0-9_-]+)/([a-zA-Z0-9_-]+)$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DurableExecutionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DurableExecutions": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Execution", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#DurationSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EC2AccessDeniedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Need additional permissions to configure VPC settings.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EC2ThrottledException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Amazon EC2 throttled Lambda during Lambda function initialization using the execution role provided for the function.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EC2UnexpectedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EC2ErrorCode": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda received an unexpected Amazon EC2 client exception while setting up for the Lambda function.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EFSIOException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "An error occurred when reading from or writing to a connected file system.
", + "smithy.api#error": "client", + "smithy.api#httpError": 410, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EFSMountConnectivityException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda function couldn't make a network connection to the configured file system.
", + "smithy.api#error": "client", + "smithy.api#httpError": 408, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EFSMountFailureException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda function couldn't mount the configured file system due to a permission or configuration issue.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EFSMountTimeoutException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda function made a network connection to the configured file system, but the mount operation timed out.
", + "smithy.api#error": "client", + "smithy.api#httpError": 408, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ENILimitReachedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda couldn't create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached. For more information, see Lambda quotas.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ENINotReadyException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda couldn't invoke the Lambda function because the elastic network interface (ENI) configured for its VPC connection isn't ready yet. Wait a few moments and try the request again. For more information about VPC configuration, see Configuring a Lambda function to access resources in a VPC.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Enabled": { + "type": "boolean", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EndPointType": { + "type": "enum", + "members": { + "KAFKA_BOOTSTRAP_SERVERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KAFKA_BOOTSTRAP_SERVERS", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Endpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EndpointLists": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Endpoint", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Endpoints": { + "type": "map", + "key": { + "target": "com.amazonaws.lambda#EndPointType", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "value": { + "target": "com.amazonaws.lambda#EndpointLists", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Environment": { + "type": "structure", + "members": { + "Variables": { + "target": "com.amazonaws.lambda#EnvironmentVariables", + "traits": { + "smithy.api#documentation": "Environment variable key-value pairs. For more information, see Using Lambda environment variables.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EnvironmentError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The error code.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#SensitiveString", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Error messages for environment variables that couldn't be applied.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EnvironmentResponse": { + "type": "structure", + "members": { + "Variables": { + "target": "com.amazonaws.lambda#EnvironmentVariables", + "traits": { + "smithy.api#documentation": "Environment variable key-value pairs. Omitted from CloudTrail logs.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Error": { + "target": "com.amazonaws.lambda#EnvironmentError", + "traits": { + "smithy.api#documentation": "Error messages for environment variables that couldn't be applied.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The results of an operation to update or read environment variables. If the operation succeeds, the response contains the environment variables. If it fails, the response contains details about the error.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EnvironmentVariableName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([a-zA-Z0-9_])+$", + "smithy.api#sensitive": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EnvironmentVariableValue": { + "type": "string", + "traits": { + "smithy.api#sensitive": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EnvironmentVariables": { + "type": "map", + "key": { + "target": "com.amazonaws.lambda#EnvironmentVariableName", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "value": { + "target": "com.amazonaws.lambda#EnvironmentVariableValue", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#sensitive": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EphemeralStorage": { + "type": "structure", + "members": { + "Size": { + "target": "com.amazonaws.lambda#EphemeralStorageSize", + "traits": { + "smithy.api#documentation": "The size of the function's /tmp directory.
The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).
A human-readable error message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ErrorType": { + "target": "com.amazonaws.lambda#ErrorType", + "traits": { + "smithy.api#documentation": "The error type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ErrorData": { + "target": "com.amazonaws.lambda#ErrorData", + "traits": { + "smithy.api#documentation": "Machine-readable error data.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StackTrace": { + "target": "com.amazonaws.lambda#StackTraceEntries", + "traits": { + "smithy.api#documentation": "Stack trace information for the error.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains error information.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ErrorType": { + "type": "string", + "traits": { + "smithy.api#sensitive": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Event": { + "type": "structure", + "members": { + "EventType": { + "target": "com.amazonaws.lambda#EventType", + "traits": { + "smithy.api#documentation": "The type of event that occurred.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SubType": { + "target": "com.amazonaws.lambda#OperationSubType", + "traits": { + "smithy.api#documentation": "The subtype of the event, providing additional categorization.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EventId": { + "target": "com.amazonaws.lambda#EventId", + "traits": { + "smithy.api#default": 1, + "smithy.api#documentation": "The unique identifier for this event. Event IDs increment sequentially.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Id": { + "target": "com.amazonaws.lambda#OperationId", + "traits": { + "smithy.api#documentation": "The unique identifier for this operation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Name": { + "target": "com.amazonaws.lambda#OperationName", + "traits": { + "smithy.api#documentation": "The customer-provided name for this operation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EventTimestamp": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when this event occurred, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ParentId": { + "target": "com.amazonaws.lambda#OperationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the parent operation, if this operation is running within a child context.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionStartedDetails": { + "target": "com.amazonaws.lambda#ExecutionStartedDetails", + "traits": { + "smithy.api#documentation": "Details about an execution that started.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionSucceededDetails": { + "target": "com.amazonaws.lambda#ExecutionSucceededDetails", + "traits": { + "smithy.api#documentation": "Details about an execution that succeeded.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionFailedDetails": { + "target": "com.amazonaws.lambda#ExecutionFailedDetails", + "traits": { + "smithy.api#documentation": "Details about an execution that failed.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionTimedOutDetails": { + "target": "com.amazonaws.lambda#ExecutionTimedOutDetails", + "traits": { + "smithy.api#documentation": "Details about an execution that timed out.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionStoppedDetails": { + "target": "com.amazonaws.lambda#ExecutionStoppedDetails", + "traits": { + "smithy.api#documentation": "Details about an execution that was stopped.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ContextStartedDetails": { + "target": "com.amazonaws.lambda#ContextStartedDetails", + "traits": { + "smithy.api#documentation": "Details about a context that started.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ContextSucceededDetails": { + "target": "com.amazonaws.lambda#ContextSucceededDetails", + "traits": { + "smithy.api#documentation": "Details about a context that succeeded.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ContextFailedDetails": { + "target": "com.amazonaws.lambda#ContextFailedDetails", + "traits": { + "smithy.api#documentation": "Details about a context that failed.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "WaitStartedDetails": { + "target": "com.amazonaws.lambda#WaitStartedDetails", + "traits": { + "smithy.api#documentation": "Details about a wait operation that started.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "WaitSucceededDetails": { + "target": "com.amazonaws.lambda#WaitSucceededDetails", + "traits": { + "smithy.api#documentation": "Details about a wait operation that succeeded.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "WaitCancelledDetails": { + "target": "com.amazonaws.lambda#WaitCancelledDetails", + "traits": { + "smithy.api#documentation": "Details about a wait operation that was cancelled.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StepStartedDetails": { + "target": "com.amazonaws.lambda#StepStartedDetails", + "traits": { + "smithy.api#documentation": "Details about a step that started.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StepSucceededDetails": { + "target": "com.amazonaws.lambda#StepSucceededDetails", + "traits": { + "smithy.api#documentation": "Details about a step that succeeded.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StepFailedDetails": { + "target": "com.amazonaws.lambda#StepFailedDetails", + "traits": { + "smithy.api#documentation": "Details about a step that failed.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ChainedInvokeStartedDetails": { + "target": "com.amazonaws.lambda#ChainedInvokeStartedDetails", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ChainedInvokeSucceededDetails": { + "target": "com.amazonaws.lambda#ChainedInvokeSucceededDetails", + "traits": { + "smithy.api#documentation": "Details about a chained invocation that succeeded.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ChainedInvokeFailedDetails": { + "target": "com.amazonaws.lambda#ChainedInvokeFailedDetails", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ChainedInvokeTimedOutDetails": { + "target": "com.amazonaws.lambda#ChainedInvokeTimedOutDetails", + "traits": { + "smithy.api#documentation": "Details about a chained invocation that timed out.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ChainedInvokeStoppedDetails": { + "target": "com.amazonaws.lambda#ChainedInvokeStoppedDetails", + "traits": { + "smithy.api#documentation": "Details about a chained invocation that was stopped.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CallbackStartedDetails": { + "target": "com.amazonaws.lambda#CallbackStartedDetails", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CallbackSucceededDetails": { + "target": "com.amazonaws.lambda#CallbackSucceededDetails", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CallbackFailedDetails": { + "target": "com.amazonaws.lambda#CallbackFailedDetails", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CallbackTimedOutDetails": { + "target": "com.amazonaws.lambda#CallbackTimedOutDetails", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvocationCompletedDetails": { + "target": "com.amazonaws.lambda#InvocationCompletedDetails", + "traits": { + "smithy.api#documentation": "Details about a function invocation that completed.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "An event that occurred during the execution of a durable function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventError": { + "type": "structure", + "members": { + "Payload": { + "target": "com.amazonaws.lambda#ErrorObject", + "traits": { + "smithy.api#documentation": "The error payload.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Truncated": { + "target": "com.amazonaws.lambda#Truncated", + "traits": { + "smithy.api#documentation": "Indicates if the error payload was truncated due to size limits.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Error information for an event.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventId": { + "type": "integer", + "traits": { + "smithy.api#default": 1, + "smithy.api#range": { + "min": 1 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventInput": { + "type": "structure", + "members": { + "Payload": { + "target": "com.amazonaws.lambda#InputPayload", + "traits": { + "smithy.api#documentation": "The input payload.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Truncated": { + "target": "com.amazonaws.lambda#Truncated", + "traits": { + "smithy.api#documentation": "Indicates if the error payload was truncated due to size limits.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Input information for an event.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventResult": { + "type": "structure", + "members": { + "Payload": { + "target": "com.amazonaws.lambda#OperationPayload", + "traits": { + "smithy.api#documentation": "The result payload.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Truncated": { + "target": "com.amazonaws.lambda#Truncated", + "traits": { + "smithy.api#documentation": "Indicates if the error payload was truncated due to size limits.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Result information for an event.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventSourceMapping": { + "type": "resource", + "identifiers": { + "UUID": { + "target": "com.amazonaws.lambda#UUIDString" + } + }, + "create": { + "target": "com.amazonaws.lambda#CreateEventSourceMapping" + }, + "read": { + "target": "com.amazonaws.lambda#GetEventSourceMapping" + }, + "update": { + "target": "com.amazonaws.lambda#UpdateEventSourceMapping" + }, + "delete": { + "target": "com.amazonaws.lambda#DeleteEventSourceMapping" + }, + "list": { + "target": "com.amazonaws.lambda#ListEventSourceMappings" + }, + "traits": { + "aws.api#arn": { + "template": "event-source-mapping:{UUID}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "eventSourceMapping", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "Represents an AWS Lambda event source mapping", + "smithy.api#suppress": [ + "IamResourceTrait" + ], + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventSourceMappingArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 85, + "max": 120 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventSourceMappingConfiguration": { + "type": "structure", + "members": { + "UUID": { + "target": "com.amazonaws.lambda#UUIDString", + "traits": { + "smithy.api#documentation": "The identifier of the event source mapping.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StartingPosition": { + "target": "com.amazonaws.lambda#EventSourcePosition", + "traits": { + "smithy.api#documentation": "The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.
With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EventSourceArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FilterCriteria": { + "target": "com.amazonaws.lambda#FilterCriteria", + "traits": { + "smithy.api#documentation": "An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
If filter criteria is encrypted, this field shows up as null in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt permissions for the correct KMS key.
An object that contains details about an error related to filter criteria encryption.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MetricsConfig": { + "target": "com.amazonaws.lambda#EventSourceMappingMetricsConfig", + "traits": { + "smithy.api#documentation": "The metrics configuration for your event source. For more information, see Event source mapping metrics.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LoggingConfig": { + "target": "com.amazonaws.lambda#EventSourceMappingLoggingConfig", + "traits": { + "smithy.api#documentation": "(Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. For more information, see Event source mapping logging.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ScalingConfig": { + "target": "com.amazonaws.lambda#ScalingConfig", + "traits": { + "smithy.api#documentation": "(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "The ARN of the Lambda function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Date", + "traits": { + "smithy.api#documentation": "The date that the event source mapping was last updated or that its state changed.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LastProcessingResult": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The result of the event source mapping's last processing attempt.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "State": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
Indicates whether a user or Lambda made the last change to the event source mapping.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Topics": { + "target": "com.amazonaws.lambda#Topics", + "traits": { + "smithy.api#documentation": "The name of the Kafka topic.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Queues": { + "target": "com.amazonaws.lambda#Queues", + "traits": { + "smithy.api#documentation": "(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SourceAccessConfigurations": { + "target": "com.amazonaws.lambda#SourceAccessConfigurations", + "traits": { + "smithy.api#documentation": "An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SelfManagedEventSource": { + "target": "com.amazonaws.lambda#SelfManagedEventSource", + "traits": { + "smithy.api#documentation": "The self-managed Apache Kafka cluster for your event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumRecordAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry. The default value is false.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TumblingWindowInSeconds": { + "target": "com.amazonaws.lambda#TumblingWindowInSeconds", + "traits": { + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionResponseTypes": { + "target": "com.amazonaws.lambda#FunctionResponseTypeList", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS) A list of current response type enums applied to the event source mapping.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AmazonManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#AmazonManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#documentation": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SelfManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#SelfManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#documentation": "Specific configuration settings for a self-managed Apache Kafka event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DocumentDBEventSourceConfig": { + "target": "com.amazonaws.lambda#DocumentDBEventSourceConfig", + "traits": { + "smithy.api#documentation": "Specific configuration settings for a DocumentDB event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EventSourceMappingArn": { + "target": "com.amazonaws.lambda#EventSourceMappingArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the event source mapping.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ProvisionedPollerConfig": { + "target": "com.amazonaws.lambda#ProvisionedPollerConfig", + "traits": { + "smithy.api#documentation": "(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventSourceMappingLoggingConfig": { + "type": "structure", + "members": { + "SystemLogLevel": { + "target": "com.amazonaws.lambda#EventSourceMappingSystemLogLevel", + "traits": { + "smithy.api#documentation": " The log level you want your event source mapping to use. Lambda event poller only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest. For more information about these metrics, see Event source mapping logging.
(Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. Use this configuration object to define the level of logs for your event source mapping.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventSourceMappingMetric": { + "type": "enum", + "members": { + "EventCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventCount", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ErrorCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ErrorCount", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KafkaMetrics": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KafkaMetrics", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventSourceMappingMetricList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#EventSourceMappingMetric", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventSourceMappingMetricsConfig": { + "type": "structure", + "members": { + "Metrics": { + "target": "com.amazonaws.lambda#EventSourceMappingMetricList", + "traits": { + "smithy.api#documentation": " The metrics you want your event source mapping to produce, including EventCount, ErrorCount, KafkaMetrics.
EventCount to receive metrics related to the number of events processed by your event source mapping.
ErrorCount (Amazon MSK and self-managed Apache Kafka) to receive metrics related to the number of errors in your event source mapping processing.
KafkaMetrics (Amazon MSK and self-managed Apache Kafka) to receive metrics related to the Kafka consumers from your event source mapping.
For more information about these metrics, see Event source mapping metrics.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The metrics configuration for your event source. Use this configuration object to define which metrics you want your event source mapping to produce.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventSourceMappingSystemLogLevel": { + "type": "enum", + "members": { + "Debug": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Info": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Warn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARN", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventSourceMappingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#EventSourceMappingConfiguration", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventSourcePosition": { + "type": "enum", + "members": { + "TRIM_HORIZON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRIM_HORIZON", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LATEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATEST", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AT_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT_TIMESTAMP", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventSourceToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#EventType": { + "type": "enum", + "members": { + "ExecutionStarted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExecutionStarted", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionSucceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExecutionSucceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExecutionFailed", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionTimedOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExecutionTimedOut", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionStopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExecutionStopped", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ContextStarted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContextStarted", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ContextSucceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContextSucceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ContextFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContextFailed", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "WaitStarted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WaitStarted", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "WaitSucceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WaitSucceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "WaitCancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WaitCancelled", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StepStarted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StepStarted", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StepSucceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StepSucceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StepFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StepFailed", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ChainedInvokeStarted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChainedInvokeStarted", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ChainedInvokeSucceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChainedInvokeSucceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ChainedInvokeFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChainedInvokeFailed", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ChainedInvokeTimedOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChainedInvokeTimedOut", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ChainedInvokeStopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChainedInvokeStopped", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CallbackStarted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CallbackStarted", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CallbackSucceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CallbackSucceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CallbackFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CallbackFailed", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CallbackTimedOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CallbackTimedOut", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvocationCompleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvocationCompleted", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Events": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Event", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Execution": { + "type": "structure", + "members": { + "DurableExecutionArn": { + "target": "com.amazonaws.lambda#DurableExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the durable execution, if this execution is a durable execution.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DurableExecutionName": { + "target": "com.amazonaws.lambda#DurableExecutionName", + "traits": { + "smithy.api#documentation": "The unique name of the durable execution, if one was provided when the execution was started.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#NameSpacedFunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Status": { + "target": "com.amazonaws.lambda#ExecutionStatus", + "traits": { + "smithy.api#documentation": "The current status of the durable execution.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StartTimestamp": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the durable execution started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EndTimestamp": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the durable execution ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a durable execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ExecutionDataIncluded": { + "type": "boolean", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ExecutionDetails": { + "type": "structure", + "members": { + "InputPayload": { + "target": "com.amazonaws.lambda#InputPayload", + "traits": { + "smithy.api#documentation": "The original input payload provided for the durable execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a durable execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ExecutionEnvironmentMemoryGiBPerVCpu": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 2, + "max": 8 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ExecutionFailedDetails": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.lambda#EventError", + "traits": { + "smithy.api#documentation": "Details about the execution failure.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a failed durable execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ExecutionStartedDetails": { + "type": "structure", + "members": { + "Input": { + "target": "com.amazonaws.lambda#EventInput", + "traits": { + "smithy.api#documentation": "The input payload provided for the durable execution.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionTimeout": { + "target": "com.amazonaws.lambda#DurationSeconds", + "traits": { + "smithy.api#documentation": "The maximum amount of time that the durable execution is allowed to run, in seconds.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a durable execution that started.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ExecutionStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMED_OUT", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ExecutionStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#ExecutionStatus", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ExecutionStoppedDetails": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.lambda#EventError", + "traits": { + "smithy.api#documentation": "Details about why the execution stopped.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a durable execution that stopped.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ExecutionSucceededDetails": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.lambda#EventResult", + "traits": { + "smithy.api#documentation": "The response payload from the successful operation.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a durable execution that succeeded.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ExecutionTimedOutDetails": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.lambda#EventError", + "traits": { + "smithy.api#documentation": "Details about the execution timeout.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a durable execution that timed out.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ExecutionTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 31622400 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ExecutionTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FileSystemArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:elasticfilesystem:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:access-point/fsap-[a-f0-9]{17}$|^arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FileSystemConfig": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.lambda#FileSystemArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon EFS or Amazon S3 Files access point that provides access to the file system.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LocalMountPath": { + "target": "com.amazonaws.lambda#LocalMountPath", + "traits": { + "smithy.api#documentation": "The path where the function can access the file system, starting with /mnt/.
Details about the connection between a Lambda function and an Amazon EFS file system or an Amazon S3 Files file system.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FileSystemConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#FileSystemConfig", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Filter": { + "type": "structure", + "members": { + "Pattern": { + "target": "com.amazonaws.lambda#Pattern", + "traits": { + "smithy.api#documentation": "A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": " A structure within a FilterCriteria object that defines an event filtering pattern.
A list of filters.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains the filters for an event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FilterCriteriaError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#FilterCriteriaErrorCode", + "traits": { + "smithy.api#documentation": "The KMS exception that resulted from filter criteria encryption or decryption.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#FilterCriteriaErrorMessage", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains details about an error related to filter criteria encryption.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FilterCriteriaErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 50 + }, + "smithy.api#pattern": "^[A-Za-z]+Exception$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FilterCriteriaErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 2048 + }, + "smithy.api#pattern": ".*", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Filter", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FullDocument": { + "type": "enum", + "members": { + "UpdateLookup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateLookup", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Default", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Function": { + "type": "resource", + "identifiers": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName" + } + }, + "put": { + "target": "com.amazonaws.lambda#CreateFunction" + }, + "list": { + "target": "com.amazonaws.lambda#ListFunctions" + }, + "operations": [ + { + "target": "com.amazonaws.lambda#DeleteFunctionConcurrency" + }, + { + "target": "com.amazonaws.lambda#GetFunctionConcurrency" + }, + { + "target": "com.amazonaws.lambda#ListProvisionedConcurrencyConfigs" + }, + { + "target": "com.amazonaws.lambda#PutFunctionConcurrency" + }, + { + "target": "com.amazonaws.lambda#UpdateFunctionCode" + }, + { + "target": "com.amazonaws.lambda#UpdateFunctionConfiguration" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.lambda#CreateFunctionUrlConfig" + }, + { + "target": "com.amazonaws.lambda#DeleteFunctionCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#DeleteFunctionUrlConfig" + }, + { + "target": "com.amazonaws.lambda#GetFunction" + }, + { + "target": "com.amazonaws.lambda#GetFunctionCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#GetFunctionConfiguration" + }, + { + "target": "com.amazonaws.lambda#GetFunctionRecursionConfig" + }, + { + "target": "com.amazonaws.lambda#GetFunctionScalingConfig" + }, + { + "target": "com.amazonaws.lambda#GetFunctionUrlConfig" + }, + { + "target": "com.amazonaws.lambda#GetPolicy" + }, + { + "target": "com.amazonaws.lambda#GetRuntimeManagementConfig" + }, + { + "target": "com.amazonaws.lambda#Invoke" + }, + { + "target": "com.amazonaws.lambda#InvokeAsync" + }, + { + "target": "com.amazonaws.lambda#InvokeWithResponseStream" + }, + { + "target": "com.amazonaws.lambda#ListDurableExecutionsByFunction" + }, + { + "target": "com.amazonaws.lambda#ListFunctionUrlConfigs" + }, + { + "target": "com.amazonaws.lambda#PutFunctionCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#PutFunctionRecursionConfig" + }, + { + "target": "com.amazonaws.lambda#PutFunctionScalingConfig" + }, + { + "target": "com.amazonaws.lambda#PutRuntimeManagementConfig" + }, + { + "target": "com.amazonaws.lambda#UpdateFunctionUrlConfig" + } + ], + "traits": { + "aws.api#arn": { + "template": "function:{FunctionName}" + }, + "aws.api#taggable": { + "property": "Tags", + "disableSystemTags": false + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "function", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "Represents an AWS Lambda function", + "smithy.api#suppress": [ + "TaggableResource" + ], + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionAlias": { + "type": "resource", + "identifiers": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName" + }, + "Alias": { + "target": "com.amazonaws.lambda#Alias" + } + }, + "put": { + "target": "com.amazonaws.lambda#CreateAlias" + }, + "read": { + "target": "com.amazonaws.lambda#GetAlias" + }, + "update": { + "target": "com.amazonaws.lambda#UpdateAlias" + }, + "delete": { + "target": "com.amazonaws.lambda#DeleteAlias" + }, + "list": { + "target": "com.amazonaws.lambda#ListAliases" + }, + "traits": { + "aws.api#arn": { + "template": "function:{FunctionName}:{Alias}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "function alias", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "A lambda function version or alias", + "smithy.api#suppress": [ + "IamResourceTrait" + ], + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionCode": { + "type": "structure", + "members": { + "ZipFile": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3Bucket": { + "target": "com.amazonaws.lambda#S3Bucket", + "traits": { + "smithy.api#documentation": "An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3Key": { + "target": "com.amazonaws.lambda#S3Key", + "traits": { + "smithy.api#documentation": "The Amazon S3 key of the deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3ObjectVersion": { + "target": "com.amazonaws.lambda#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "For versioned objects, the version of the deployment package object to use.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3ObjectStorageMode": { + "target": "com.amazonaws.lambda#S3ObjectStorageMode", + "traits": { + "smithy.api#documentation": "Specifies how the deployment package is stored. Valid values:
COPY (default) – Uploads a copy of your deployment package to Lambda.
REFERENCE – Lambda references the deployment package from the specified Amazon S3 bucket.
URI of a container image in the Amazon ECR registry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SourceKMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The code for the Lambda function. You can either specify an object in Amazon S3, upload a .zip file archive deployment package directly, or specify the URI of a container image.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionCodeLocation": { + "type": "structure", + "members": { + "RepositoryType": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The service that's hosting the file.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Location": { + "target": "com.amazonaws.lambda#SensitiveStringOnServerOnly", + "traits": { + "smithy.api#documentation": "A presigned URL that you can use to download the deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ImageUri": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "URI of a container image in the Amazon ECR registry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ResolvedImageUri": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The resolved URI for the image.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ResolvedS3Object": { + "target": "com.amazonaws.lambda#ResolvedS3Object", + "traits": { + "smithy.api#documentation": "The resolved Amazon S3 object that contains the deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SourceKMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Error": { + "target": "com.amazonaws.lambda#FunctionCodeLocationError", + "traits": { + "smithy.api#documentation": "An object that contains details about an error related to function deployment package retrieval.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a function's deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionCodeLocationError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The error code that identifies why Lambda failed to retrieve the deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#SensitiveString", + "traits": { + "smithy.api#documentation": "The human-readable message that describes why Lambda failed to retrieve the deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an error that occurred when Lambda attempted to retrieve a function's deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionConfiguration": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name of the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#NameSpacedFunctionArn", + "traits": { + "smithy.api#documentation": "The function's Amazon Resource Name (ARN).
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Runtime": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#documentation": "The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Role": { + "target": "com.amazonaws.lambda#RoleArn", + "traits": { + "smithy.api#documentation": "The function's execution role.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Handler": { + "target": "com.amazonaws.lambda#Handler", + "traits": { + "smithy.api#documentation": "The function that Lambda calls to begin running your function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSize": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The size of the function's deployment package, in bytes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "The function's description.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Timeout": { + "target": "com.amazonaws.lambda#Timeout", + "traits": { + "smithy.api#documentation": "The amount of time in seconds that Lambda allows a function to run before stopping it.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MemorySize": { + "target": "com.amazonaws.lambda#MemorySize", + "traits": { + "smithy.api#documentation": "The amount of memory available to the function at runtime.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSha256": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The SHA256 hash of the function's deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Version": { + "target": "com.amazonaws.lambda#Version", + "traits": { + "smithy.api#documentation": "The version of the Lambda function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VpcConfig": { + "target": "com.amazonaws.lambda#VpcConfigResponse", + "traits": { + "smithy.api#documentation": "The function's networking configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.lambda#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "The function's dead letter queue.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Environment": { + "target": "com.amazonaws.lambda#EnvironmentResponse", + "traits": { + "smithy.api#documentation": "The function's environment variables. Omitted from CloudTrail logs.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:
The function's environment variables.
The function's Lambda SnapStart snapshots.
When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.
The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.
If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TracingConfig": { + "target": "com.amazonaws.lambda#TracingConfigResponse", + "traits": { + "smithy.api#documentation": "The function's X-Ray tracing configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MasterArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "For Lambda@Edge functions, the ARN of the main function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The latest updated revision of the function or alias.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Layers": { + "target": "com.amazonaws.lambda#LayersReferenceList", + "traits": { + "smithy.api#documentation": "The function's layers.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "State": { + "target": "com.amazonaws.lambda#State", + "traits": { + "smithy.api#documentation": "The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
The reason for the function's current state.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StateReasonCode": { + "target": "com.amazonaws.lambda#StateReasonCode", + "traits": { + "smithy.api#documentation": "The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
The reason for the last update that was performed on the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LastUpdateStatusReasonCode": { + "target": "com.amazonaws.lambda#LastUpdateStatusReasonCode", + "traits": { + "smithy.api#documentation": "The reason code for the last update that was performed on the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FileSystemConfigs": { + "target": "com.amazonaws.lambda#FileSystemConfigList", + "traits": { + "smithy.api#documentation": "Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SigningProfileVersionArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the signing profile version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SigningJobArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the signing job.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PackageType": { + "target": "com.amazonaws.lambda#PackageType", + "traits": { + "smithy.api#documentation": "The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
The function's image configuration values.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Architectures": { + "target": "com.amazonaws.lambda#ArchitecturesList", + "traits": { + "smithy.api#documentation": "The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.
The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).
Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.
The ARN of the runtime and any errors that occured.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LoggingConfig": { + "target": "com.amazonaws.lambda#LoggingConfig", + "traits": { + "smithy.api#documentation": "The function's Amazon CloudWatch Logs configuration settings.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TenancyConfig": { + "target": "com.amazonaws.lambda#TenancyConfig", + "traits": { + "smithy.api#documentation": "The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CapacityProviderConfig": { + "target": "com.amazonaws.lambda#CapacityProviderConfig", + "traits": { + "smithy.api#documentation": "Configuration for the capacity provider that manages compute resources for Lambda functions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ConfigSha256": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The SHA256 hash of the function configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DurableConfig": { + "target": "com.amazonaws.lambda#DurableConfig", + "traits": { + "smithy.api#documentation": "The function's durable execution configuration settings, if the function is configured for durability.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a function's configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionEventInvokeConfig": { + "type": "structure", + "members": { + "LastModified": { + "target": "com.amazonaws.lambda#Date", + "traits": { + "smithy.api#documentation": "The date and time that the configuration was last updated.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttempts", + "traits": { + "smithy.api#documentation": "The maximum number of times to retry when the function returns an error.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumEventAgeInSeconds", + "traits": { + "smithy.api#documentation": "The maximum age of a request that Lambda sends to a function for processing.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", + "traits": { + "smithy.api#documentation": "A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of a standard SQS queue.
Bucket - The ARN of an Amazon S3 bucket.
Topic - The ARN of a standard SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.
The minimum number of execution environments to maintain for the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxExecutionEnvironments": { + "target": "com.amazonaws.lambda#FunctionScalingConfigExecutionEnvironments", + "traits": { + "smithy.api#documentation": "The maximum number of execution environments that can be provisioned for the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration that defines the scaling behavior for a Lambda Managed Instances function, including the minimum and maximum number of execution environments that can be provisioned.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionScalingConfigExecutionEnvironments": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 15000 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 40, + "max": 100 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionUrlAuthType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AWS_IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IAM", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionUrlConfig": { + "type": "structure", + "members": { + "FunctionUrl": { + "target": "com.amazonaws.lambda#FunctionUrl", + "traits": { + "smithy.api#documentation": "The HTTP URL endpoint for your function.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of your function.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CreationTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Cors": { + "target": "com.amazonaws.lambda#Cors", + "traits": { + "smithy.api#documentation": "The cross-origin resource sharing (CORS) settings for your function URL.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.
Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.
Details about a Lambda function URL.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionUrlConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#FunctionUrlConfig", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionUrlFunctionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]{1,64})(:((?!\\d+$)[0-9a-zA-Z-_]+))?$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionUrlQualifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^((?!^\\d+$)^[0-9a-zA-Z-_]+$)$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionVersion": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionVersionLatestPublished": { + "type": "enum", + "members": { + "LATEST_PUBLISHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATEST_PUBLISHED", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionVersionResource": { + "type": "resource", + "identifiers": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName" + }, + "Version": { + "target": "com.amazonaws.lambda#Version" + } + }, + "create": { + "target": "com.amazonaws.lambda#PublishVersion" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.lambda#ListVersionsByFunction" + } + ], + "traits": { + "aws.api#arn": { + "template": "function:{FunctionName}:{Version}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "function version", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "A lambda function version or alias", + "smithy.api#suppress": [ + "IamResourceTrait" + ], + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionVersionsByCapacityProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#FunctionVersionsByCapacityProviderListItem", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionVersionsByCapacityProviderListItem": { + "type": "structure", + "members": { + "FunctionArn": { + "target": "com.amazonaws.lambda#NameSpacedFunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function version.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "State": { + "target": "com.amazonaws.lambda#State", + "traits": { + "smithy.api#documentation": "The current state of the function version.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a function version that uses a specific capacity provider, including its ARN and current state.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#FunctionVersionsPerCapacityProviderLimitExceededException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The maximum number of function versions that can be associated with a single capacity provider has been exceeded. For more information, see Lambda quotas.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetAccountSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetAccountSettingsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetAccountSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about an account's limits and usage in an AWS Region", + "relativeDocumentation": "API_GetAccountSettings.html" + }, + "smithy.api#documentation": "Retrieves details about your account's limits and usage in an Amazon Web Services Region.
", + "smithy.api#examples": [ + { + "documentation": "This operation takes no parameters and returns details about storage and concurrency quotas in the current Region.", + "output": { + "AccountLimit": { + "CodeSizeUnzipped": 262144000, + "CodeSizeZipped": 52428800, + "ConcurrentExecutions": 1000, + "TotalCodeSize": 80530636800, + "UnreservedConcurrentExecutions": 1000 + }, + "AccountUsage": { + "FunctionCount": 4, + "TotalCodeSize": 9426 + } + }, + "title": "To get account settings" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2016-08-19/account-settings", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetAccountSettingsRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetAccountSettingsResponse": { + "type": "structure", + "members": { + "AccountLimit": { + "target": "com.amazonaws.lambda#AccountLimit", + "traits": { + "smithy.api#documentation": "Limits that are related to concurrency and code storage.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AccountUsage": { + "target": "com.amazonaws.lambda#AccountUsage", + "traits": { + "smithy.api#documentation": "The number of functions and amount of storage in use.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetAliasRequest" + }, + "output": { + "target": "com.amazonaws.lambda#AliasConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about an AWS Lambda function alias", + "relativeDocumentation": "API_GetAlias.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Returns details about a Lambda function alias.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns details about an alias named BLUE for a function named my-function", + "input": { + "FunctionName": "my-function", + "Name": "BLUE" + }, + "output": { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE", + "Description": "Production environment BLUE.", + "FunctionVersion": "3", + "Name": "BLUE", + "RevisionId": "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93" + }, + "title": "To get a Lambda function alias" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetAliasRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Name": { + "target": "com.amazonaws.lambda#Alias", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Alias", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetCapacityProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetCapacityProviderRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetCapacityProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about an AWS Lambda capacity provider", + "relativeDocumentation": "API_GetCapacityProvider.html", + "resources": { + "required": { + "capacityProvider": {} + } + } + }, + "smithy.api#documentation": "Retrieves information about a specific capacity provider, including its configuration, state, and associated resources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2025-11-30/capacity-providers/{CapacityProviderName}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetCapacityProviderRequest": { + "type": "structure", + "members": { + "CapacityProviderName": { + "target": "com.amazonaws.lambda#CapacityProviderName", + "traits": { + "smithy.api#documentation": "The name of the capacity provider to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetCapacityProviderResponse": { + "type": "structure", + "members": { + "CapacityProvider": { + "target": "com.amazonaws.lambda#CapacityProvider", + "traits": { + "smithy.api#documentation": "Information about the capacity provider, including its configuration and current state.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about an AWS Lambda code signing config", + "relativeDocumentation": "API_GetCodeSigningConfig.html", + "resources": { + "required": { + "code signing config": {} + } + } + }, + "smithy.api#documentation": "Returns information about the specified code signing configuration.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetCodeSigningConfigRequest": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "The The Amazon Resource Name (ARN) of the code signing configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetCodeSigningConfigResponse": { + "type": "structure", + "members": { + "CodeSigningConfig": { + "target": "com.amazonaws.lambda#CodeSigningConfig", + "traits": { + "smithy.api#documentation": "The code signing configuration
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetDurableExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetDurableExecutionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetDurableExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view details of an AWS Lambda durable execution", + "relativeDocumentation": "API_GetDurableExecution.html", + "resources": { + "required": { + "durable execution": {} + } + } + }, + "smithy.api#documentation": "Retrieves detailed information about a specific durable execution, including its current status, input payload, result or error information, and execution metadata such as start time and usage statistics.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2025-12-01/durable-executions/{DurableExecutionArn}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetDurableExecutionHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetDurableExecutionHistoryRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetDurableExecutionHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view execution history of an AWS Lambda durable execution", + "relativeDocumentation": "API_GetDurableExecutionHistory.html", + "resources": { + "required": { + "durable execution": {} + } + } + }, + "smithy.api#documentation": "Retrieves the execution history for a durable execution, showing all the steps, callbacks, and events that occurred during the execution. This provides a detailed audit trail of the execution's progress over time.
The history is available while the execution is running and for a retention period after it completes (1-90 days, default 30 days). You can control whether to include execution data such as step results and callback payloads.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2025-12-01/durable-executions/{DurableExecutionArn}/history", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "Events", + "pageSize": "MaxItems" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetDurableExecutionHistoryRequest": { + "type": "structure", + "members": { + "DurableExecutionArn": { + "target": "com.amazonaws.lambda#DurableExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the durable execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "IncludeExecutionData": { + "target": "com.amazonaws.lambda#IncludeExecutionData", + "traits": { + "smithy.api#documentation": "Specifies whether to include execution data such as step results and callback payloads in the history events. Set to true to include data, or false to exclude it for a more compact response. The default is true.
The maximum number of history events to return per call. You can use Marker to retrieve additional pages of results. The default is 100 and the maximum allowed is 1000. A value of 0 uses the default.
If NextMarker was returned from a previous request, use this value to retrieve the next page of results. Each pagination token expires after 24 hours.
When set to true, returns the history events in reverse chronological order (newest first). By default, events are returned in chronological order (oldest first).
An array of execution history events, ordered chronologically unless ReverseOrder is set to true. Each event represents a significant occurrence during the execution, such as step completion or callback resolution.
If present, indicates that more history events are available. Use this value as the Marker parameter in a subsequent request to retrieve the next page of results.
The response from the GetDurableExecutionHistory operation, containing the execution history and events.
", + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetDurableExecutionRequest": { + "type": "structure", + "members": { + "DurableExecutionArn": { + "target": "com.amazonaws.lambda#DurableExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the durable execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "IncludeExecutionData": { + "target": "com.amazonaws.lambda#IncludeExecutionData", + "traits": { + "smithy.api#default": true, + "smithy.api#documentation": "Specifies whether to include execution data such as input payload, result, and error information in the response. Set to false for a more compact response that includes only execution metadata. The default value is set to true.
The Amazon Resource Name (ARN) of the durable execution.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DurableExecutionName": { + "target": "com.amazonaws.lambda#DurableExecutionName", + "traits": { + "smithy.api#documentation": "The name of the durable execution. This is either the name you provided when invoking the function, or a system-generated unique identifier if no name was provided.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#NameSpacedFunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InputPayload": { + "target": "com.amazonaws.lambda#InputPayload", + "traits": { + "smithy.api#documentation": "The JSON input payload that was provided when the durable execution was started. For asynchronous invocations, this is limited to 256 KB. For synchronous invocations, this can be up to 6 MB.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Result": { + "target": "com.amazonaws.lambda#OutputPayload", + "traits": { + "smithy.api#documentation": "The JSON result returned by the durable execution if it completed successfully. This field is only present when the execution status is SUCCEEDED. The result is limited to 256 KB.
Error information if the durable execution failed. This field is only present when the execution status is FAILED, TIMED_OUT, or STOPPED. The combined size of all error fields is limited to 256 KB.
The date and time when the durable execution started, in Unix timestamp format.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Status": { + "target": "com.amazonaws.lambda#ExecutionStatus", + "traits": { + "smithy.api#documentation": "The current status of the durable execution. Valid values are RUNNING, SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.
The date and time when the durable execution ended, in Unix timestamp format. This field is only present if the execution has completed (status is SUCCEEDED, FAILED, TIMED_OUT, or STOPPED).
The version of the Lambda function that was invoked for this durable execution. This ensures that all replays during the execution use the same function version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TraceHeader": { + "target": "com.amazonaws.lambda#TraceHeader", + "traits": { + "smithy.api#documentation": "The trace headers associated with the durable execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionDataIncluded": { + "target": "com.amazonaws.lambda#ExecutionDataIncluded", + "traits": { + "smithy.api#documentation": "Indicates whether execution data is included in this response. Returns false when IncludeExecutionData is set to false in the request.
Configuration settings for the durable execution, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The response from the GetDurableExecution operation, containing detailed information about the durable execution.
", + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetDurableExecutionState": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetDurableExecutionStateRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetDurableExecutionStateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view current state of an AWS Lambda durable execution", + "relativeDocumentation": "API_GetDurableExecutionState.html", + "resources": { + "required": { + "durable execution": {} + } + } + }, + "smithy.api#documentation": "Retrieves the current execution state required for the replay process during durable function execution. This API is used by the Lambda durable functions SDK to get state information needed for replay. You typically don't need to call this API directly as the SDK handles state management automatically.
The response contains operations ordered by start sequence number in ascending order. Completed operations with children don't include child operation details since they don't need to be replayed.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2025-12-01/durable-executions/{DurableExecutionArn}/state", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "Operations", + "pageSize": "MaxItems" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetDurableExecutionStateRequest": { + "type": "structure", + "members": { + "DurableExecutionArn": { + "target": "com.amazonaws.lambda#DurableExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the durable execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CheckpointToken": { + "target": "com.amazonaws.lambda#CheckpointToken", + "traits": { + "smithy.api#documentation": "A checkpoint token that identifies the current state of the execution. This token is provided by the Lambda runtime and ensures that state retrieval is consistent with the current execution context.
", + "smithy.api#httpQuery": "CheckpointToken", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "If NextMarker was returned from a previous request, use this value to retrieve the next page of operations. Each pagination token expires after 24 hours.
The maximum number of operations to return per call. You can use Marker to retrieve additional pages of results. The default is 100 and the maximum allowed is 1000. A value of 0 uses the default.
An array of operations that represent the current state of the durable execution. Operations are ordered by their start sequence number in ascending order and include information needed for replay processing.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "If present, indicates that more operations are available. Use this value as the Marker parameter in a subsequent request to retrieve the next page of results.
The response from the GetDurableExecutionState operation, containing the current execution state for replay.
", + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetEventSourceMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetEventSourceMappingRequest" + }, + "output": { + "target": "com.amazonaws.lambda#EventSourceMappingConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:FunctionArn" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about an AWS Lambda event source mapping", + "relativeDocumentation": "API_GetEventSourceMapping.html", + "resources": { + "required": { + "eventSourceMapping": {} + } + } + }, + "smithy.api#documentation": "Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns details about an event source mapping. To get a mapping's UUID, use ListEventSourceMappings.", + "input": { + "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2" + }, + "output": { + "BatchSize": 500, + "BisectBatchOnFunctionError": false, + "DestinationConfig": {}, + "EventSourceArn": "arn:aws:sqs:us-east-2:123456789012:mySQSqueue", + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:myFunction", + "LastModified": "2016-11-21T19:49:20.006Z", + "LastProcessingResult": "No records processed", + "MaximumRecordAgeInSeconds": 604800, + "MaximumRetryAttempts": 10000, + "State": "Creating", + "StateTransitionReason": "User action", + "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2" + }, + "title": "To get a Lambda function's event source mapping" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/event-source-mappings/{UUID}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetEventSourceMappingRequest": { + "type": "structure", + "members": { + "UUID": { + "target": "com.amazonaws.lambda#UUIDString", + "traits": { + "smithy.api#documentation": "The identifier of the event source mapping.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetFunctionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about an AWS Lambda function", + "relativeDocumentation": "API_GetFunction.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns code and configuration details for version 1 of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "1" + }, + "output": { + "Code": { + "Location": "https://awslambda-us-west-2-tasks.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-function-e7d9d1ed-xmpl-4f79-904a-4b87f2681f30?versionId=sH3TQwBOaUy...", + "RepositoryType": "S3" + }, + "Configuration": { + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "DurableConfig": { + "ExecutionTimeout": 31622400, + "RetentionPeriodInDays": 30 + }, + "Environment": { + "Variables": { + "BUCKET": "my-bucket-1xpuxmplzrlbh", + "PREFIX": "inbound" + } + }, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "FunctionName": "my-function", + "Handler": "index.handler", + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "LastModified": "2020-04-10T19:06:32.563+0000", + "LastUpdateStatus": "Successful", + "MemorySize": 256, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Runtime": "nodejs12.x", + "State": "Active", + "Timeout": 15, + "TracingConfig": { + "Mode": "Active" + }, + "Version": "$LATEST" + }, + "Tags": { + "DEPARTMENT": "Assets" + } + }, + "title": "To get a Lambda function" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions/{FunctionName}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ], + "smithy.waiters#waitable": { + "FunctionActiveV2": { + "documentation": "Waits for the function's State to be Active. This waiter uses GetFunction API. This should be used after new function creation.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Configuration.State", + "expected": "Active", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Configuration.State", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "Configuration.State", + "expected": "Pending", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 1, + "maxDelay": 300 + }, + "FunctionExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 1, + "maxDelay": 20 + }, + "FunctionUpdatedV2": { + "documentation": "Waits for the function's LastUpdateStatus to be Successful. This waiter uses GetFunction API. This should be used after function updates.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Configuration.LastUpdateStatus", + "expected": "Successful", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Configuration.LastUpdateStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "Configuration.LastUpdateStatus", + "expected": "InProgress", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 1, + "maxDelay": 300 + } + } + } + }, + "com.amazonaws.lambda#GetFunctionCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetFunctionCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeSigningConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view the code signing config arn attached to an AWS Lambda function", + "relativeDocumentation": "API_GetFunctionCodeSigningConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Returns the code signing configuration for the specified function.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-06-30/functions/{FunctionName}/code-signing-config", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionCodeSigningConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionCodeSigningConfigResponse": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "The The Amazon Resource Name (ARN) of the code signing configuration.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionConcurrency": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionConcurrencyRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetFunctionConcurrencyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about the reserved concurrency configuration for a function", + "relativeDocumentation": "API_GetFunctionConcurrency.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns the reserved concurrency setting for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "ReservedConcurrentExecutions": 250 + }, + "title": "To get the reserved concurrency setting for a function" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2019-09-30/functions/{FunctionName}/concurrency", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionConcurrencyRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionConcurrencyResponse": { + "type": "structure", + "members": { + "ReservedConcurrentExecutions": { + "target": "com.amazonaws.lambda#ReservedConcurrentExecutions", + "traits": { + "smithy.api#documentation": "The number of simultaneous executions that are reserved for the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about the version-specific settings of an AWS Lambda function or version", + "relativeDocumentation": "API_GetFunctionConfiguration.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.
To get all of a function's details, including function-level settings, use GetFunction.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns and configuration details for version 1 of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "1" + }, + "output": { + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "DurableConfig": { + "ExecutionTimeout": 31622400, + "RetentionPeriodInDays": 30 + }, + "Environment": { + "Variables": { + "BUCKET": "my-bucket-1xpuxmplzrlbh", + "PREFIX": "inbound" + } + }, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "FunctionName": "my-function", + "Handler": "index.handler", + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "LastModified": "2020-04-10T19:06:32.563+0000", + "LastUpdateStatus": "Successful", + "MemorySize": 256, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Runtime": "nodejs12.x", + "State": "Active", + "Timeout": 15, + "TracingConfig": { + "Mode": "Active" + }, + "Version": "$LATEST" + }, + "title": "To get a Lambda function's event source mapping" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions/{FunctionName}/configuration", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ], + "smithy.waiters#waitable": { + "FunctionActive": { + "documentation": "Waits for the function's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new function creation.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "State", + "expected": "Active", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "State", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "State", + "expected": "Pending", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 300 + }, + "FunctionUpdated": { + "documentation": "Waits for the function's LastUpdateStatus to be Successful. This waiter uses GetFunctionConfiguration API. This should be used after function updates.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "LastUpdateStatus", + "expected": "Successful", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "LastUpdateStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "LastUpdateStatus", + "expected": "InProgress", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 300 + }, + "PublishedVersionActive": { + "documentation": "Waits for the published version's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new version is published.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "State", + "expected": "Active", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "State", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "State", + "expected": "Pending", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 1560 + } + } + } + }, + "com.amazonaws.lambda#GetFunctionConfigurationRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
Name formats
Function name – my-function (name-only), my-function:v1 (with alias).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "Specify a version or alias to get details about a published version of the function.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionEventInvokeConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionEventInvokeConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionEventInvokeConfig" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view the configuration for asynchronous invocation for a function, version, or alias", + "relativeDocumentation": "API_GetFunctionEventInvokeConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Retrieves the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns the asynchronous invocation configuration for the BLUE alias of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "BLUE" + }, + "output": { + "DestinationConfig": { + "OnFailure": { + "Destination": "arn:aws:sqs:us-east-2:123456789012:failed-invocations" + }, + "OnSuccess": {} + }, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", + "LastModified": "2016-11-21T19:49:20.006Z", + "MaximumEventAgeInSeconds": 3600, + "MaximumRetryAttempts": 0 + }, + "title": "To get an asynchronous invocation configuration" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionEventInvokeConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "A version number or alias name.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionRecursionConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionRecursionConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetFunctionRecursionConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view the recursion configuration of an AWS Lambda function", + "relativeDocumentation": "API_GetFunctionRecursionConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Returns your function's recursive loop detection configuration.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2024-08-31/functions/{FunctionName}/recursion-config", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionRecursionConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#UnqualifiedFunctionName", + "traits": { + "smithy.api#documentation": "The name of the function.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionRecursionConfigResponse": { + "type": "structure", + "members": { + "RecursiveLoop": { + "target": "com.amazonaws.lambda#RecursiveLoop", + "traits": { + "smithy.api#documentation": "If your function's recursive loop detection configuration is Allow, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop.
If your function's recursive loop detection configuration is Terminate, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.
By default, Lambda sets your function's configuration to Terminate. You can update this configuration using the PutFunctionRecursionConfig action.
The name or ARN of the Lambda function, version, or alias.
Name formats
Function name – my-function (name-only), my-function:v1 (with alias).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "Specify a version or alias to get details about a published version of the function.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionResponse": { + "type": "structure", + "members": { + "Configuration": { + "target": "com.amazonaws.lambda#FunctionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the function or version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Code": { + "target": "com.amazonaws.lambda#FunctionCodeLocation", + "traits": { + "smithy.api#documentation": "The deployment package of the function or version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "The function's tags. Lambda returns tag data only if you have explicit allow permissions for lambda:ListTags.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TagsError": { + "target": "com.amazonaws.lambda#TagsError", + "traits": { + "smithy.api#documentation": "An object that contains details about an error related to retrieving tags.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Concurrency": { + "target": "com.amazonaws.lambda#Concurrency", + "traits": { + "smithy.api#documentation": "The function's reserved concurrency.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionScalingConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionScalingConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetFunctionScalingConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view the scaling configuration of an AWS Lambda function running on a capacity provider", + "relativeDocumentation": "API_GetFunctionScalingConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Retrieves the scaling configuration for a Lambda Managed Instances function.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2025-11-30/functions/{FunctionName}/function-scaling-config", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionScalingConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#UnqualifiedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#PublishedFunctionQualifier", + "traits": { + "smithy.api#documentation": "Specify a version or alias to get the scaling configuration for a published version of the function.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionScalingConfigResponse": { + "type": "structure", + "members": { + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AppliedFunctionScalingConfig": { + "target": "com.amazonaws.lambda#FunctionScalingConfig", + "traits": { + "smithy.api#documentation": "The scaling configuration that is currently applied to the function. This represents the actual scaling settings in effect.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RequestedFunctionScalingConfig": { + "target": "com.amazonaws.lambda#FunctionScalingConfig", + "traits": { + "smithy.api#documentation": "The scaling configuration that was requested for the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionUrlConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetFunctionUrlConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetFunctionUrlConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:FunctionArn", + "lambda:FunctionUrlAuthType" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to read function url configuration for a Lambda function", + "relativeDocumentation": "API_GetFunctionUrlConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Returns details about a Lambda function URL.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-10-31/functions/{FunctionName}/url", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionUrlConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionUrlFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#FunctionUrlQualifier", + "traits": { + "smithy.api#documentation": "The alias name.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetFunctionUrlConfigResponse": { + "type": "structure", + "members": { + "FunctionUrl": { + "target": "com.amazonaws.lambda#FunctionUrl", + "traits": { + "smithy.api#documentation": "The HTTP URL endpoint for your function.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of your function.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.
The cross-origin resource sharing (CORS) settings for your function URL.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CreationTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.
Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns information for version 1 of a layer named my-layer.", + "input": { + "LayerName": "my-layer", + "VersionNumber": 1 + }, + "output": { + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ], + "Content": { + "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", + "CodeSize": 169, + "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH..." + }, + "CreatedDate": "2018-11-14T23:03:52.894+0000", + "Description": "My Python layer", + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1", + "LicenseInfo": "MIT", + "Version": 1 + }, + "title": "To get information about a Lambda layer version" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetLayerVersionByArn": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetLayerVersionByArnRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetLayerVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "name": "GetLayerVersion", + "documentation": "Grants permission to view details about a version of an AWS Lambda layer. Note this action also supports GetLayerVersionByArn API", + "relativeDocumentation": "API_GetLayerVersion.html", + "resources": { + "required": { + "layerVersion": {} + } + } + }, + "smithy.api#documentation": "Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns information about the layer version with the specified Amazon Resource Name (ARN).", + "input": { + "Arn": "arn:aws:lambda:ca-central-1:123456789012:layer:blank-python-lib:3" + }, + "output": { + "CompatibleRuntimes": [ + "python3.8" + ], + "Content": { + "CodeSha256": "6x+xmpl/M3BnQUk7gS9sGmfeFsR/npojXoA3fZUv4eU=", + "CodeSize": 9529009, + "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/blank-python-lib-e5212378-xmpl-44ee-8398-9d8ec5113949?versionId=WbZnvf..." + }, + "CreatedDate": "2020-03-31T00:35:18.949+0000", + "Description": "Dependencies for the blank-python sample app.", + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib", + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib:3", + "Version": 3 + }, + "title": "To get information about a Lambda layer version" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2018-10-31/layers?find=LayerVersion", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetLayerVersionByArnRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.lambda#LayerVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the layer version.
", + "smithy.api#httpQuery": "Arn", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetLayerVersionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetLayerVersionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetLayerVersionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view the resource-based policy for a version of an AWS Lambda layer", + "relativeDocumentation": "API_GetLayerVersionPolicy.html", + "resources": { + "required": { + "layerVersion": {} + } + } + }, + "smithy.api#documentation": "Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetLayerVersionPolicyRequest": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the layer.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VersionNumber": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The version number.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetLayerVersionPolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The policy document.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "A unique identifier for the current revision of the policy.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetLayerVersionRequest": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the layer.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VersionNumber": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The version number.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetLayerVersionResponse": { + "type": "structure", + "members": { + "Content": { + "target": "com.amazonaws.lambda#LayerVersionContentOutput", + "traits": { + "smithy.api#documentation": "Details about the layer version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LayerArn": { + "target": "com.amazonaws.lambda#LayerArn", + "traits": { + "smithy.api#documentation": "The ARN of the layer.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LayerVersionArn": { + "target": "com.amazonaws.lambda#LayerVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the layer version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "The description of the version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CreatedDate": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Version": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The version number.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CompatibleArchitectures": { + "target": "com.amazonaws.lambda#CompatibleArchitectures", + "traits": { + "smithy.api#documentation": "A list of compatible instruction set architectures.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.lambda#CompatibleRuntimes", + "traits": { + "smithy.api#documentation": "The layer's compatible runtimes.
The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LicenseInfo": { + "target": "com.amazonaws.lambda#LicenseInfo", + "traits": { + "smithy.api#documentation": "The layer's software license.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetPolicyRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view the resource-based policy for an AWS Lambda function, version, or alias", + "relativeDocumentation": "API_GetPolicy.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Returns the resource-based IAM policy for a function, version, or alias.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns the resource-based policy for version 1 of a Lambda function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "1" + }, + "output": { + "Policy": "{\"Version\":\"2012-10-17\",\"Id\":\"default\",\"Statement\":[{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function:1\"}]}", + "RevisionId": "4843f2f6-7c59-4fda-b484-afd0bc0e22b8" + }, + "title": "To retrieve a Lambda function policy" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions/{FunctionName}/policy", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetPolicyRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
Name formats
Function name – my-function (name-only), my-function:v1 (with alias).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "Specify a version or alias to get the policy for that resource.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetPolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The resource-based policy.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "A unique identifier for the current revision of the policy.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetProvisionedConcurrencyConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetProvisionedConcurrencyConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetProvisionedConcurrencyConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view the provisioned concurrency configuration for an AWS Lambda function's alias or version", + "relativeDocumentation": "API_GetProvisionedConcurrencyConfig.html", + "resources": { + "optional": { + "function version": {}, + "function alias": {} + } + } + }, + "smithy.api#documentation": "Retrieves the provisioned concurrency configuration for a function's alias or version.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns details for the provisioned concurrency configuration for the BLUE alias of the specified function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "BLUE" + }, + "output": { + "AllocatedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "LastModified": "2019-12-31T20:28:49+0000", + "RequestedProvisionedConcurrentExecutions": 100, + "Status": "READY" + }, + "title": "To get a provisioned concurrency configuration" + }, + { + "documentation": "The following example displays details for the provisioned concurrency configuration for the BLUE alias of the specified function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "BLUE" + }, + "output": { + "AllocatedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "LastModified": "2019-12-31T20:28:49+0000", + "RequestedProvisionedConcurrentExecutions": 100, + "Status": "READY" + }, + "title": "To view a provisioned concurrency configuration" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetProvisionedConcurrencyConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "The version number or alias name.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetProvisionedConcurrencyConfigResponse": { + "type": "structure", + "members": { + "RequestedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#PositiveInteger", + "traits": { + "smithy.api#documentation": "The amount of provisioned concurrency requested.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AvailableProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "The amount of provisioned concurrency available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AllocatedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Status": { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyStatusEnum", + "traits": { + "smithy.api#documentation": "The status of the allocation process.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StatusReason": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "For failed allocations, the reason that provisioned concurrency could not be allocated.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that a user last updated the configuration, in ISO 8601 format.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#GetRuntimeManagementConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#GetRuntimeManagementConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#GetRuntimeManagementConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view the runtime management configuration of an AWS Lambda function", + "relativeDocumentation": "API_GetRuntimeManagementConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Retrieves the runtime management configuration for a function's version. If the runtime update mode is Manual, this includes the ARN of the runtime version and the runtime update mode. If the runtime update mode is Auto or Function update, this includes the runtime update mode and null is returned for the ARN. For more information, see Runtime updates.
The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.
The current runtime update mode of the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#NameSpacedFunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of your function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RuntimeVersionArn": { + "target": "com.amazonaws.lambda#RuntimeVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the runtime the function is configured to use. If the runtime update mode is Manual, the ARN is returned, otherwise null is returned.
Specifies the entry point to their application, which is typically the location of the runtime executable.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Command": { + "target": "com.amazonaws.lambda#StringList", + "traits": { + "smithy.api#documentation": "Specifies parameters that you want to pass in with ENTRYPOINT.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "WorkingDirectory": { + "target": "com.amazonaws.lambda#WorkingDirectory", + "traits": { + "smithy.api#documentation": "Specifies the working directory.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ImageConfigError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Error code.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#SensitiveString", + "traits": { + "smithy.api#documentation": "Error message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Error response to GetFunctionConfiguration.
Configuration values that override the container image Dockerfile.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Error": { + "target": "com.amazonaws.lambda#ImageConfigError", + "traits": { + "smithy.api#documentation": "Error response to GetFunctionConfiguration.
Response to a GetFunctionConfiguration request.
A list of supported CPU architectures for compute instances. Valid values include x86_64 and arm64.
A list of EC2 instance types that the capacity provider is allowed to use. If not specified, all compatible instance types are allowed.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExcludedInstanceTypes": { + "target": "com.amazonaws.lambda#InstanceTypeSet", + "traits": { + "smithy.api#documentation": "A list of EC2 instance types that the capacity provider should not use, even if they meet other requirements.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Specifications that define the characteristics and constraints for compute instances used by the capacity provider.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*\\-]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InstanceTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#InstanceType", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvalidCodeSignatureException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The code signature failed the integrity check. If the integrity check fails, then Lambda blocks deployment, even if the code signing policy is set to WARN.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvalidParameterValueException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "One of the parameters in the request is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvalidRequestContentException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The request body could not be parsed as JSON, or a request header is invalid. For example, the 'x-amzn-RequestId' header is not a valid UUID string.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvalidRuntimeException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The runtime or runtime version specified is not supported.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvalidSecurityGroupIDException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The security group ID provided in the Lambda function VPC configuration is not valid.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvalidSubnetIDException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The subnet ID provided in the Lambda function VPC configuration is not valid.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvalidZipFileException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda could not unzip the deployment package.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvocationCompletedDetails": { + "type": "structure", + "members": { + "StartTimestamp": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the invocation started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EndTimestamp": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the invocation ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RequestId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The request ID for the invocation.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Error": { + "target": "com.amazonaws.lambda#EventError", + "traits": { + "smithy.api#documentation": "Details about the invocation failure.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a function invocation that completed.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvocationRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
Name formats
Function name – my-function (name-only), my-function:v1 (with alias).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvocationType": { + "target": "com.amazonaws.lambda#InvocationType", + "traits": { + "smithy.api#documentation": "Choose from the following options.
RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.
Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.
DryRun – Validate parameter values and verify that the user or role has permission to invoke the function.
Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.
A unique name for the durable execution. If you invoke a durable function using a name that already exists with the same payload, Lambda returns the existing execution instead of creating a duplicate. If the payload differs, Lambda returns a DurableExecutionAlreadyStartedException error.
If not specified, Lambda generates a unique identifier automatically. For more information, see Execution names.
", + "smithy.api#httpHeader": "X-Amz-Durable-Execution-Name", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Payload": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "The JSON that you want to provide to your Lambda function as input. The maximum payload size is 6 MB for synchronous invocations and 1 MB for asynchronous invocations.
You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also specify a file path. For example, --payload file://payload.json.
Specify a version or alias to invoke a published version of the function.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TenantId": { + "target": "com.amazonaws.lambda#TenantId", + "traits": { + "smithy.api#documentation": "The identifier of the tenant in a multi-tenant Lambda function.
", + "smithy.api#httpHeader": "X-Amz-Tenant-Id", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvocationResponse": { + "type": "structure", + "members": { + "StatusCode": { + "target": "com.amazonaws.lambda#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.
If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.
", + "smithy.api#httpHeader": "X-Amz-Function-Error", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LogResult": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The last 4 KB of the execution log, which is base64-encoded.
", + "smithy.api#httpHeader": "X-Amz-Log-Result", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Payload": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "The response from the function, or an error object.
", + "smithy.api#httpPayload": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutedVersion": { + "target": "com.amazonaws.lambda#Version", + "traits": { + "smithy.api#documentation": "The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.
", + "smithy.api#httpHeader": "X-Amz-Executed-Version", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DurableExecutionArn": { + "target": "com.amazonaws.lambda#DurableExecutionArn", + "traits": { + "smithy.api#documentation": "The ARN of the durable execution that was started. This is returned when invoking a durable function and provides a unique identifier for tracking the execution.
", + "smithy.api#httpHeader": "X-Amz-Durable-Execution-Arn", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvocationType": { + "type": "enum", + "members": { + "Event": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Event", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RequestResponse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestResponse", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DryRun": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DryRun", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Invoke": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#InvocationRequest" + }, + "output": { + "target": "com.amazonaws.lambda#InvocationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeArtifactUserDeletedException" + }, + { + "target": "com.amazonaws.lambda#CodeArtifactUserFailedException" + }, + { + "target": "com.amazonaws.lambda#CodeArtifactUserPendingException" + }, + { + "target": "com.amazonaws.lambda#DurableExecutionAlreadyStartedException" + }, + { + "target": "com.amazonaws.lambda#EC2AccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#EC2ThrottledException" + }, + { + "target": "com.amazonaws.lambda#EC2UnexpectedException" + }, + { + "target": "com.amazonaws.lambda#EFSIOException" + }, + { + "target": "com.amazonaws.lambda#EFSMountConnectivityException" + }, + { + "target": "com.amazonaws.lambda#EFSMountFailureException" + }, + { + "target": "com.amazonaws.lambda#EFSMountTimeoutException" + }, + { + "target": "com.amazonaws.lambda#ENILimitReachedException" + }, + { + "target": "com.amazonaws.lambda#ENINotReadyException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#InvalidRequestContentException" + }, + { + "target": "com.amazonaws.lambda#InvalidRuntimeException" + }, + { + "target": "com.amazonaws.lambda#InvalidSecurityGroupIDException" + }, + { + "target": "com.amazonaws.lambda#InvalidSubnetIDException" + }, + { + "target": "com.amazonaws.lambda#InvalidZipFileException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ModeNotSupportedException" + }, + { + "target": "com.amazonaws.lambda#NoPublishedVersionException" + }, + { + "target": "com.amazonaws.lambda#RecursiveInvocationException" + }, + { + "target": "com.amazonaws.lambda#RequestTooLargeException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotReadyException" + }, + { + "target": "com.amazonaws.lambda#S3FilesMountConnectivityException" + }, + { + "target": "com.amazonaws.lambda#S3FilesMountFailureException" + }, + { + "target": "com.amazonaws.lambda#S3FilesMountTimeoutException" + }, + { + "target": "com.amazonaws.lambda#SerializedRequestEntityTooLargeException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lambda#SnapStartException" + }, + { + "target": "com.amazonaws.lambda#SnapStartNotReadyException" + }, + { + "target": "com.amazonaws.lambda#SnapStartRegenerationFailureException" + }, + { + "target": "com.amazonaws.lambda#SnapStartTimeoutException" + }, + { + "target": "com.amazonaws.lambda#SubnetIPAddressLimitReachedException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + }, + { + "target": "com.amazonaws.lambda#UnsupportedMediaTypeException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:EventSourceToken" + ], + "aws.iam#iamAction": { + "name": "InvokeFunction", + "documentation": "Grants permission to invoke an AWS Lambda function", + "relativeDocumentation": "API_Invoke.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. By default, Lambda invokes your function synchronously (i.e. theInvocationType is RequestResponse). To invoke a function asynchronously, set InvocationType to Event. Lambda passes the ClientContext object to your function for synchronous invocations only.
For synchronous invocations, the maximum payload size is 6 MB. For asynchronous invocations, the maximum payload size is 1 MB.
For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.
When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Error handling and automatic retries in Lambda.
For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.
The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, quota errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if running the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded).
For functions with a long timeout, your client might disconnect during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.
", + "smithy.api#examples": [ + { + "documentation": "The following example invokes version 1 of a function named my-function with an empty event payload.", + "input": { + "DurableExecutionName": "myExecution", + "FunctionName": "my-function", + "InvocationType": "Event", + "Payload": "{}", + "Qualifier": "1" + }, + "output": { + "Payload": "200 SUCCESS", + "StatusCode": 200 + }, + "title": "To invoke a Lambda function" + }, + { + "documentation": "The following example invokes version 1 of a function named my-function asynchronously.", + "input": { + "FunctionName": "my-function", + "InvocationType": "Event", + "Payload": "{}", + "Qualifier": "1" + }, + "output": { + "Payload": "", + "StatusCode": 202 + }, + "title": "To invoke a Lambda function asynchronously" + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2015-03-31/functions/{FunctionName}/invocations", + "code": 200 + }, + "smithy.api#tags": [ + "feature:public" + ], + "smithy.test#smokeTests": [ + { + "id": "ErrorInvalidFunctionName", + "params": { + "FunctionName": "bogus-function" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.lambda#ResourceNotFoundException" + } + }, + "vendorParams": {}, + "vendorParamsShape": "aws.test#AwsVendorParams" + } + ] + } + }, + "com.amazonaws.lambda#InvokeAsync": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#InvokeAsyncRequest" + }, + "output": { + "target": "com.amazonaws.lambda#InvokeAsyncResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#EC2AccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#EC2ThrottledException" + }, + { + "target": "com.amazonaws.lambda#EC2UnexpectedException" + }, + { + "target": "com.amazonaws.lambda#EFSIOException" + }, + { + "target": "com.amazonaws.lambda#EFSMountConnectivityException" + }, + { + "target": "com.amazonaws.lambda#EFSMountFailureException" + }, + { + "target": "com.amazonaws.lambda#EFSMountTimeoutException" + }, + { + "target": "com.amazonaws.lambda#ENILimitReachedException" + }, + { + "target": "com.amazonaws.lambda#InvalidRequestContentException" + }, + { + "target": "com.amazonaws.lambda#InvalidRuntimeException" + }, + { + "target": "com.amazonaws.lambda#InvalidSecurityGroupIDException" + }, + { + "target": "com.amazonaws.lambda#InvalidSubnetIDException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ModeNotSupportedException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#S3FilesMountConnectivityException" + }, + { + "target": "com.amazonaws.lambda#S3FilesMountFailureException" + }, + { + "target": "com.amazonaws.lambda#S3FilesMountTimeoutException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lambda#SnapStartException" + }, + { + "target": "com.amazonaws.lambda#SnapStartNotReadyException" + }, + { + "target": "com.amazonaws.lambda#SnapStartRegenerationFailureException" + }, + { + "target": "com.amazonaws.lambda#SnapStartTimeoutException" + }, + { + "target": "com.amazonaws.lambda#SubnetIPAddressLimitReachedException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to invoke a function asynchronously (Deprecated)", + "relativeDocumentation": "API_InvokeAsync.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#deprecated": {}, + "smithy.api#documentation": "For asynchronous function invocation, use Invoke.
Invokes a function asynchronously.
The payload limit is 256KB. For larger payloads, for up to 1MB, use Invoke.
If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not propagated to the function, even if X-Ray active tracing is turned on.
The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvokeArgs": { + "target": "com.amazonaws.lambda#BlobStream", + "traits": { + "smithy.api#documentation": "The JSON that you want to provide to your Lambda function as input.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvokeAsyncResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.lambda#HttpStatus", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The status code.
", + "smithy.api#httpResponseCode": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "A success response (202 Accepted) indicates that the request is queued for invocation.
Data returned by your Lambda function.
", + "smithy.api#eventPayload": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "A chunk of the streamed response payload.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvokeWithResponseStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#InvokeWithResponseStreamRequest" + }, + "output": { + "target": "com.amazonaws.lambda#InvokeWithResponseStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#EC2AccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#EC2ThrottledException" + }, + { + "target": "com.amazonaws.lambda#EC2UnexpectedException" + }, + { + "target": "com.amazonaws.lambda#EFSIOException" + }, + { + "target": "com.amazonaws.lambda#EFSMountConnectivityException" + }, + { + "target": "com.amazonaws.lambda#EFSMountFailureException" + }, + { + "target": "com.amazonaws.lambda#EFSMountTimeoutException" + }, + { + "target": "com.amazonaws.lambda#ENILimitReachedException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#InvalidRequestContentException" + }, + { + "target": "com.amazonaws.lambda#InvalidRuntimeException" + }, + { + "target": "com.amazonaws.lambda#InvalidSecurityGroupIDException" + }, + { + "target": "com.amazonaws.lambda#InvalidSubnetIDException" + }, + { + "target": "com.amazonaws.lambda#InvalidZipFileException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#NoPublishedVersionException" + }, + { + "target": "com.amazonaws.lambda#RecursiveInvocationException" + }, + { + "target": "com.amazonaws.lambda#RequestTooLargeException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotReadyException" + }, + { + "target": "com.amazonaws.lambda#S3FilesMountConnectivityException" + }, + { + "target": "com.amazonaws.lambda#S3FilesMountFailureException" + }, + { + "target": "com.amazonaws.lambda#S3FilesMountTimeoutException" + }, + { + "target": "com.amazonaws.lambda#SerializedRequestEntityTooLargeException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lambda#SnapStartException" + }, + { + "target": "com.amazonaws.lambda#SnapStartNotReadyException" + }, + { + "target": "com.amazonaws.lambda#SnapStartRegenerationFailureException" + }, + { + "target": "com.amazonaws.lambda#SnapStartTimeoutException" + }, + { + "target": "com.amazonaws.lambda#SubnetIPAddressLimitReachedException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + }, + { + "target": "com.amazonaws.lambda#UnsupportedMediaTypeException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:EventSourceToken" + ], + "aws.iam#iamAction": { + "name": "InvokeFunction", + "documentation": "Grants permission to invoke an AWS Lambda function", + "relativeDocumentation": "API_Invoke.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.
This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2021-11-15/functions/{FunctionName}/response-streaming-invocations", + "code": 200 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvokeWithResponseStreamCompleteEvent": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "An error code.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ErrorDetails": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The details of any returned error.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LogResult": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The last 4 KB of the execution log, which is base64-encoded.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "A response confirming that the event stream is complete.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvokeWithResponseStreamRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LogType": { + "target": "com.amazonaws.lambda#LogType", + "traits": { + "smithy.api#documentation": "Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
", + "smithy.api#httpHeader": "X-Amz-Client-Context", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "The alias name.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Payload": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "The JSON that you want to provide to your Lambda function as input.
You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also specify a file path. For example, --payload file://payload.json.
The identifier of the tenant in a multi-tenant Lambda function.
", + "smithy.api#httpHeader": "X-Amz-Tenant-Id", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvocationType": { + "target": "com.amazonaws.lambda#ResponseStreamingInvocationType", + "traits": { + "smithy.api#documentation": "Use one of the following options:
RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.
DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function.
For a successful request, the HTTP status code is in the 200 range. For the RequestResponse invocation type, this status code is 200. For the DryRun invocation type, this status code is 204.
The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.
", + "smithy.api#httpHeader": "X-Amz-Executed-Version", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EventStream": { + "target": "com.amazonaws.lambda#InvokeWithResponseStreamResponseEvent", + "traits": { + "smithy.api#documentation": "The stream of response payloads.
", + "smithy.api#httpPayload": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ResponseStreamContentType": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The type of data the stream is returning.
", + "smithy.api#httpHeader": "Content-Type", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#InvokeWithResponseStreamResponseEvent": { + "type": "union", + "members": { + "PayloadChunk": { + "target": "com.amazonaws.lambda#InvokeResponseStreamUpdate", + "traits": { + "smithy.api#documentation": "A chunk of the streamed response payload.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvokeComplete": { + "target": "com.amazonaws.lambda#InvokeWithResponseStreamCompleteEvent", + "traits": { + "smithy.api#documentation": "An object that's returned when the stream has ended and all the payload chunks have been returned.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "An object that includes a chunk of the response payload. When the stream has ended, Lambda includes a InvokeComplete object.
Lambda couldn't decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public", + "feature:public" + ] + } + }, + "com.amazonaws.lambda#KMSDisabledException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public", + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public", + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda couldn't decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public", + "feature:public" + ] + } + }, + "com.amazonaws.lambda#KMSInvalidStateException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public", + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public", + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda couldn't decrypt the environment variables because the state of the KMS key used is not valid for Decrypt. Check the function's KMS key settings.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public", + "feature:public" + ] + } + }, + "com.amazonaws.lambda#KMSKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + }, + "smithy.api#pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#KMSKeyArnNonEmpty": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#KMSNotFoundException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public", + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public", + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda couldn't decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public", + "feature:public" + ] + } + }, + "com.amazonaws.lambda#KafkaSchemaRegistryAccessConfig": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#KafkaSchemaRegistryAuthType", + "traits": { + "smithy.api#documentation": "The type of authentication Lambda uses to access your schema registry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "URI": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Specific access configuration settings that tell Lambda how to authenticate with your schema registry.
If you're working with an Glue schema registry, don't provide authentication details in this object. Instead, ensure that your execution role has the required permissions for Lambda to access your cluster.
If you're working with a Confluent schema registry, choose the authentication method in the Type field, and provide the Secrets Manager secret ARN in the URI field.
The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.
For Glue schema registries, use the ARN of the registry.
For Confluent schema registries, use the URL of the registry.
The record format that Lambda delivers to your function after schema validation.
Choose JSON to have Lambda deliver the record to your function as a standard JSON object.
Choose SOURCE to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
An array of access configuration objects that tell Lambda how to authenticate with your schema registry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SchemaValidationConfigs": { + "target": "com.amazonaws.lambda#KafkaSchemaValidationConfigList", + "traits": { + "smithy.api#documentation": "An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Specific configuration settings for a Kafka schema registry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#KafkaSchemaValidationAttribute": { + "type": "enum", + "members": { + "KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#KafkaSchemaValidationConfig": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.lambda#KafkaSchemaValidationAttribute", + "traits": { + "smithy.api#documentation": " The attributes you want your schema registry to validate and filter for. If you selected JSON as the EventRecordFormat, Lambda also deserializes the selected message attributes.
Specific schema validation configuration settings that tell Lambda the message attributes you want to validate and filter using your schema registry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#KafkaSchemaValidationConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#KafkaSchemaValidationConfig", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LambdaManagedInstancesCapacityProviderConfig": { + "type": "structure", + "members": { + "CapacityProviderArn": { + "target": "com.amazonaws.lambda#CapacityProviderArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the capacity provider.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PerExecutionEnvironmentMaxConcurrency": { + "target": "com.amazonaws.lambda#PerExecutionEnvironmentMaxConcurrency", + "traits": { + "smithy.api#documentation": "The maximum number of concurrent execution environments that can run on each compute instance.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionEnvironmentMemoryGiBPerVCpu": { + "target": "com.amazonaws.lambda#ExecutionEnvironmentMemoryGiBPerVCpu", + "traits": { + "smithy.api#documentation": "The amount of memory in GiB allocated per vCPU for execution environments.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for Lambda-managed instances used by the capacity provider.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LastUpdateStatus": { + "type": "enum", + "members": { + "Successful": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LastUpdateStatusReason": { + "type": "string", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LastUpdateStatusReasonCode": { + "type": "enum", + "members": { + "EniLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EniLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InsufficientRolePermissions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientRolePermissions", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidConfiguration": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidConfiguration", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InternalError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalError", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SubnetOutOfIPAddresses": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SubnetOutOfIPAddresses", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidSubnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidSubnet", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidSecurityGroup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidSecurityGroup", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ImageDeleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageDeleted", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ImageAccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageAccessDenied", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidImage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidImage", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KMSKeyAccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMSKeyAccessDenied", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KMSKeyNotFound": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMSKeyNotFound", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidStateKMSKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidStateKMSKey", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DisabledKMSKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisabledKMSKey", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EFSIOError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSIOError", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EFSMountConnectivityError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSMountConnectivityError", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EFSMountFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSMountFailure", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EFSMountTimeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSMountTimeout", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidRuntime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidRuntime", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidZipFileException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidZipFileException", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ServiceQuotaExceededException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceQuotaExceededException", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VcpuLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VcpuLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CapacityProviderScalingLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CapacityProviderScalingLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InsufficientCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientCapacity", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EC2RequestLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2RequestLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorInitTimeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.InitTimeout", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorRuntimeInitError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.RuntimeInitError", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorExtensionInitError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.ExtensionInitError", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorInvalidEntryPoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.InvalidEntryPoint", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorInvalidWorkingDirectory": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.InvalidWorkingDirectory", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorPermissionDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.PermissionDenied", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorTooManyExtensions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.TooManyExtensions", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorInitResourceExhausted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.InitResourceExhausted", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DisallowedByVpcEncryptionControl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisallowedByVpcEncryptionControl", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DependencyError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DependencyError", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Layer": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.lambda#LayerVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function layer.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSize": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The size of the layer archive in bytes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SigningProfileVersionArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a signing profile version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SigningJobArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a signing job.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "An Lambda layer.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:layer:[a-zA-Z0-9-_]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#LayerVersionArn", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerPermissionAllowedAction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 22 + }, + "smithy.api#pattern": "^lambda:GetLayerVersion$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerPermissionAllowedPrincipal": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + }, + "smithy.api#pattern": "^\\d{12}|\\*|arn:(aws[a-zA-Z-]*):iam::\\d{12}:root$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerResource": { + "type": "resource", + "identifiers": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName" + } + }, + "list": { + "target": "com.amazonaws.lambda#ListLayers" + }, + "traits": { + "aws.api#arn": { + "template": "layer:{LayerName}" + }, + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "layer", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "Represents an AWS Lambda function layer", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerVersion": { + "type": "resource", + "identifiers": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName" + }, + "LayerVersion": { + "target": "com.amazonaws.lambda#String" + } + }, + "list": { + "target": "com.amazonaws.lambda#ListLayerVersions" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.lambda#AddLayerVersionPermission" + }, + { + "target": "com.amazonaws.lambda#DeleteLayerVersion" + }, + { + "target": "com.amazonaws.lambda#GetLayerVersion" + }, + { + "target": "com.amazonaws.lambda#GetLayerVersionByArn" + }, + { + "target": "com.amazonaws.lambda#GetLayerVersionPolicy" + }, + { + "target": "com.amazonaws.lambda#PublishLayerVersion" + }, + { + "target": "com.amazonaws.lambda#RemoveLayerVersionPermission" + } + ], + "traits": { + "aws.api#arn": { + "template": "layer:{LayerName}:{LayerVersion}" + }, + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "layerVersion", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "Represents a version of an AWS Lambda function layer", + "smithy.api#suppress": [ + "IamResourceTrait" + ], + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerVersionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^((arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+)|(arn:[a-zA-Z0-9-]+:lambda:::awslayer:[a-zA-Z0-9-_]+))$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerVersionContentInput": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.lambda#S3Bucket", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket of the layer archive.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3Key": { + "target": "com.amazonaws.lambda#S3Key", + "traits": { + "smithy.api#documentation": "The Amazon S3 key of the layer archive.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3ObjectVersion": { + "target": "com.amazonaws.lambda#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "For versioned objects, the version of the layer archive object to use.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3ObjectStorageMode": { + "target": "com.amazonaws.lambda#S3ObjectStorageMode", + "traits": { + "smithy.api#documentation": "Specifies how the layer archive is stored. Valid values:
COPY (default) – Uploads a copy of your layer archive to Lambda.
REFERENCE – Lambda references the layer archive from the specified Amazon S3 bucket.
The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "A ZIP archive that contains the contents of an Lambda layer. You can specify either an Amazon S3 location, or upload a layer archive directly.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerVersionContentOutput": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.lambda#SensitiveStringOnServerOnly", + "traits": { + "smithy.api#documentation": "A link to the layer archive in Amazon S3 that is valid for 10 minutes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSha256": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The SHA-256 hash of the layer archive.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSize": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The size of the layer archive in bytes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SigningProfileVersionArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a signing profile version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SigningJobArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a signing job.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ResolvedS3Object": { + "target": "com.amazonaws.lambda#ResolvedS3Object", + "traits": { + "smithy.api#documentation": "The resolved Amazon S3 object that contains the layer archive.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a version of an Lambda layer.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerVersionNumber": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerVersionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#LayerVersionsListItem", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayerVersionsListItem": { + "type": "structure", + "members": { + "LayerVersionArn": { + "target": "com.amazonaws.lambda#LayerVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the layer version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Version": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The version number.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "The description of the version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CreatedDate": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000.
A list of compatible instruction set architectures.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.lambda#CompatibleRuntimes", + "traits": { + "smithy.api#documentation": "The layer's compatible runtimes.
The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LicenseInfo": { + "target": "com.amazonaws.lambda#LicenseInfo", + "traits": { + "smithy.api#documentation": "The layer's open-source license.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a version of an Lambda layer.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayersList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#LayersListItem", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayersListItem": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "The name of the layer.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LayerArn": { + "target": "com.amazonaws.lambda#LayerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function layer.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LatestMatchingVersion": { + "target": "com.amazonaws.lambda#LayerVersionsListItem", + "traits": { + "smithy.api#documentation": "The newest version of the layer.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an Lambda layer.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LayersReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Layer", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LicenseInfo": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^.*$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListAliasesRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListAliasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of aliases for an AWS Lambda function", + "relativeDocumentation": "API_ListAliases.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Returns a list of aliases for a Lambda function.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns a list of aliases for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "Aliases": [ + { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BETA", + "Description": "Production environment BLUE.", + "FunctionVersion": "2", + "Name": "BLUE", + "RevisionId": "a410117f-xmpl-494e-8035-7e204bb7933b", + "RoutingConfig": { + "AdditionalVersionWeights": { + "1": 0.7 + } + } + }, + { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", + "Description": "Production environment GREEN.", + "FunctionVersion": "1", + "Name": "GREEN", + "RevisionId": "21d40116-xmpl-40ba-9360-3ea284da1bb5" + } + ] + }, + "title": "To list a function's aliases" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions/{FunctionName}/aliases", + "code": 200 + }, + "smithy.api#paginated": { + "items": "Aliases" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListAliasesRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionVersion": { + "target": "com.amazonaws.lambda#VersionWithLatestPublished", + "traits": { + "smithy.api#documentation": "Specify a function version to only list aliases that invoke that version.
", + "smithy.api#httpQuery": "FunctionVersion", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", + "traits": { + "smithy.api#documentation": "Limit the number of aliases returned.
", + "smithy.api#httpQuery": "MaxItems", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListAliasesResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The pagination token that's included if more results are available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Aliases": { + "target": "com.amazonaws.lambda#AliasList", + "traits": { + "smithy.api#documentation": "A list of aliases.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListCapacityProviders": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListCapacityProvidersRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListCapacityProvidersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of AWS Lambda capacity providers", + "relativeDocumentation": "API_ListCapacityProviders.html" + }, + "smithy.api#documentation": "Returns a list of capacity providers in your account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2025-11-30/capacity-providers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "pageSize": "MaxItems", + "items": "CapacityProviders" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListCapacityProvidersRequest": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.lambda#CapacityProviderState", + "traits": { + "smithy.api#documentation": "Filter capacity providers by their current state.
", + "smithy.api#httpQuery": "State", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxFiftyListItems", + "traits": { + "smithy.api#documentation": "The maximum number of capacity providers to return.
", + "smithy.api#httpQuery": "MaxItems", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListCapacityProvidersResponse": { + "type": "structure", + "members": { + "CapacityProviders": { + "target": "com.amazonaws.lambda#CapacityProvidersList", + "traits": { + "smithy.api#documentation": "A list of capacity providers in your account.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The pagination token that's included if more results are available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListCodeSigningConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListCodeSigningConfigsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListCodeSigningConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of AWS Lambda code signing configs", + "relativeDocumentation": "API_ListCodeSigningConfigs.html" + }, + "smithy.api#documentation": "Returns a list of code signing configurations. A request returns up to 10,000 configurations per call. You can use the MaxItems parameter to return fewer configurations per call.
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", + "traits": { + "smithy.api#documentation": "Maximum number of items to return.
", + "smithy.api#httpQuery": "MaxItems", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListCodeSigningConfigsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The pagination token that's included if more results are available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSigningConfigs": { + "target": "com.amazonaws.lambda#CodeSigningConfigList", + "traits": { + "smithy.api#documentation": "The code signing configurations
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListDurableExecutionsByFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListDurableExecutionsByFunctionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListDurableExecutionsByFunctionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of AWS Lambda durable executions of an AWS Lambda function", + "relativeDocumentation": "API_ListDurableExecutionsByFunction.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Returns a list of durable executions for a specified Lambda function. You can filter the results by execution name, status, and start time range. This API supports pagination for large result sets.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2025-12-01/functions/{FunctionName}/durable-executions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "DurableExecutions", + "pageSize": "MaxItems" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListDurableExecutionsByFunctionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function. You can specify a function name, a partial ARN, or a full ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "The function version or alias. If not specified, lists executions for the $LATEST version.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DurableExecutionName": { + "target": "com.amazonaws.lambda#DurableExecutionName", + "traits": { + "smithy.api#documentation": "Filter executions by name. Only executions with names that matches this string are returned.
", + "smithy.api#httpQuery": "DurableExecutionName", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Statuses": { + "target": "com.amazonaws.lambda#ExecutionStatusList", + "traits": { + "smithy.api#documentation": "Filter executions by status. Valid values: RUNNING, SUCCEEDED, FAILED, TIMED_OUT, STOPPED.
", + "smithy.api#httpQuery": "Statuses", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StartedAfter": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "Filter executions that started after this timestamp (ISO 8601 format).
", + "smithy.api#httpQuery": "StartedAfter", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StartedBefore": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "Filter executions that started before this timestamp (ISO 8601 format).
", + "smithy.api#httpQuery": "StartedBefore", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ReverseOrder": { + "target": "com.amazonaws.lambda#ReverseOrder", + "traits": { + "smithy.api#documentation": "Set to true to return results in chronological order (oldest first). Default is false.
", + "smithy.api#httpQuery": "ReverseOrder", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Pagination token from a previous request to continue retrieving results.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#ItemCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Maximum number of executions to return (1-1000). Default is 100.
", + "smithy.api#httpQuery": "MaxItems", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListDurableExecutionsByFunctionResponse": { + "type": "structure", + "members": { + "DurableExecutions": { + "target": "com.amazonaws.lambda#DurableExecutions", + "traits": { + "smithy.api#documentation": "List of durable execution summaries matching the filter criteria.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Pagination token for retrieving additional results. Present only if there are more results available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The response from the ListDurableExecutionsByFunction operation, containing a list of durable executions and pagination information.
", + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListEventSourceMappings": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListEventSourceMappingsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListEventSourceMappingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of AWS Lambda event source mappings", + "relativeDocumentation": "API_ListEventSourceMappings.html" + }, + "smithy.api#documentation": "Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source.
The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis – The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams – The ARN of the stream.
Amazon Simple Queue Service – The ARN of the queue.
Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).
Amazon MQ – The ARN of the broker.
Amazon DocumentDB – The ARN of the DocumentDB change stream.
The name or ARN of the Lambda function.
Name formats
Function name – MyFunction.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
", + "smithy.api#httpQuery": "FunctionName", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "A pagination token returned by a previous call.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", + "traits": { + "smithy.api#documentation": "The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of 100 items in each response, even if you set the number higher.
", + "smithy.api#httpQuery": "MaxItems", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListEventSourceMappingsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "A pagination token that's returned when the response doesn't contain all event source mappings.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EventSourceMappings": { + "target": "com.amazonaws.lambda#EventSourceMappingsList", + "traits": { + "smithy.api#documentation": "A list of event source mappings.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListFunctionEventInvokeConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListFunctionEventInvokeConfigsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListFunctionEventInvokeConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of configurations for asynchronous invocation for a function", + "relativeDocumentation": "API_ListFunctionEventInvokeConfigs.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Retrieves a list of configurations for asynchronous invocation for a function.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns a list of asynchronous invocation configurations for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "FunctionEventInvokeConfigs": [ + { + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", + "LastModified": 1.577824406719E9, + "MaximumEventAgeInSeconds": 1800, + "MaximumRetryAttempts": 2 + }, + { + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", + "LastModified": 1.577824396653E9, + "MaximumEventAgeInSeconds": 3600, + "MaximumRetryAttempts": 0 + } + ] + }, + "title": "To view a list of asynchronous invocation configurations" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config/list", + "code": 200 + }, + "smithy.api#paginated": { + "items": "FunctionEventInvokeConfigs" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListFunctionEventInvokeConfigsRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name - my-function.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxFunctionEventInvokeConfigListItems", + "traits": { + "smithy.api#documentation": "The maximum number of configurations to return.
", + "smithy.api#httpQuery": "MaxItems", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListFunctionEventInvokeConfigsResponse": { + "type": "structure", + "members": { + "FunctionEventInvokeConfigs": { + "target": "com.amazonaws.lambda#FunctionEventInvokeConfigList", + "traits": { + "smithy.api#documentation": "A list of configurations.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The pagination token that's included if more results are available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListFunctionUrlConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListFunctionUrlConfigsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListFunctionUrlConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:FunctionUrlAuthType" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to read function url configurations for a function", + "relativeDocumentation": "API_ListFunctionUrlConfigs.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Returns a list of Lambda function URLs for the specified function.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-10-31/functions/{FunctionName}/urls", + "code": 200 + }, + "smithy.api#paginated": { + "items": "FunctionUrlConfigs" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListFunctionUrlConfigsRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionUrlFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxItems", + "traits": { + "smithy.api#documentation": "The maximum number of function URLs to return in the response. Note that ListFunctionUrlConfigs returns a maximum of 50 items in each response, even if you set the number higher.
A list of function URL configurations.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The pagination token that's included if more results are available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListFunctionVersionsByCapacityProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListFunctionVersionsByCapacityProviderRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListFunctionVersionsByCapacityProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of AWS Lambda function versions by the capacity provider assigned", + "relativeDocumentation": "API_ListFunctionVersionsByCapacityProvider.html", + "resources": { + "required": { + "capacityProvider": {} + } + } + }, + "smithy.api#documentation": "Returns a list of function versions that are configured to use a specific capacity provider.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2025-11-30/capacity-providers/{CapacityProviderName}/function-versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "pageSize": "MaxItems", + "items": "FunctionVersions" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListFunctionVersionsByCapacityProviderRequest": { + "type": "structure", + "members": { + "CapacityProviderName": { + "target": "com.amazonaws.lambda#CapacityProviderName", + "traits": { + "smithy.api#documentation": "The name of the capacity provider to list function versions for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxFiftyListItems", + "traits": { + "smithy.api#documentation": "The maximum number of function versions to return in the response.
", + "smithy.api#httpQuery": "MaxItems", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListFunctionVersionsByCapacityProviderResponse": { + "type": "structure", + "members": { + "CapacityProviderArn": { + "target": "com.amazonaws.lambda#CapacityProviderArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the capacity provider.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionVersions": { + "target": "com.amazonaws.lambda#FunctionVersionsByCapacityProviderList", + "traits": { + "smithy.api#documentation": "A list of function versions that use the specified capacity provider.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The pagination token that's included if more results are available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListFunctions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListFunctionsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListFunctionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of AWS Lambda functions, with the version-specific configuration of each function", + "relativeDocumentation": "API_ListFunctions.html" + }, + "smithy.api#documentation": "Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.
Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.
The ListFunctions operation returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use GetFunction.
List the functions that use the specified code signing configuration. You can use this method prior to deleting a code signing configuration, to verify that no functions are using it.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}/functions", + "code": 200 + }, + "smithy.api#paginated": { + "items": "FunctionArns" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListFunctionsByCodeSigningConfigRequest": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "The The Amazon Resource Name (ARN) of the code signing configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", + "traits": { + "smithy.api#documentation": "Maximum number of items to return.
", + "smithy.api#httpQuery": "MaxItems", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListFunctionsByCodeSigningConfigResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The pagination token that's included if more results are available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionArns": { + "target": "com.amazonaws.lambda#FunctionArnList", + "traits": { + "smithy.api#documentation": "The function ARNs.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListFunctionsRequest": { + "type": "structure", + "members": { + "MasterRegion": { + "target": "com.amazonaws.lambda#MasterRegion", + "traits": { + "smithy.api#documentation": "For Lambda@Edge functions, the Amazon Web Services Region of the master function. For example, us-east-1 filters the list of functions to include only Lambda@Edge functions replicated from a master function in US East (N. Virginia). If specified, you must set FunctionVersion to ALL.
Set to ALL to include entries for all published versions of each function.
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", + "traits": { + "smithy.api#documentation": "The maximum number of functions to return in the response. Note that ListFunctions returns a maximum of 50 items in each response, even if you set the number higher.
The pagination token that's included if more results are available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Functions": { + "target": "com.amazonaws.lambda#FunctionList", + "traits": { + "smithy.api#documentation": "A list of Lambda functions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "A list of Lambda functions.
", + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListLayerVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListLayerVersionsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListLayerVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of versions of an AWS Lambda layer", + "relativeDocumentation": "API_ListLayerVersions.html" + }, + "smithy.api#documentation": "Lists the versions of an Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layer versions that are compatible with that architecture.
", + "smithy.api#examples": [ + { + "documentation": "The following example displays information about the versions for the layer named blank-java-lib", + "input": { + "LayerName": "blank-java-lib" + }, + "output": { + "LayerVersions": [ + { + "CompatibleRuntimes": [ + "java8" + ], + "CreatedDate": "2020-03-18T23:38:42.284+0000", + "Description": "Dependencies for the blank-java sample app.", + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-java-lib:7", + "Version": 7 + }, + { + "CompatibleRuntimes": [ + "java8" + ], + "CreatedDate": "2020-03-17T07:24:21.960+0000", + "Description": "Dependencies for the blank-java sample app.", + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-java-lib:6", + "Version": 6 + } + ] + }, + "title": "To list versions of a layer" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2018-10-31/layers/{LayerName}/versions", + "code": 200 + }, + "smithy.api#paginated": { + "items": "LayerVersions" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListLayerVersionsRequest": { + "type": "structure", + "members": { + "CompatibleArchitecture": { + "target": "com.amazonaws.lambda#Architecture", + "traits": { + "smithy.api#documentation": "The compatible instruction set architecture.
", + "smithy.api#httpQuery": "CompatibleArchitecture", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CompatibleRuntime": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#documentation": "A runtime identifier.
The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
", + "smithy.api#httpQuery": "CompatibleRuntime", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the layer.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "A pagination token returned by a previous call.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxLayerListItems", + "traits": { + "smithy.api#documentation": "The maximum number of versions to return.
", + "smithy.api#httpQuery": "MaxItems", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListLayerVersionsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "A pagination token returned when the response doesn't contain all versions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LayerVersions": { + "target": "com.amazonaws.lambda#LayerVersionsList", + "traits": { + "smithy.api#documentation": "A list of versions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListLayers": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListLayersRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListLayersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of AWS Lambda layers, with details about the latest version of each layer", + "relativeDocumentation": "API_ListLayers.html" + }, + "smithy.api#documentation": "Lists Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layers that are compatible with that instruction set architecture.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns information about layers that are compatible with the Python 3.7 runtime.", + "input": { + "CompatibleRuntime": "python3.7" + }, + "output": { + "Layers": [ + { + "LatestMatchingVersion": { + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ], + "CreatedDate": "2018-11-15T00:37:46.592+0000", + "Description": "My layer", + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", + "Version": 2 + }, + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", + "LayerName": "my-layer" + } + ] + }, + "title": "To list the layers that are compatible with your function's runtime" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2018-10-31/layers", + "code": 200 + }, + "smithy.api#paginated": { + "items": "Layers" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListLayersRequest": { + "type": "structure", + "members": { + "CompatibleArchitecture": { + "target": "com.amazonaws.lambda#Architecture", + "traits": { + "smithy.api#documentation": "The compatible instruction set architecture.
", + "smithy.api#httpQuery": "CompatibleArchitecture", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CompatibleRuntime": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#documentation": "A runtime identifier.
The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
", + "smithy.api#httpQuery": "CompatibleRuntime", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "A pagination token returned by a previous call.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxLayerListItems", + "traits": { + "smithy.api#documentation": "The maximum number of layers to return.
", + "smithy.api#httpQuery": "MaxItems", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListLayersResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "A pagination token returned when the response doesn't contain all layers.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Layers": { + "target": "com.amazonaws.lambda#LayersList", + "traits": { + "smithy.api#documentation": "A list of function layers.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListProvisionedConcurrencyConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListProvisionedConcurrencyConfigsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListProvisionedConcurrencyConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of provisioned concurrency configurations for an AWS Lambda function", + "relativeDocumentation": "API_ListProvisionedConcurrencyConfigs.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Retrieves a list of provisioned concurrency configurations for a function.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns a list of provisioned concurrency configurations for a function named my-function.", + "input": { + "FunctionName": "my-function" + }, + "output": { + "ProvisionedConcurrencyConfigs": [ + { + "AllocatedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", + "LastModified": "2019-12-31T20:29:00+0000", + "RequestedProvisionedConcurrentExecutions": 100, + "Status": "READY" + }, + { + "AllocatedProvisionedConcurrentExecutions": 100, + "AvailableProvisionedConcurrentExecutions": 100, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", + "LastModified": "2019-12-31T20:28:49+0000", + "RequestedProvisionedConcurrentExecutions": 100, + "Status": "READY" + } + ] + }, + "title": "To get a list of provisioned concurrency configurations" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency?List=ALL", + "code": 200 + }, + "smithy.api#paginated": { + "items": "ProvisionedConcurrencyConfigs" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListProvisionedConcurrencyConfigsRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxProvisionedConcurrencyConfigListItems", + "traits": { + "smithy.api#documentation": "Specify a number to limit the number of configurations returned.
", + "smithy.api#httpQuery": "MaxItems", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListProvisionedConcurrencyConfigsResponse": { + "type": "structure", + "members": { + "ProvisionedConcurrencyConfigs": { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyConfigList", + "traits": { + "smithy.api#documentation": "A list of provisioned concurrency configurations.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The pagination token that's included if more results are available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListTagsRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of tags for an AWS Lambda function, event source mapping, capacity provider, or code signing configuration resource", + "relativeDocumentation": "API_ListTags.html", + "resources": { + "optional": { + "eventSourceMapping": {}, + "function": {}, + "code signing config": {}, + "capacityProvider": {} + } + } + }, + "smithy.api#documentation": "Returns a function, event source mapping, or code signing configuration's tags. You can also view function tags with GetFunction.
", + "smithy.api#examples": [ + { + "documentation": "The following example displays the tags attached to the my-function Lambda function.", + "input": { + "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function" + }, + "output": { + "Tags": { + "Category": "Web Tools", + "Department": "Sales" + } + }, + "title": "To retrieve the list of tags for a Lambda function" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2017-03-31/tags/{Resource}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListTagsRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.lambda#TaggableResource", + "traits": { + "smithy.api#documentation": "The resource's Amazon Resource Name (ARN). Note: Lambda does not support adding tags to function aliases or versions.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "The function's tags.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListVersionsByFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#ListVersionsByFunctionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#ListVersionsByFunctionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of versions for an AWS Lambda function", + "relativeDocumentation": "API_ListVersionsByFunction.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.
", + "smithy.api#examples": [ + { + "documentation": "The following example returns a list of versions of a function named my-function", + "input": { + "FunctionName": "my-function" + }, + "output": { + "Versions": [ + { + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "DurableConfig": { + "ExecutionTimeout": 31622400, + "RetentionPeriodInDays": 30 + }, + "Environment": { + "Variables": { + "BUCKET": "my-bucket-1xpuxmplzrlbh", + "PREFIX": "inbound" + } + }, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "FunctionName": "my-function", + "Handler": "index.handler", + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "LastModified": "2020-04-10T19:06:32.563+0000", + "MemorySize": 256, + "RevisionId": "850ca006-2d98-4ff4-86db-8766e9d32fe9", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Runtime": "nodejs12.x", + "Timeout": 15, + "TracingConfig": { + "Mode": "Active" + }, + "Version": "$LATEST" + }, + { + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "DurableConfig": { + "ExecutionTimeout": 31622400, + "RetentionPeriodInDays": 30 + }, + "Environment": { + "Variables": { + "BUCKET": "my-bucket-1xpuxmplzrlbh", + "PREFIX": "inbound" + } + }, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "FunctionName": "my-function", + "Handler": "index.handler", + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "LastModified": "2020-04-10T19:06:32.563+0000", + "MemorySize": 256, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Runtime": "nodejs12.x", + "Timeout": 5, + "TracingConfig": { + "Mode": "Active" + }, + "Version": "1" + } + ] + }, + "title": "To list versions of a function" + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2015-03-31/functions/{FunctionName}/versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "pageSize": "MaxItems", + "items": "Versions" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ListVersionsByFunctionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "Marker", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", + "traits": { + "smithy.api#documentation": "The maximum number of versions to return. Note that ListVersionsByFunction returns a maximum of 50 items in each response, even if you set the number higher.
The pagination token that's included if more results are available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Versions": { + "target": "com.amazonaws.lambda#FunctionList", + "traits": { + "smithy.api#documentation": "A list of Lambda function versions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LocalMountPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 160 + }, + "smithy.api#pattern": "^/mnt/[a-zA-Z0-9-_.]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LogFormat": { + "type": "enum", + "members": { + "Json": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Text": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Text", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LogGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LogType": { + "type": "enum", + "members": { + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Tail": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Tail", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#LoggingConfig": { + "type": "structure", + "members": { + "LogFormat": { + "target": "com.amazonaws.lambda#LogFormat", + "traits": { + "smithy.api#documentation": "The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ApplicationLogLevel": { + "target": "com.amazonaws.lambda#ApplicationLogLevel", + "traits": { + "smithy.api#documentation": "Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.
Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.
The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.
The function's Amazon CloudWatch Logs configuration settings.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MasterRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^ALL|(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaxAge": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 86400 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaxFiftyListItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaxFunctionEventInvokeConfigListItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaxItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaxLayerListItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaxListItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaxProvisionedConcurrencyConfigListItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaximumBatchingWindowInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 300 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaximumConcurrency": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 2, + "max": 1000 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaximumEventAgeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 21600 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaximumNumberOfPollers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaximumRecordAgeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -1, + "max": 604800 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaximumRetryAttempts": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 2 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -1, + "max": 10000 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MemorySize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 128, + "max": 32768 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Method": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6 + }, + "smithy.api#pattern": ".*", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MetricTargetValue": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#MinimumNumberOfPollers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ModeNotSupportedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda function doesn't support the invocation mode requested. For example, calling Invoke with InvocationType=RequestResponse on a function configured for asynchronous-only invocation, or vice versa. For more information about invocation types, see Invoking Lambda functions.
The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The function has no published versions available.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#NonNegativeInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#NullableBoolean": { + "type": "boolean", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^\\$(LATEST(\\.PUBLISHED)?)|[a-zA-Z0-9-_$]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OnFailure": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.lambda#DestinationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination resource.
To retain records of failed invocations from Kinesis, DynamoDB, self-managed Apache Kafka, or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, or Kafka topic as the destination.
Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations.
To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "A destination for events that failed processing. For more information, see Adding a destination.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OnSuccess": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.lambda#DestinationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination resource.
Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations.
A destination for events that were processed successfully.
To retain records of successful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.
OnSuccess is not supported in CreateEventSourceMapping or UpdateEventSourceMapping requests.
The unique identifier for this operation.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ParentId": { + "target": "com.amazonaws.lambda#OperationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the parent operation, if this operation is running within a child context.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Name": { + "target": "com.amazonaws.lambda#OperationName", + "traits": { + "smithy.api#documentation": "The customer-provided name for this operation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Type": { + "target": "com.amazonaws.lambda#OperationType", + "traits": { + "smithy.api#documentation": "The type of operation.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SubType": { + "target": "com.amazonaws.lambda#OperationSubType", + "traits": { + "smithy.api#documentation": "The subtype of the operation, providing additional categorization.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StartTimestamp": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the operation started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EndTimestamp": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the operation ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Status": { + "target": "com.amazonaws.lambda#OperationStatus", + "traits": { + "smithy.api#documentation": "The current status of the operation.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ExecutionDetails": { + "target": "com.amazonaws.lambda#ExecutionDetails", + "traits": { + "smithy.api#documentation": "Details about the execution, if this operation represents an execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ContextDetails": { + "target": "com.amazonaws.lambda#ContextDetails", + "traits": { + "smithy.api#documentation": "Details about the context, if this operation represents a context.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StepDetails": { + "target": "com.amazonaws.lambda#StepDetails", + "traits": { + "smithy.api#documentation": "Details about the step, if this operation represents a step.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "WaitDetails": { + "target": "com.amazonaws.lambda#WaitDetails", + "traits": { + "smithy.api#documentation": "Details about the wait operation, if this operation represents a wait.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CallbackDetails": { + "target": "com.amazonaws.lambda#CallbackDetails", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ChainedInvokeDetails": { + "target": "com.amazonaws.lambda#ChainedInvokeDetails", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Information about an operation within a durable execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OperationAction": { + "type": "enum", + "members": { + "START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SUCCEED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEED", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAIL", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RETRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRY", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CANCEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OperationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OperationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\x20-\\x7E]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OperationPayload": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6291456 + }, + "smithy.api#sensitive": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OperationStatus": { + "type": "enum", + "members": { + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMED_OUT", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OperationSubType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OperationType": { + "type": "enum", + "members": { + "EXECUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTION", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CONTEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTEXT", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "STEP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STEP", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "WAIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WAIT", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CALLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALLBACK", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CHAINED_INVOKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHAINED_INVOKE", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OperationUpdate": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.lambda#OperationId", + "traits": { + "smithy.api#documentation": "The unique identifier for this operation.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ParentId": { + "target": "com.amazonaws.lambda#OperationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the parent operation, if this operation is running within a child context.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Name": { + "target": "com.amazonaws.lambda#OperationName", + "traits": { + "smithy.api#documentation": "The customer-provided name for this operation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Type": { + "target": "com.amazonaws.lambda#OperationType", + "traits": { + "smithy.api#documentation": "The type of operation to update.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SubType": { + "target": "com.amazonaws.lambda#OperationSubType", + "traits": { + "smithy.api#documentation": "The subtype of the operation, providing additional categorization.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Action": { + "target": "com.amazonaws.lambda#OperationAction", + "traits": { + "smithy.api#documentation": "The action to take on the operation.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Payload": { + "target": "com.amazonaws.lambda#OperationPayload", + "traits": { + "smithy.api#documentation": "The payload for successful operations. The maximum payload size is 6 MB for synchronous EXECUTION operations (RequestResponse invocationType), 1 MB for asynchronous EXECUTION (Event invocationType) and CHAINED_INVOKE operations, and 256 KB for CONTEXT, STEP, WAIT, and CALLBACK operations.
The error information for failed operations.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ContextOptions": { + "target": "com.amazonaws.lambda#ContextOptions", + "traits": { + "smithy.api#documentation": "Options for context operations.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StepOptions": { + "target": "com.amazonaws.lambda#StepOptions", + "traits": { + "smithy.api#documentation": "Options for step operations.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "WaitOptions": { + "target": "com.amazonaws.lambda#WaitOptions", + "traits": { + "smithy.api#documentation": "Options for wait operations.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CallbackOptions": { + "target": "com.amazonaws.lambda#CallbackOptions", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ChainedInvokeOptions": { + "target": "com.amazonaws.lambda#ChainedInvokeOptions", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "An update to be applied to an operation during checkpointing.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OperationUpdates": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#OperationUpdate", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Operations": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Operation", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OrganizationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 34 + }, + "smithy.api#pattern": "^o-[a-z0-9]{10,32}$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Origin": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": ".*", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#OutputPayload": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6291456 + }, + "smithy.api#sensitive": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PackageType": { + "type": "enum", + "members": { + "Zip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Zip", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Image": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Image", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ParallelizationFactor": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Pattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": "^[\\s\\S]*$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PerExecutionEnvironmentMaxConcurrency": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1600 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Permission": { + "type": "resource", + "identifiers": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName" + }, + "StatementId": { + "target": "com.amazonaws.lambda#StatementId" + } + }, + "collectionOperations": [ + { + "target": "com.amazonaws.lambda#AddPermission" + }, + { + "target": "com.amazonaws.lambda#RemovePermission" + } + ], + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PolicyLengthExceededException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The permissions policy for the resource is too large. For more information, see Lambda quotas.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PreconditionFailedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The RevisionId provided does not match the latest RevisionId for the Lambda function or alias.
For AddPermission and RemovePermission API operations: Call GetPolicy to retrieve the latest RevisionId for your resource.
For all other API operations: Call GetFunction or GetAlias to retrieve the latest RevisionId for your resource.
The tag propagation mode. Set to Explicit to propagate the tags specified in ExplicitTags to managed resources. Set to None to disable tag propagation.
A list of tags to apply to managed resources when Mode is set to Explicit. You can specify up to 40 tags.
Configuration for tag propagation to managed resources launched by the capacity provider.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PropagateTagsMode": { + "type": "enum", + "members": { + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Tag propagation is disabled. No tags are applied to managed resources.
", + "smithy.api#enumValue": "None", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Explicit": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Tags specified in ExplicitTags are applied to managed resources at launch.
The Amazon Resource Name (ARN) of the alias or version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RequestedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#PositiveInteger", + "traits": { + "smithy.api#documentation": "The amount of provisioned concurrency requested.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AvailableProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "The amount of provisioned concurrency available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AllocatedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Status": { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyStatusEnum", + "traits": { + "smithy.api#documentation": "The status of the allocation process.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StatusReason": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "For failed allocations, the reason that provisioned concurrency could not be allocated.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that a user last updated the configuration, in ISO 8601 format.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the provisioned concurrency configuration for a function alias or version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ProvisionedConcurrencyConfigNotFoundException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The specified configuration does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ProvisionedConcurrencyStatusEnum": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ProvisionedPollerConfig": { + "type": "structure", + "members": { + "MinimumPollers": { + "target": "com.amazonaws.lambda#MinimumNumberOfPollers", + "traits": { + "smithy.api#documentation": "The minimum number of event pollers this event source can scale down to. For Amazon SQS events source mappings, default is 2, and minimum 2 required. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 1.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumPollers": { + "target": "com.amazonaws.lambda#MaximumNumberOfPollers", + "traits": { + "smithy.api#documentation": "The maximum number of event pollers this event source can scale up to. For Amazon SQS events source mappings, default is 200, and minimum value allowed is 2. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 200, and minimum value allowed is 1.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PollerGroupName": { + "target": "com.amazonaws.lambda#ProvisionedPollerGroupName", + "traits": { + "smithy.api#documentation": "(Amazon MSK and self-managed Apache Kafka) The name of the provisioned poller group. Use this option to group multiple ESMs within the event source's VPC to share Event Poller Unit (EPU) capacity. You can use this option to optimize Provisioned mode costs for your ESMs. You can group up to 100 ESMs per poller group and aggregate maximum pollers across all ESMs in a group cannot exceed 2000.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The provisioned mode configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers for your event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ProvisionedPollerGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]*$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PublicPolicyException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The resource-based policy you tried to add to the Lambda function would grant public access to it, and your account's BlockPublicAccess setting prevents public access. For more information about blocking public access to Lambda functions, see Block public access to Lambda resources.
Creates an Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
", + "smithy.api#examples": [ + { + "documentation": "The following example creates a new Python library layer version. The command retrieves the layer content a file named layer.zip in the specified S3 bucket.", + "input": { + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ], + "Content": { + "S3Bucket": "lambda-layers-us-west-2-123456789012", + "S3Key": "layer.zip" + }, + "Description": "My Python layer", + "LayerName": "my-layer", + "LicenseInfo": "MIT" + }, + "output": { + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ], + "Content": { + "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", + "CodeSize": 169, + "Location": "https://awslambda-us-west-2-layers.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH..." + }, + "CreatedDate": "2018-11-14T23:03:52.894+0000", + "Description": "My Python layer", + "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer", + "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1", + "LicenseInfo": "MIT", + "Version": 1 + }, + "title": "To create a Lambda layer version" + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2018-10-31/layers/{LayerName}/versions", + "code": 201 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PublishLayerVersionRequest": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the layer.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "The description of the version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Content": { + "target": "com.amazonaws.lambda#LayerVersionContentInput", + "traits": { + "smithy.api#documentation": "The function layer archive.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CompatibleArchitectures": { + "target": "com.amazonaws.lambda#CompatibleArchitectures", + "traits": { + "smithy.api#documentation": "A list of compatible instruction set architectures.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.lambda#CompatibleRuntimes", + "traits": { + "smithy.api#documentation": "A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.
The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LicenseInfo": { + "target": "com.amazonaws.lambda#LicenseInfo", + "traits": { + "smithy.api#documentation": "The layer's software license. It can be any of the following:
An SPDX license identifier. For example, MIT.
The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.
The full text of the license.
Details about the layer version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LayerArn": { + "target": "com.amazonaws.lambda#LayerArn", + "traits": { + "smithy.api#documentation": "The ARN of the layer.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LayerVersionArn": { + "target": "com.amazonaws.lambda#LayerVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the layer version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "The description of the version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CreatedDate": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Version": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The version number.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CompatibleArchitectures": { + "target": "com.amazonaws.lambda#CompatibleArchitectures", + "traits": { + "smithy.api#documentation": "A list of compatible instruction set architectures.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.lambda#CompatibleRuntimes", + "traits": { + "smithy.api#documentation": "The layer's compatible runtimes.
The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LicenseInfo": { + "target": "com.amazonaws.lambda#LicenseInfo", + "traits": { + "smithy.api#documentation": "The layer's software license.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PublishVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PublishVersionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeStorageExceededException" + }, + { + "target": "com.amazonaws.lambda#FunctionVersionsPerCapacityProviderLimitExceededException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create an AWS Lambda function version", + "relativeDocumentation": "API_PublishVersion.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.
Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version.
Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.
", + "smithy.api#examples": [ + { + "documentation": "This operation publishes a version of a Lambda function", + "input": { + "CodeSha256": "", + "Description": "", + "FunctionName": "myFunction" + }, + "output": { + "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", + "CodeSize": 5797206, + "Description": "Process image objects from Amazon S3.", + "Environment": { + "Variables": { + "BUCKET": "my-bucket-1xpuxmplzrlbh", + "PREFIX": "inbound" + } + }, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "FunctionName": "my-function", + "Handler": "index.handler", + "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", + "LastModified": "2020-04-10T19:06:32.563+0000", + "LastUpdateStatus": "Successful", + "MemorySize": 256, + "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Runtime": "nodejs12.x", + "State": "Active", + "Timeout": 5, + "TracingConfig": { + "Mode": "Active" + }, + "Version": "1" + }, + "title": "To publish a version of a Lambda function" + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2015-03-31/functions/{FunctionName}/versions", + "code": 201 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PublishVersionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSha256": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "A description for the version to override the description in the function configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PublishTo": { + "target": "com.amazonaws.lambda#FunctionVersionLatestPublished", + "traits": { + "smithy.api#documentation": "Specifies where to publish the function version or configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PublishedFunctionQualifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(\\$LATEST\\.PUBLISHED|[0-9]+)$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutFunctionCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PutFunctionCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#PutFunctionCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeSigningConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:CodeSigningConfigArn" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to attach a code signing config to an AWS Lambda function", + "relativeDocumentation": "API_PutFunctionCodeSigningConfig.html", + "resources": { + "required": { + "function": {}, + "code signing config": {} + } + } + }, + "smithy.api#documentation": "Update the code signing configuration for the function. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2020-06-30/functions/{FunctionName}/code-signing-config", + "code": 200 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutFunctionCodeSigningConfigRequest": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "The The Amazon Resource Name (ARN) of the code signing configuration.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutFunctionCodeSigningConfigResponse": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "The The Amazon Resource Name (ARN) of the code signing configuration.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutFunctionConcurrency": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PutFunctionConcurrencyRequest" + }, + "output": { + "target": "com.amazonaws.lambda#Concurrency" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to configure reserved concurrency for an AWS Lambda function", + "relativeDocumentation": "API_PutFunctionConcurrency.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.
Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.
Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Lambda function scaling.
", + "smithy.api#examples": [ + { + "documentation": "The following example configures 100 reserved concurrent executions for the my-function function.", + "input": { + "FunctionName": "my-function", + "ReservedConcurrentExecutions": 100 + }, + "output": { + "ReservedConcurrentExecutions": 100 + }, + "title": "To configure a reserved concurrency limit for a function" + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/2017-10-31/functions/{FunctionName}/concurrency", + "code": 200 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutFunctionConcurrencyRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ReservedConcurrentExecutions": { + "target": "com.amazonaws.lambda#ReservedConcurrentExecutions", + "traits": { + "smithy.api#documentation": "The number of simultaneous executions to reserve for the function.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutFunctionEventInvokeConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PutFunctionEventInvokeConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionEventInvokeConfig" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to configure options for asynchronous invocation on an AWS Lambda function, version, or alias", + "relativeDocumentation": "API_PutFunctionEventInvokeConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use UpdateFunctionEventInvokeConfig.
By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration.
To send an invocation record to a queue, topic, S3 bucket, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.
S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.
The name or ARN of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "A version number or alias name.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttempts", + "traits": { + "smithy.api#documentation": "The maximum number of times to retry when the function returns an error.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumEventAgeInSeconds", + "traits": { + "smithy.api#documentation": "The maximum age of a request that Lambda sends to a function for processing.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", + "traits": { + "smithy.api#documentation": "A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of a standard SQS queue.
Bucket - The ARN of an Amazon S3 bucket.
Topic - The ARN of a standard SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.
Sets your function's recursive loop detection configuration.
When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service (Amazon SQS) queue, which then invokes the same function. This invocation causes the function to write another message to the queue, which in turn invokes the function again.
Lambda can detect certain types of recursive loops shortly after they occur. When Lambda detects a recursive loop and your function's recursive loop detection configuration is set to Terminate, it stops your function being invoked and notifies you.
The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RecursiveLoop": { + "target": "com.amazonaws.lambda#RecursiveLoop", + "traits": { + "smithy.api#documentation": "If you set your function's recursive loop detection configuration to Allow, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop. We recommend that you only use this setting if your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes it.
If you set your function's recursive loop detection configuration to Terminate, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.
By default, Lambda sets your function's configuration to Terminate.
If your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes the function, then use caution and implement suitable guard rails to prevent unexpected charges being billed to your Amazon Web Services account. To learn more about best practices for using recursive invocation patterns, see Recursive patterns that cause run-away Lambda functions in Serverless Land.
The status of your function's recursive loop detection configuration.
When this value is set to Allowand Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action.
When this value is set to Terminate and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.
Sets the scaling configuration for a Lambda Managed Instances function. The scaling configuration defines the minimum and maximum number of execution environments that can be provisioned for the function, allowing you to control scaling behavior and resource allocation.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2025-11-30/functions/{FunctionName}/function-scaling-config", + "code": 202 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutFunctionScalingConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#UnqualifiedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#PublishedFunctionQualifier", + "traits": { + "smithy.api#documentation": "Specify a version or alias to set the scaling configuration for a published version of the function.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionScalingConfig": { + "target": "com.amazonaws.lambda#FunctionScalingConfig", + "traits": { + "smithy.api#documentation": "The scaling configuration to apply to the function, including minimum and maximum execution environment limits.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutFunctionScalingConfigResponse": { + "type": "structure", + "members": { + "FunctionState": { + "target": "com.amazonaws.lambda#State", + "traits": { + "smithy.api#documentation": "The current state of the function after applying the scaling configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutProvisionedConcurrencyConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PutProvisionedConcurrencyConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#PutProvisionedConcurrencyConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to configure provisioned concurrency for an AWS Lambda function's alias or version", + "relativeDocumentation": "API_PutProvisionedConcurrencyConfig.html", + "resources": { + "optional": { + "function version": {}, + "function alias": {} + } + } + }, + "smithy.api#documentation": "Adds a provisioned concurrency configuration to a function's alias or version.
", + "smithy.api#examples": [ + { + "documentation": "The following example allocates 100 provisioned concurrency for the BLUE alias of the specified function.", + "input": { + "FunctionName": "my-function", + "ProvisionedConcurrentExecutions": 100, + "Qualifier": "BLUE" + }, + "output": { + "AllocatedProvisionedConcurrentExecutions": 0, + "LastModified": "2019-11-21T19:32:12+0000", + "RequestedProvisionedConcurrentExecutions": 100, + "Status": "IN_PROGRESS" + }, + "title": "To allocate provisioned concurrency" + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency", + "code": 202 + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutProvisionedConcurrencyConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "The version number or alias name.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#PositiveInteger", + "traits": { + "smithy.api#documentation": "The amount of provisioned concurrency to allocate for the version or alias.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutProvisionedConcurrencyConfigResponse": { + "type": "structure", + "members": { + "RequestedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#PositiveInteger", + "traits": { + "smithy.api#documentation": "The amount of provisioned concurrency requested.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AllocatedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AvailableProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "The amount of provisioned concurrency available.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Status": { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyStatusEnum", + "traits": { + "smithy.api#documentation": "The status of the allocation process.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StatusReason": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "For failed allocations, the reason that provisioned concurrency could not be allocated.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that a user last updated the configuration, in ISO 8601 format.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutRuntimeManagementConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#PutRuntimeManagementConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#PutRuntimeManagementConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update the runtime management configuration of an AWS Lambda function", + "relativeDocumentation": "API_PutRuntimeManagementConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2021-07-20/functions/{FunctionName}/runtime-management-config", + "code": 200 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#PutRuntimeManagementConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.
Specify the runtime update mode.
Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.
Function update - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.
Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.
The ARN of the runtime version you want the function to use.
This is only required if you're using the Manual runtime update mode.
The runtime update mode.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "The ARN of the function
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RuntimeVersionArn": { + "target": "com.amazonaws.lambda#RuntimeVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null is returned.
The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda has detected your function being invoked in a recursive loop with other Amazon Web Services resources and stopped your function's invocation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#RecursiveLoop": { + "type": "enum", + "members": { + "Allow": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Allow", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Terminate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminate", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#RemoveLayerVersionPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#RemoveLayerVersionPermissionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to remove a statement from the permissions policy for a version of an AWS Lambda layer", + "relativeDocumentation": "API_RemoveLayerVersionPermission.html", + "resources": { + "required": { + "layerVersion": {} + } + } + }, + "smithy.api#documentation": "Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.
", + "smithy.api#examples": [ + { + "documentation": "The following example deletes permission for an account to configure a layer version.", + "input": { + "LayerName": "my-layer", + "StatementId": "xaccount", + "VersionNumber": 1 + }, + "title": "To delete layer-version permissions" + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy/{StatementId}", + "code": 204 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#RemoveLayerVersionPermissionRequest": { + "type": "structure", + "members": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the layer.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VersionNumber": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The version number.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StatementId": { + "target": "com.amazonaws.lambda#StatementId", + "traits": { + "smithy.api#documentation": "The identifier that was specified when the statement was added.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
", + "smithy.api#httpQuery": "RevisionId", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "aws.api#data": "permissions", + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#RemovePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#RemovePermissionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#PublicPolicyException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:FunctionUrlAuthType", + "lambda:Principal" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to revoke function-use permission from an AWS service or another account", + "relativeDocumentation": "API_RemovePermission.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Revokes function-use permission from an Amazon Web Services service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy.
", + "smithy.api#examples": [ + { + "documentation": "The following example removes a permissions statement named xaccount from the PROD alias of a function named my-function.", + "input": { + "FunctionName": "my-function", + "Qualifier": "PROD", + "StatementId": "xaccount" + }, + "title": "To remove a Lambda function's permissions" + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2015-03-31/functions/{FunctionName}/policy/{StatementId}", + "code": 204 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#RemovePermissionRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
Name formats
Function name – my-function (name-only), my-function:v1 (with alias).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "StatementId": { + "target": "com.amazonaws.lambda#NamespacedStatementId", + "traits": { + "smithy.api#documentation": "Statement ID of the permission to remove.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "Specify a version or alias to remove permissions from a published version of the function.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
", + "smithy.api#httpQuery": "RevisionId", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "aws.api#data": "permissions", + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ReplayChildren": { + "type": "boolean", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#RequestTooLargeException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The request payload exceeded the Invoke request body JSON input quota. For more information, see Lambda quotas.
The Amazon S3 bucket that contains the deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3Key": { + "target": "com.amazonaws.lambda#S3Key", + "traits": { + "smithy.api#documentation": "The Amazon S3 key of the deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3ObjectVersion": { + "target": "com.amazonaws.lambda#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "The version of the deployment package object.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the resolved Amazon S3 object that contains a function's deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + }, + "smithy.api#pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ResourceConflictException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The resource already exists, or another operation is in progress.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ResourceInUseException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The operation conflicts with the resource's availability. For example, you tried to update an event source mapping in the CREATING state, or you tried to delete an event source mapping currently UPDATING.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ResourceNotFoundException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The resource specified in the request does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ResourceNotReadyException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The function is inactive and its VPC connection is no longer available. Wait for the VPC connection to reestablish and try again.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ResponseStreamingInvocationType": { + "type": "enum", + "members": { + "RequestResponse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestResponse", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DryRun": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DryRun", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#RetentionPeriodInDays": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 90 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#RetryDetails": { + "type": "structure", + "members": { + "CurrentAttempt": { + "target": "com.amazonaws.lambda#AttemptCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The current attempt number for this operation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "NextAttemptDelaySeconds": { + "target": "com.amazonaws.lambda#DurationSeconds", + "traits": { + "smithy.api#documentation": "The delay before the next retry attempt, in seconds.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Information about retry attempts for an operation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ReverseOrder": { + "type": "boolean", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Runtime": { + "type": "enum", + "members": { + "nodejs": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs43": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs4.3", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs610": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs6.10", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs810": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs8.10", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs10x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs10.x", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs12x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs12.x", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs14x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs14.x", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs16x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs16.x", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs18x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs18.x", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs20x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs20.x", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs22x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs22.x", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs24x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs24.x", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "java8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java8", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "java8al2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java8.al2", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "java11": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java11", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "java17": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java17", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "java21": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java21", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "java25": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java25", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "python27": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python2.7", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "python36": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.6", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "python37": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.7", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "python38": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.8", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "python39": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.9", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "python310": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.10", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "python311": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.11", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "python312": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.12", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "python313": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.13", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "python314": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.14", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "dotnetcore10": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnetcore1.0", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "dotnetcore20": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnetcore2.0", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "dotnetcore21": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnetcore2.1", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "dotnetcore31": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnetcore3.1", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "dotnet6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnet6", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "dotnet8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnet8", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "dotnet10": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnet10", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs43edge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs4.3-edge", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "go1x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "go1.x", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ruby25": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ruby2.5", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ruby27": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ruby2.7", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ruby32": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ruby3.2", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ruby33": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ruby3.3", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ruby34": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ruby3.4", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ruby40": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ruby4.0", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "provided": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provided", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "providedal2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provided.al2", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "providedal2023": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provided.al2023", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "nodejs26x": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nodejs26.x", + "smithy.api#tags": [ + "feature:nodejs-26" + ] + } + }, + "python315": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.15", + "smithy.api#tags": [ + "feature:python-315" + ] + } + }, + "java8al2023": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java8.al2023", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "java11al2023": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java11.al2023", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "java17al2023": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java17.al2023", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#RuntimeVersionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 26, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*):lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}::runtime:.+$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#RuntimeVersionConfig": { + "type": "structure", + "members": { + "RuntimeVersionArn": { + "target": "com.amazonaws.lambda#RuntimeVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the runtime version you want the function to use.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Error": { + "target": "com.amazonaws.lambda#RuntimeVersionError", + "traits": { + "smithy.api#documentation": "Error response when Lambda is unable to retrieve the runtime version for a function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The ARN of the runtime and any errors that occured.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#RuntimeVersionError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The error code.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#SensitiveString", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Any error returned when the runtime version information for the function could not be retrieved.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[0-9A-Za-z\\.\\-_]*(?The exception type.", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda function couldn't make a network connection to the configured S3 Files access point.
", + "smithy.api#error": "client", + "smithy.api#httpError": 408, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#S3FilesMountFailureException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda function couldn't mount the configured S3 Files access point due to a permission or configuration issue.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#S3FilesMountTimeoutException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda function made a network connection to the configured S3 Files access point, but the mount operation timed out.
", + "smithy.api#error": "client", + "smithy.api#httpError": 408, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#S3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.*$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#S3ObjectStorageMode": { + "type": "enum", + "members": { + "Copy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "The default storage mode. Uploads a copy of your deployment package to Lambda.
", + "smithy.api#enumValue": "COPY", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Reference": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "The reference storage mode. Lambda references the deployment package from the specified Amazon S3 bucket without uploading a copy.
", + "smithy.api#enumValue": "REFERENCE", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The method Lambda uses to store a function's deployment package — either by copying the package into Lambda-managed storage (COPY) or by referencing it directly from the source Amazon S3 bucket (REFERENCE).
Limits the number of concurrent instances that the Amazon SQS event source can invoke.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SchemaRegistryEventRecordFormat": { + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SchemaRegistryUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-\\/*:_+=.@-]*$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^sg-[0-9a-zA-Z]*$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#SecurityGroupId", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SelfManagedEventSource": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.lambda#Endpoints", + "traits": { + "smithy.api#documentation": "The list of bootstrap servers for your Kafka brokers in the following format: \"KAFKA_BOOTSTRAP_SERVERS\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"].
The self-managed Apache Kafka cluster for your event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SelfManagedKafkaEventSourceConfig": { + "type": "structure", + "members": { + "ConsumerGroupId": { + "target": "com.amazonaws.lambda#URI", + "traits": { + "smithy.api#documentation": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SchemaRegistryConfig": { + "target": "com.amazonaws.lambda#KafkaSchemaRegistryConfig", + "traits": { + "smithy.api#documentation": "Specific configuration settings for a Kafka schema registry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Specific configuration settings for a self-managed Apache Kafka event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SendDurableExecutionCallbackFailure": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#SendDurableExecutionCallbackFailureRequest" + }, + "output": { + "target": "com.amazonaws.lambda#SendDurableExecutionCallbackFailureResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CallbackTimeoutException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to send a failure response for a callback operation in an AWS Lambda durable execution", + "relativeDocumentation": "API_SendDurableExecutionCallbackFailure.html", + "resources": { + "required": { + "durable execution": {} + } + } + }, + "smithy.api#documentation": "Sends a failure response for a callback operation in a durable execution. Use this API when an external system cannot complete a callback operation successfully.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2025-12-01/durable-execution-callbacks/{CallbackId}/fail" + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SendDurableExecutionCallbackFailureRequest": { + "type": "structure", + "members": { + "CallbackId": { + "target": "com.amazonaws.lambda#CallbackId", + "traits": { + "smithy.api#documentation": "The unique identifier for the callback operation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Error": { + "target": "com.amazonaws.lambda#ErrorObject", + "traits": { + "smithy.api#documentation": "Error details describing why the callback operation failed.
", + "smithy.api#httpPayload": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SendDurableExecutionCallbackFailureResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SendDurableExecutionCallbackHeartbeat": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#SendDurableExecutionCallbackHeartbeatRequest" + }, + "output": { + "target": "com.amazonaws.lambda#SendDurableExecutionCallbackHeartbeatResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CallbackTimeoutException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to send a heartbeat for a callback operation in an AWS Lambda durable execution", + "relativeDocumentation": "API_SendDurableExecutionCallbackHeartbeat.html", + "resources": { + "required": { + "durable execution": {} + } + } + }, + "smithy.api#documentation": "Sends a heartbeat signal for a long-running callback operation to prevent timeout. Use this API to extend the callback timeout period while the external operation is still in progress.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2025-12-01/durable-execution-callbacks/{CallbackId}/heartbeat" + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SendDurableExecutionCallbackHeartbeatRequest": { + "type": "structure", + "members": { + "CallbackId": { + "target": "com.amazonaws.lambda#CallbackId", + "traits": { + "smithy.api#documentation": "The unique identifier for the callback operation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SendDurableExecutionCallbackHeartbeatResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SendDurableExecutionCallbackSuccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#SendDurableExecutionCallbackSuccessRequest" + }, + "output": { + "target": "com.amazonaws.lambda#SendDurableExecutionCallbackSuccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CallbackTimeoutException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to send a successful response for a callback operation in an AWS Lambda durable execution", + "relativeDocumentation": "API_SendDurableExecutionCallbackSuccess.html", + "resources": { + "required": { + "durable execution": {} + } + } + }, + "smithy.api#documentation": "Sends a successful completion response for a callback operation in a durable execution. Use this API when an external system has successfully completed a callback operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2025-12-01/durable-execution-callbacks/{CallbackId}/succeed" + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SendDurableExecutionCallbackSuccessRequest": { + "type": "structure", + "members": { + "CallbackId": { + "target": "com.amazonaws.lambda#CallbackId", + "traits": { + "smithy.api#documentation": "The unique identifier for the callback operation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Result": { + "target": "com.amazonaws.lambda#BinaryOperationPayload", + "traits": { + "smithy.api#documentation": "The result data from the successful callback operation. Maximum size is 256 KB.
", + "smithy.api#httpPayload": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SendDurableExecutionCallbackSuccessResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SensitiveStringOnServerOnly": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SerializedRequestEntityTooLargeException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The error type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The request payload exceeded the maximum allowed size for serialized request entities.
", + "smithy.api#error": "client", + "smithy.api#httpError": 413, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ServiceException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda service encountered an internal error.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The request would exceed a service quota. For more information about Lambda service quotas, see Lambda quotas. To request a quota increase, see Requesting a quota increase in the Service Quotas User Guide.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SigningProfileVersionArns": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SnapStart": { + "type": "structure", + "members": { + "ApplyOn": { + "target": "com.amazonaws.lambda#SnapStartApplyOn", + "traits": { + "smithy.api#documentation": "Set to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.
The function's Lambda SnapStart setting. Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.
The afterRestore() runtime hook encountered an error. For more information, check the Amazon CloudWatch logs.
Lambda is initializing your function. You can invoke the function when the function state becomes Active.
The exception type.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda couldn't regenerate the SnapStart snapshot for the function. SnapStart-enabled functions periodically regenerate snapshots when their underlying runtime or dependencies change; this regeneration failed. Wait for Lambda to retry, or update the function's configuration to trigger a new snapshot. For more information, see Lambda SnapStart.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SnapStartResponse": { + "type": "structure", + "members": { + "ApplyOn": { + "target": "com.amazonaws.lambda#SnapStartApplyOn", + "traits": { + "smithy.api#documentation": "When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.
When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The function's SnapStart setting.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SnapStartTimeoutException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda couldn't restore the snapshot within the timeout limit.
", + "smithy.api#error": "client", + "smithy.api#httpError": 408, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SourceAccessConfiguration": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#SourceAccessType", + "traits": { + "smithy.api#documentation": "The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".
BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.
BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.
VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.
VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.
SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.
SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.
VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.
CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.
SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.
The value for your chosen configuration in Type. For example: \"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\".
To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SourceAccessConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#SourceAccessConfiguration", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 23 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SourceAccessType": { + "type": "enum", + "members": { + "BASIC_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC_AUTH", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VPC_SUBNET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_SUBNET", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VPC_SECURITY_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_SECURITY_GROUP", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SASL_SCRAM_512_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SASL_SCRAM_512_AUTH", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SASL_SCRAM_256_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SASL_SCRAM_256_AUTH", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VIRTUAL_HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIRTUAL_HOST", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CLIENT_CERTIFICATE_TLS_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIENT_CERTIFICATE_TLS_AUTH", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SERVER_ROOT_CA_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_ROOT_CA_CERTIFICATE", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SourceOwner": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StackTraceEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#StackTraceEntry", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StackTraceEntry": { + "type": "string", + "traits": { + "smithy.api#sensitive": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#State": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Deactivating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deactivating", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Deactivated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deactivated", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ActiveNonInvocable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ActiveNonInvocable", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StateReason": { + "type": "string", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StateReasonCode": { + "type": "enum", + "members": { + "Idle": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Idle", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Restoring": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Restoring", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EniLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EniLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InsufficientRolePermissions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientRolePermissions", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidConfiguration": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidConfiguration", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InternalError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalError", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SubnetOutOfIPAddresses": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SubnetOutOfIPAddresses", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidSubnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidSubnet", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidSecurityGroup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidSecurityGroup", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ImageDeleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageDeleted", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ImageAccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageAccessDenied", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidImage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidImage", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KMSKeyAccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMSKeyAccessDenied", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KMSKeyNotFound": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMSKeyNotFound", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidStateKMSKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidStateKMSKey", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DisabledKMSKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisabledKMSKey", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EFSIOError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSIOError", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EFSMountConnectivityError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSMountConnectivityError", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EFSMountFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSMountFailure", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EFSMountTimeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EFSMountTimeout", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidRuntime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidRuntime", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvalidZipFileException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidZipFileException", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ServiceQuotaExceededException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceQuotaExceededException", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VcpuLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VcpuLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CapacityProviderScalingLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CapacityProviderScalingLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InsufficientCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientCapacity", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EC2RequestLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2RequestLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorInitTimeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.InitTimeout", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorRuntimeInitError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.RuntimeInitError", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorExtensionInitError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.ExtensionInitError", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorInvalidEntryPoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.InvalidEntryPoint", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorInvalidWorkingDirectory": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.InvalidWorkingDirectory", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorPermissionDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.PermissionDenied", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorTooManyExtensions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.TooManyExtensions", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionErrorInitResourceExhausted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionError.InitResourceExhausted", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DisallowedByVpcEncryptionControl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisallowedByVpcEncryptionControl", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DrainingDurableExecutions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DrainingDurableExecutions", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DependencyError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DependencyError", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StatementId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^([a-zA-Z0-9-_]+)$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StepDetails": { + "type": "structure", + "members": { + "Attempt": { + "target": "com.amazonaws.lambda#AttemptCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The current attempt number for this step.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "NextAttemptTimestamp": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the next attempt is scheduled, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). Only populated when the step is in a pending state.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Result": { + "target": "com.amazonaws.lambda#OperationPayload", + "traits": { + "smithy.api#documentation": "The JSON response payload from the step operation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Error": { + "target": "com.amazonaws.lambda#ErrorObject", + "traits": { + "smithy.api#documentation": "Details about the step failure.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a step operation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StepFailedDetails": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.lambda#EventError", + "traits": { + "smithy.api#documentation": "Details about the step failure.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RetryDetails": { + "target": "com.amazonaws.lambda#RetryDetails", + "traits": { + "smithy.api#documentation": "Information about retry attempts for this step operation.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a step that failed.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StepOptions": { + "type": "structure", + "members": { + "NextAttemptDelaySeconds": { + "target": "com.amazonaws.lambda#DurationSeconds", + "traits": { + "smithy.api#documentation": "The delay in seconds before the next retry attempt.
", + "smithy.api#range": { + "min": 1, + "max": 31622400 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration options for a step operation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StepStartedDetails": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Details about a step that has started.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StepSucceededDetails": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.lambda#EventResult", + "traits": { + "smithy.api#documentation": "The response payload from the successful operation.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RetryDetails": { + "target": "com.amazonaws.lambda#RetryDetails", + "traits": { + "smithy.api#documentation": "Information about retry attempts for this step operation.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a step that succeeded.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StopDurableExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#StopDurableExecutionRequest" + }, + "output": { + "target": "com.amazonaws.lambda#StopDurableExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to stop an AWS Lambda durable execution", + "relativeDocumentation": "API_StopDurableExecution.html", + "resources": { + "required": { + "durable execution": {} + } + } + }, + "smithy.api#documentation": "Stops a running durable execution. The execution transitions to STOPPED status and cannot be resumed. Any in-progress operations are terminated.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2025-12-01/durable-executions/{DurableExecutionArn}/stop", + "code": 200 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StopDurableExecutionRequest": { + "type": "structure", + "members": { + "DurableExecutionArn": { + "target": "com.amazonaws.lambda#DurableExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the durable execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Error": { + "target": "com.amazonaws.lambda#ErrorObject", + "traits": { + "smithy.api#documentation": "Optional error details explaining why the execution is being stopped.
", + "smithy.api#httpPayload": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StopDurableExecutionResponse": { + "type": "structure", + "members": { + "StopTimestamp": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the execution was stopped (ISO 8601 format).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#String": { + "type": "string", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1500 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SubnetIPAddressLimitReachedException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda couldn't set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.
", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^subnet-[0-9a-z]*$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#SubnetId", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#SystemLogLevel": { + "type": "enum", + "members": { + "Debug": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Info": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Warn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARN", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#TagKey", + "traits": { + "smithy.api#tags": [ + "feature:public" + ], + "smithy.api#xmlName": "Key" + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to add tags to an AWS Lambda function, event source mapping, capacity provider, or code signing configuration resource", + "relativeDocumentation": "API_TagResources.html", + "resources": { + "optional": { + "eventSourceMapping": {}, + "function": {}, + "code signing config": {}, + "capacityProvider": {} + } + } + }, + "smithy.api#documentation": "Adds tags to a function, event source mapping, or code signing configuration.
", + "smithy.api#examples": [ + { + "documentation": "The following example adds a tag with the key name DEPARTMENT and a value of 'Department A' to the specified Lambda function.", + "input": { + "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Tags": { + "DEPARTMENT": "Department A" + } + }, + "title": "To add tags to an existing Lambda function" + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2017-03-31/tags/{Resource}", + "code": 204 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TagResourceRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.lambda#TaggableResource", + "traits": { + "smithy.api#documentation": "The resource's Amazon Resource Name (ARN).
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "A list of tags to apply to the resource.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TaggableResource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*):lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:(function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?|code-signing-config:csc-[a-z0-9]{17}|event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|(capacity-provider|network-connector):[a-zA-Z0-9-_]{1,64})$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.lambda#TagKey", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "value": { + "target": "com.amazonaws.lambda#TagValue", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TagsError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#TagsErrorCode", + "traits": { + "smithy.api#documentation": "The error code.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Message": { + "target": "com.amazonaws.lambda#TagsErrorMessage", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains details about an error related to retrieving tags.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TagsErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 21 + }, + "smithy.api#pattern": "^[A-Za-z]+Exception$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TagsErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 84, + "max": 1000 + }, + "smithy.api#pattern": "^.*$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TargetTrackingScalingPolicy": { + "type": "structure", + "members": { + "PredefinedMetricType": { + "target": "com.amazonaws.lambda#CapacityProviderPredefinedMetricType", + "traits": { + "smithy.api#documentation": "The predefined metric type to track for scaling decisions.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TargetValue": { + "target": "com.amazonaws.lambda#MetricTargetValue", + "traits": { + "smithy.api#documentation": "The target value for the metric that the scaling policy attempts to maintain through scaling actions.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "A scaling policy for the capacity provider that automatically adjusts capacity to maintain a target value for a specific metric.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TenancyConfig": { + "type": "structure", + "members": { + "TenantIsolationMode": { + "target": "com.amazonaws.lambda#TenantIsolationMode", + "traits": { + "smithy.api#documentation": "Tenant isolation mode allows for invocation to be sent to a corresponding execution environment dedicated to a specific tenant ID.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the tenant isolation mode configuration for a Lambda function. This allows you to configure specific tenant isolation strategies for your function invocations. Tenant isolation configuration cannot be modified after function creation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TenantId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\._:\\/=+\\-@ ]+$", + "smithy.api#tags": [ + "feature:public", + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TenantIsolationMode": { + "type": "enum", + "members": { + "PER_TENANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PER_TENANT", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#ThrottleReason": { + "type": "enum", + "members": { + "ConcurrentInvocationLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConcurrentInvocationLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionInvocationRateLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FunctionInvocationRateLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ReservedFunctionConcurrentInvocationLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReservedFunctionConcurrentInvocationLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ReservedFunctionInvocationRateLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReservedFunctionInvocationRateLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CallerRateLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CallerRateLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ConcurrentSnapshotCreateLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConcurrentSnapshotCreateLimitExceeded", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Timeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5400 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Timestamp": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "^.*$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TooManyRequestsException": { + "type": "structure", + "members": { + "retryAfterSeconds": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The number of seconds the caller should wait before retrying.
", + "smithy.api#httpHeader": "Retry-After", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Reason": { + "target": "com.amazonaws.lambda#ThrottleReason", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The request throughput limit was exceeded. For more information, see Lambda quotas.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Topic": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 249 + }, + "smithy.api#pattern": "^[^.]([a-zA-Z0-9\\-_.]+)$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Topics": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Topic", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TraceHeader": { + "type": "structure", + "members": { + "XAmznTraceId": { + "target": "com.amazonaws.lambda#XAmznTraceId", + "traits": { + "smithy.api#documentation": "The X-Ray trace header associated with the durable execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Contains trace headers for the Lambda durable execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TracingConfig": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.lambda#TracingMode", + "traits": { + "smithy.api#documentation": "The tracing mode.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The function's X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active.
The tracing mode.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The function's X-Ray tracing configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TracingMode": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PassThrough": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PassThrough", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Truncated": { + "type": "boolean", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#TumblingWindowInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 900 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#URI": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[ a-zA-Z0-9-\\/*:_+=.@-]*$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UUIDString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UnqualifiedFunctionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)$", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UnreservedConcurrentExecutions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UnsupportedMediaTypeException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The content type of the Invoke request body is not JSON.
Removes tags from a function, event source mapping, or code signing configuration.
", + "smithy.api#examples": [ + { + "documentation": "The following example removes the tag with the key name DEPARTMENT tag from the my-function Lambda function.", + "input": { + "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "TagKeys": [ + "DEPARTMENT" + ] + }, + "title": "To remove tags from an existing Lambda function" + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/2017-03-31/tags/{Resource}", + "code": 204 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UntagResourceRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.lambda#TaggableResource", + "traits": { + "smithy.api#documentation": "The resource's Amazon Resource Name (ARN).
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TagKeys": { + "target": "com.amazonaws.lambda#TagKeyList", + "traits": { + "smithy.api#documentation": "A list of tag keys to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateAliasRequest" + }, + "output": { + "target": "com.amazonaws.lambda#AliasConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update the configuration of an AWS Lambda function's alias", + "relativeDocumentation": "API_UpdateAlias.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Updates the configuration of a Lambda function alias.
", + "smithy.api#examples": [ + { + "documentation": "The following example updates the alias named BLUE to send 30% of traffic to version 2 and 70% to version 1.", + "input": { + "FunctionName": "my-function", + "FunctionVersion": "2", + "Name": "BLUE", + "RoutingConfig": { + "AdditionalVersionWeights": { + "1": 0.7 + } + } + }, + "output": { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE", + "Description": "Production environment BLUE.", + "FunctionVersion": "2", + "Name": "BLUE", + "RevisionId": "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93", + "RoutingConfig": { + "AdditionalVersionWeights": { + "1": 0.7 + } + } + }, + "title": "To update a function alias" + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "code": 200 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateAliasRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Name": { + "target": "com.amazonaws.lambda#Alias", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Alias", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionVersion": { + "target": "com.amazonaws.lambda#VersionWithLatestPublished", + "traits": { + "smithy.api#documentation": "The function version that the alias invokes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "A description of the alias.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RoutingConfig": { + "target": "com.amazonaws.lambda#AliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "The routing configuration of the alias.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an alias that has changed since you last read it.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateCapacityProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateCapacityProviderRequest" + }, + "output": { + "target": "com.amazonaws.lambda#UpdateCapacityProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update an AWS Lambda capacity provider", + "relativeDocumentation": "API_UpdateCapacityProvider.html", + "resources": { + "required": { + "capacityProvider": {} + } + } + }, + "smithy.api#documentation": "Updates the configuration of an existing capacity provider.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2025-11-30/capacity-providers/{CapacityProviderName}", + "code": 202 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateCapacityProviderRequest": { + "type": "structure", + "members": { + "CapacityProviderName": { + "target": "com.amazonaws.lambda#CapacityProviderName", + "traits": { + "smithy.api#documentation": "The name of the capacity provider to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CapacityProviderScalingConfig": { + "target": "com.amazonaws.lambda#CapacityProviderScalingConfig", + "traits": { + "smithy.api#documentation": "The updated scaling configuration for the capacity provider.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PropagateTags": { + "target": "com.amazonaws.lambda#PropagateTags", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TelemetryConfig": { + "target": "com.amazonaws.lambda#CapacityProviderTelemetryConfig", + "traits": { + "smithy.api#documentation": "The updated telemetry configuration for the capacity provider.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateCapacityProviderResponse": { + "type": "structure", + "members": { + "CapacityProvider": { + "target": "com.amazonaws.lambda#CapacityProvider", + "traits": { + "smithy.api#documentation": "Information about the updated capacity provider.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateCodeSigningConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateCodeSigningConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#UpdateCodeSigningConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update an AWS Lambda code signing config", + "relativeDocumentation": "API_UpdateCodeSigningConfig.html", + "resources": { + "required": { + "code signing config": {} + } + } + }, + "smithy.api#documentation": "Update the code signing configuration. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", + "code": 200 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateCodeSigningConfigRequest": { + "type": "structure", + "members": { + "CodeSigningConfigArn": { + "target": "com.amazonaws.lambda#CodeSigningConfigArn", + "traits": { + "smithy.api#documentation": "The The Amazon Resource Name (ARN) of the code signing configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "Descriptive name for this code signing configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AllowedPublishers": { + "target": "com.amazonaws.lambda#AllowedPublishers", + "traits": { + "smithy.api#documentation": "Signing profiles for this code signing configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CodeSigningPolicies": { + "target": "com.amazonaws.lambda#CodeSigningPolicies", + "traits": { + "smithy.api#documentation": "The code signing policy.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateCodeSigningConfigResponse": { + "type": "structure", + "members": { + "CodeSigningConfig": { + "target": "com.amazonaws.lambda#CodeSigningConfig", + "traits": { + "smithy.api#documentation": "The code signing configuration
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateEventSourceMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateEventSourceMappingRequest" + }, + "output": { + "target": "com.amazonaws.lambda#EventSourceMappingConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceInUseException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:FunctionArn" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to update the configuration of an AWS Lambda event source mapping", + "relativeDocumentation": "API_UpdateEventSourceMapping.html", + "resources": { + "required": { + "eventSourceMapping": {} + } + } + }, + "smithy.api#documentation": "Updates an event source mapping. You can change the function that Lambda invokes, or pause invocation and resume later from the same location.
For details about how to configure different event sources, see the following topics.
The following error handling options are available for stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka):
BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.
MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, Kafka topic, or Amazon S3 bucket. For more information, see Adding a destination.
The following option is available only for DynamoDB and Kinesis event sources:
ParallelizationFactor – Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.
The identifier of the event source mapping.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – MyFunction.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Enabled": { + "target": "com.amazonaws.lambda#Enabled", + "traits": { + "smithy.api#documentation": "When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "BatchSize": { + "target": "com.amazonaws.lambda#BatchSize", + "traits": { + "smithy.api#documentation": "The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
Amazon Kinesis – Default 100. Max 10,000.
Amazon DynamoDB Streams – Default 100. Max 10,000.
Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
Self-managed Apache Kafka – Default 100. Max 10,000.
Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
DocumentDB – Default 100. Max 10,000.
An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MetricsConfig": { + "target": "com.amazonaws.lambda#EventSourceMappingMetricsConfig", + "traits": { + "smithy.api#documentation": "The metrics configuration for your event source. For more information, see Event source mapping metrics.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LoggingConfig": { + "target": "com.amazonaws.lambda#EventSourceMappingLoggingConfig", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ScalingConfig": { + "target": "com.amazonaws.lambda#ScalingConfig", + "traits": { + "smithy.api#documentation": "(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", + "traits": { + "smithy.api#documentation": "The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.
Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumRecordAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is infinite (-1).
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "BisectBatchOnFunctionError": { + "target": "com.amazonaws.lambda#BisectBatchOnFunctionError", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TumblingWindowInSeconds": { + "target": "com.amazonaws.lambda#TumblingWindowInSeconds", + "traits": { + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SourceAccessConfigurations": { + "target": "com.amazonaws.lambda#SourceAccessConfigurations", + "traits": { + "smithy.api#documentation": "An array of authentication protocols or VPC components required to secure your event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionResponseTypes": { + "target": "com.amazonaws.lambda#FunctionResponseTypeList", + "traits": { + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS) A list of current response type enums applied to the event source mapping.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AmazonManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#AmazonManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SelfManagedKafkaEventSourceConfig": { + "target": "com.amazonaws.lambda#SelfManagedKafkaEventSourceConfig", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DocumentDBEventSourceConfig": { + "target": "com.amazonaws.lambda#DocumentDBEventSourceConfig", + "traits": { + "smithy.api#documentation": "Specific configuration settings for a DocumentDB event source.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ProvisionedPollerConfig": { + "target": "com.amazonaws.lambda#ProvisionedPollerConfig", + "traits": { + "smithy.api#documentation": "(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateFunctionCode": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateFunctionCodeRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeSigningConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#CodeStorageExceededException" + }, + { + "target": "com.amazonaws.lambda#CodeVerificationFailedException" + }, + { + "target": "com.amazonaws.lambda#InvalidCodeSignatureException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update the code of an AWS Lambda function", + "relativeDocumentation": "API_UpdateFunctionCode.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda.
If the function's package type is Image, then you must specify the code package in ImageUri as the URI of a container image in the Amazon ECR registry.
If the function's package type is Zip, then you must specify the deployment package as a .zip file archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide the function code inline using the ZipFile field.
The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64).
The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.
For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.
The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ZipFile": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you. Use only with a function defined with a .zip file archive deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3Bucket": { + "target": "com.amazonaws.lambda#S3Bucket", + "traits": { + "smithy.api#documentation": "An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3Key": { + "target": "com.amazonaws.lambda#S3Key", + "traits": { + "smithy.api#documentation": "The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3ObjectVersion": { + "target": "com.amazonaws.lambda#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "For versioned objects, the version of the deployment package object to use.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "S3ObjectStorageMode": { + "target": "com.amazonaws.lambda#S3ObjectStorageMode", + "traits": { + "smithy.api#documentation": "Specifies how the deployment package is stored. Valid values:
COPY (default) – Uploads a copy of your deployment package to Lambda.
REFERENCE – Lambda references the deployment package from the specified Amazon S3 bucket.
URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Architectures": { + "target": "com.amazonaws.lambda#ArchitecturesList", + "traits": { + "smithy.api#documentation": "The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "PublishTo": { + "target": "com.amazonaws.lambda#FunctionVersionLatestPublished", + "traits": { + "smithy.api#documentation": "Specifies where to publish the function version or configuration.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DryRun": { + "target": "com.amazonaws.lambda#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Set to true to validate the request parameters and access permissions without modifying the function code.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SourceKMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services managed key.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateFunctionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateFunctionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#CodeSigningConfigNotFoundException" + }, + { + "target": "com.amazonaws.lambda#CodeVerificationFailedException" + }, + { + "target": "com.amazonaws.lambda#InvalidCodeSignatureException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "lambda:VpcIds", + "lambda:SubnetIds", + "lambda:SecurityGroupIds", + "lambda:Layer" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to modify the version-specific settings of an AWS Lambda function", + "relativeDocumentation": "API_UpdateFunctionConfiguration.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Modify the version-specific settings of a Lambda function.
When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Lambda function states.
These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.
To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an Amazon Web Services account or Amazon Web Services service, use AddPermission.
", + "smithy.api#examples": [ + { + "documentation": "The following example modifies the memory size to be 256 MB for the unpublished ($LATEST) version of a function named my-function.", + "input": { + "DurableConfig": { + "ExecutionTimeout": 3600, + "RetentionPeriodInDays": 45 + }, + "FunctionName": "my-function", + "MemorySize": 256 + }, + "output": { + "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", + "CodeSize": 308, + "Description": "", + "DurableConfig": { + "ExecutionTimeout": 3600, + "RetentionPeriodInDays": 45 + }, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function", + "FunctionName": "my-function", + "Handler": "index.handler", + "LastModified": "2019-08-14T22:26:11.234+0000", + "MemorySize": 256, + "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6", + "Role": "arn:aws:iam::123456789012:role/lambda-role", + "Runtime": "nodejs12.x", + "Timeout": 3, + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST" + }, + "title": "To update a Lambda function's configuration" + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/2015-03-31/functions/{FunctionName}/configuration", + "code": 200 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateFunctionConfigurationRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Role": { + "target": "com.amazonaws.lambda#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function's execution role.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Handler": { + "target": "com.amazonaws.lambda#Handler", + "traits": { + "smithy.api#documentation": "The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "A description of the function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Timeout": { + "target": "com.amazonaws.lambda#Timeout", + "traits": { + "smithy.api#documentation": "The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MemorySize": { + "target": "com.amazonaws.lambda#MemorySize", + "traits": { + "smithy.api#documentation": "The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VpcConfig": { + "target": "com.amazonaws.lambda#VpcConfig", + "traits": { + "smithy.api#documentation": "For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Environment": { + "target": "com.amazonaws.lambda#Environment", + "traits": { + "smithy.api#documentation": "Environment variables that are accessible from function code during execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Runtime": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#documentation": "The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.lambda#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:
The function's environment variables.
The function's Lambda SnapStart snapshots.
When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.
The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.
If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "TracingConfig": { + "target": "com.amazonaws.lambda#TracingConfig", + "traits": { + "smithy.api#documentation": "Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Layers": { + "target": "com.amazonaws.lambda#LayerList", + "traits": { + "smithy.api#documentation": "A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FileSystemConfigs": { + "target": "com.amazonaws.lambda#FileSystemConfigList", + "traits": { + "smithy.api#documentation": "Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ImageConfig": { + "target": "com.amazonaws.lambda#ImageConfig", + "traits": { + "smithy.api#documentation": "Container image configuration values that override the values in the container image Docker file.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "EphemeralStorage": { + "target": "com.amazonaws.lambda#EphemeralStorage", + "traits": { + "smithy.api#documentation": "The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).
The function's SnapStart setting.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LoggingConfig": { + "target": "com.amazonaws.lambda#LoggingConfig", + "traits": { + "smithy.api#documentation": "The function's Amazon CloudWatch Logs configuration settings.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CapacityProviderConfig": { + "target": "com.amazonaws.lambda#CapacityProviderConfig", + "traits": { + "smithy.api#documentation": "Configuration for the capacity provider that manages compute resources for Lambda functions.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DurableConfig": { + "target": "com.amazonaws.lambda#DurableConfig", + "traits": { + "smithy.api#documentation": "Configuration settings for durable functions, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateFunctionEventInvokeConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#UpdateFunctionEventInvokeConfigRequest" + }, + "output": { + "target": "com.amazonaws.lambda#FunctionEventInvokeConfig" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to modify the configuration for asynchronous invocation for an AWS Lambda function, version, or alias", + "relativeDocumentation": "API_UpdateFunctionEventInvokeConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "Updates the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
", + "smithy.api#examples": [ + { + "documentation": "The following example adds an on-failure destination to the existing asynchronous invocation configuration for a function named my-function.", + "input": { + "DestinationConfig": { + "OnFailure": { + "Destination": "arn:aws:sqs:us-east-2:123456789012:destination" + } + }, + "FunctionName": "my-function" + }, + "output": { + "DestinationConfig": { + "OnFailure": { + "Destination": "arn:aws:sqs:us-east-2:123456789012:destination" + }, + "OnSuccess": {} + }, + "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", + "LastModified": 1.573687896493E9, + "MaximumEventAgeInSeconds": 3600, + "MaximumRetryAttempts": 0 + }, + "title": "To update an asynchronous invocation configuration" + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config", + "code": 200 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateFunctionEventInvokeConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#NumericLatestPublishedOrAliasQualifier", + "traits": { + "smithy.api#documentation": "A version number or alias name.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttempts", + "traits": { + "smithy.api#documentation": "The maximum number of times to retry when the function returns an error.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumEventAgeInSeconds", + "traits": { + "smithy.api#documentation": "The maximum age of a request that Lambda sends to a function for processing.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", + "traits": { + "smithy.api#documentation": "A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of a standard SQS queue.
Bucket - The ARN of an Amazon S3 bucket.
Topic - The ARN of a standard SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.
Updates the configuration for a Lambda function URL.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2021-10-31/functions/{FunctionName}/url", + "code": 200 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#UpdateFunctionUrlConfigRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionUrlFunctionName", + "traits": { + "smithy.api#documentation": "The name or ARN of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#FunctionUrlQualifier", + "traits": { + "smithy.api#documentation": "The alias name.
", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.
The cross-origin resource sharing (CORS) settings for your function URL.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.
The HTTP URL endpoint for your function.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of your function.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "AuthType": { + "target": "com.amazonaws.lambda#FunctionUrlAuthType", + "traits": { + "smithy.api#documentation": "The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.
The cross-origin resource sharing (CORS) settings for your function URL.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "CreationTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.
A list of VPC subnet IDs.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.lambda#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "A list of VPC security group IDs.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Ipv6AllowedForDualStack": { + "target": "com.amazonaws.lambda#NullableBoolean", + "traits": { + "smithy.api#documentation": "Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The VPC security groups and subnets that are attached to a Lambda function. For more information, see Configuring a Lambda function to access resources in a VPC.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#VpcConfigResponse": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.lambda#SubnetIds", + "traits": { + "smithy.api#documentation": "A list of VPC subnet IDs.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.lambda#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "A list of VPC security group IDs.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "VpcId": { + "target": "com.amazonaws.lambda#VpcId", + "traits": { + "smithy.api#documentation": "The ID of the VPC.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "Ipv6AllowedForDualStack": { + "target": "com.amazonaws.lambda#NullableBoolean", + "traits": { + "smithy.api#documentation": "Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The VPC security groups and subnets that are attached to a Lambda function.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#VpcId": { + "type": "string", + "traits": { + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#WaitCancelledDetails": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.lambda#EventError", + "traits": { + "smithy.api#documentation": "Details about why the wait operation was cancelled.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a wait operation that was cancelled.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#WaitDetails": { + "type": "structure", + "members": { + "ScheduledEndTimestamp": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the wait operation is scheduled to complete, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a wait operation.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#WaitOptions": { + "type": "structure", + "members": { + "WaitSeconds": { + "target": "com.amazonaws.lambda#DurationSeconds", + "traits": { + "smithy.api#documentation": "The duration to wait, in seconds.
", + "smithy.api#range": { + "min": 1, + "max": 31622400 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies how long to pause the durable execution.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#WaitStartedDetails": { + "type": "structure", + "members": { + "Duration": { + "target": "com.amazonaws.lambda#DurationSeconds", + "traits": { + "smithy.api#documentation": "The duration to wait, in seconds.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "ScheduledEndTimestamp": { + "target": "com.amazonaws.lambda#ExecutionTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the wait operation is scheduled to complete, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a wait operation that has started.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#WaitSucceededDetails": { + "type": "structure", + "members": { + "Duration": { + "target": "com.amazonaws.lambda#DurationSeconds", + "traits": { + "smithy.api#documentation": "The wait duration, in seconds.
", + "smithy.api#tags": [ + "feature:public" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a wait operation that succeeded.
", + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#Weight": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0.0, + "max": 1.0 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#WorkingDirectory": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + }, + "com.amazonaws.lambda#XAmznTraceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + }, + "smithy.api#tags": [ + "feature:public" + ] + } + } + } +} \ No newline at end of file diff --git a/codegen/aws-models/sns.json b/codegen/aws-models/sns.json new file mode 100644 index 0000000..f207a8c --- /dev/null +++ b/codegen/aws-models/sns.json @@ -0,0 +1,5469 @@ +{ + "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.sns#ActionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#action" + } + }, + "com.amazonaws.sns#AddPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#AddPermissionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Adds a statement to a topic's access control policy, granting access for the specified\n Amazon Web Services accounts to the specified actions.
\nTo remove the ability to change topic permissions, you must deny permissions to\n the AddPermission, RemovePermission, and\n SetTopicAttributes actions in your IAM policy.
The ARN of the topic whose access control policy you wish to modify.
", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.sns#label", + "traits": { + "smithy.api#documentation": "A unique identifier for the new policy statement.
", + "smithy.api#required": {} + } + }, + "AWSAccountId": { + "target": "com.amazonaws.sns#DelegatesList", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account IDs of the users (principals) who will be given access to the\n specified actions. The users must have Amazon Web Services account, but do not need to be signed up\n for this service.
", + "smithy.api#required": {} + } + }, + "ActionName": { + "target": "com.amazonaws.sns#ActionsList", + "traits": { + "smithy.api#documentation": "The action you want to allow for the specified principal(s).
\nValid values: Any Amazon SNS action name, for example Publish.
Amazon Simple Notification Service (Amazon SNS) is a web service that enables you\n to build distributed web-enabled applications. Applications can use Amazon SNS to easily push\n real-time notification messages to interested subscribers over multiple delivery\n protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features\n and their associated API calls, see the Amazon SNS Developer Guide.
\nFor information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer\n Guide.\n
\nWe also provide SDKs that enable you to access Amazon SNS from your preferred programming\n language. The SDKs contain functionality that automatically takes care of tasks such as:\n cryptographically signing your service requests, retrying requests, and handling error\n responses. For a list of available SDKs, go to Tools for Amazon Web Services.
", + "smithy.api#title": "Amazon Simple Notification Service", + "smithy.api#xmlNamespace": { + "uri": "http://sns.amazonaws.com/doc/2010-03-31/" + }, + "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": [ + { + "ref": "Region" + }, + "us-gov-east-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "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://sns-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://sns.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sns.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sns-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://sns.{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://sns.{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://sns-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": [ + { + "ref": "Region" + }, + "us-gov-east-1" + ] + } + ], + "endpoint": { + "url": "https://sns.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "endpoint": { + "url": "https://sns.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sns-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://sns.{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://sns.{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://sns.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://sns.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://sns.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://sns.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://sns.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://sns.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://sns.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://sns.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.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://sns.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://sns.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://sns.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://sns.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://sns.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://sns.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://sns.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://sns.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://sns.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://sns-fips.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://sns.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://sns-fips.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://sns.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://sns-fips.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://sns.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://sns-fips.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://sns-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://sns.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://sns.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://sns.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://sns-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://sns-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://sns.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.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://sns.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://sns-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 disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sns.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns-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 disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sns-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "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.sns#AuthorizationErrorException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationError", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "Indicates that the user has been denied access to the requested resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#BatchEntryIdsNotDistinctException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BatchEntryIdsNotDistinct", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Two or more batch entries in the request have the same Id.
The length of all the batch messages put together is more than the limit.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#BatchResultErrorEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "The Id of an entry in a batch request
An error code representing why the action failed on this entry.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "A message explaining why the action failed on this entry.
" + } + }, + "SenderFault": { + "target": "com.amazonaws.sns#boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the error happened due to the caller of the batch API action.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Gives a detailed description of failed messages in the batch.
" + } + }, + "com.amazonaws.sns#BatchResultErrorEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#BatchResultErrorEntry" + } + }, + "com.amazonaws.sns#Binary": { + "type": "blob" + }, + "com.amazonaws.sns#CheckIfPhoneNumberIsOptedOut": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#CheckIfPhoneNumberIsOptedOutInput" + }, + "output": { + "target": "com.amazonaws.sns#CheckIfPhoneNumberIsOptedOutResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "Accepts a phone number and indicates whether the phone holder has opted out of\n receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number\n that is opted out.
\nTo resume sending messages, you can opt in the number by using the\n OptInPhoneNumber action.
The phone number for which you want to check the opt out status.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the CheckIfPhoneNumberIsOptedOut action.
Indicates whether the phone number is opted out:
\n\n true – The phone number is opted out, meaning you cannot publish\n SMS messages to it.
\n false – The phone number is opted in, meaning you can publish SMS\n messages to it.
The response from the CheckIfPhoneNumberIsOptedOut action.
Can't perform multiple operations on a tag simultaneously. Perform the operations\n sequentially.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#ConfirmSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ConfirmSubscriptionInput" + }, + "output": { + "target": "com.amazonaws.sns#ConfirmSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#FilterPolicyLimitExceededException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + }, + { + "target": "com.amazonaws.sns#ReplayLimitExceededException" + }, + { + "target": "com.amazonaws.sns#SubscriptionLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Verifies an endpoint owner's intent to receive messages by validating the token sent\n to the endpoint by an earlier Subscribe action. If the token is valid, the\n action creates a new subscription and returns its Amazon Resource Name (ARN). This call\n requires an AWS signature only when the AuthenticateOnUnsubscribe flag is\n set to \"true\".
The ARN of the topic for which you wish to confirm a subscription.
", + "smithy.api#required": {} + } + }, + "Token": { + "target": "com.amazonaws.sns#token", + "traits": { + "smithy.api#documentation": "Short-lived token sent to an endpoint during the Subscribe action.
Disallows unauthenticated unsubscribes of the subscription. If the value of this\n parameter is true and the request has an Amazon Web Services signature, then only the\n topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe\n action requires Amazon Web Services authentication.
Input for ConfirmSubscription action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ConfirmSubscriptionResponse": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", + "traits": { + "smithy.api#documentation": "The ARN of the created subscription.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Response for ConfirmSubscriptions action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#CreateEndpointResponse": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "EndpointArn returned from CreateEndpoint action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Response from CreateEndpoint action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#CreatePlatformApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#CreatePlatformApplicationInput" + }, + "output": { + "target": "com.amazonaws.sns#CreatePlatformApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal and\n PlatformCredential attributes when using the\n CreatePlatformApplication action.
\n PlatformPrincipal and PlatformCredential are received from\n the notification service.
For ADM, PlatformPrincipal is client id and\n PlatformCredential is client secret.
For APNS and APNS_SANDBOX using certificate credentials,\n PlatformPrincipal is SSL certificate and\n PlatformCredential is private key.
For APNS and APNS_SANDBOX using token credentials,\n PlatformPrincipal is signing key ID and\n PlatformCredential is signing key.
For Baidu, PlatformPrincipal is API key and\n PlatformCredential is secret key.
For GCM (Firebase Cloud Messaging) using key credentials, there is no\n PlatformPrincipal. The PlatformCredential is\n API key.
For GCM (Firebase Cloud Messaging) using token credentials, there is no\n PlatformPrincipal. The PlatformCredential is a\n JSON formatted private key file. When using the Amazon Web Services CLI or Amazon Web Services SDKs, the\n file must be in string format and special characters must be ignored. To format\n the file correctly, Amazon SNS recommends using the following command:\n SERVICE_JSON=$(jq @json < service.json).
For MPNS, PlatformPrincipal is TLS certificate and\n PlatformCredential is private key.
For WNS, PlatformPrincipal is Package Security\n Identifier and PlatformCredential is secret\n key.
You can use the returned PlatformApplicationArn as an attribute for the\n CreatePlatformEndpoint action.
Application names must be made up of only uppercase and lowercase ASCII letters,\n numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters\n long.
", + "smithy.api#required": {} + } + }, + "Platform": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push\n Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).
", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "For a list of attributes, see \n SetPlatformApplicationAttributes\n .
Input for CreatePlatformApplication action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#CreatePlatformApplicationResponse": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "\n PlatformApplicationArn is returned.
Response from CreatePlatformApplication action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#CreatePlatformEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#CreatePlatformEndpointInput" + }, + "output": { + "target": "com.amazonaws.sns#CreateEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an endpoint for a device and mobile app on one of the supported push\n notification services, such as GCM (Firebase Cloud Messaging) and APNS.\n CreatePlatformEndpoint requires the PlatformApplicationArn\n that is returned from CreatePlatformApplication. You can use the returned\n EndpointArn to send a message to a mobile app or by the\n Subscribe action for subscription to a topic. The\n CreatePlatformEndpoint action is idempotent, so if the requester\n already owns an endpoint with the same device token and attributes, that endpoint's ARN\n is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push\n Notifications.
When using CreatePlatformEndpoint with Baidu, two attributes must be\n provided: ChannelId and UserId. The token field must also contain the ChannelId. For\n more information, see Creating an Amazon SNS Endpoint for\n Baidu.
\n PlatformApplicationArn returned from CreatePlatformApplication is used to\n create a an endpoint.
Unique identifier created by the notification service for an app on a device. The\n specific name for Token will vary, depending on which notification service is being\n used. For example, when using APNS as the notification service, you need the device\n token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token\n equivalent is called the registration ID.
", + "smithy.api#required": {} + } + }, + "CustomUserData": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The\n data must be in UTF-8 format and less than 2KB.
" + } + }, + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "For a list of attributes, see \n SetEndpointAttributes\n .
Input for CreatePlatformEndpoint action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#CreateSMSSandboxPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#CreateSMSSandboxPhoneNumberInput" + }, + "output": { + "target": "com.amazonaws.sns#CreateSMSSandboxPhoneNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#OptedOutException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + }, + { + "target": "com.amazonaws.sns#UserErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a\n one-time password (OTP) to that phone number.
\nWhen you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.
" + } + }, + "com.amazonaws.sns#CreateSMSSandboxPhoneNumberInput": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.sns#PhoneNumberString", + "traits": { + "smithy.api#documentation": "The destination phone number to verify. On verification, Amazon SNS adds this phone number\n to the list of verified phone numbers that you can send SMS messages to.
", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.sns#LanguageCodeString", + "traits": { + "smithy.api#documentation": "The language to use for sending the OTP. The default value is\n en-US.
Creates a topic to which notifications can be published. Users can create at most\n 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS\n topic in the Amazon SNS Developer Guide. This action is\n idempotent, so if the requester already owns a topic with the specified name, that\n topic's ARN is returned without creating a new topic.
" + } + }, + "com.amazonaws.sns#CreateTopicInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sns#topicName", + "traits": { + "smithy.api#documentation": "The name of the topic you want to create.
\nConstraints: Topic names must be made up of only uppercase and lowercase ASCII\n letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters\n long.
\nFor a FIFO (first-in-first-out) topic, the name must end with the .fifo\n suffix.
A map of attributes with their corresponding values.
\nThe following lists names, descriptions, and values of the special request parameters\n that the CreateTopic action uses:
\n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n DisplayName – The display name to use for a topic with SMS\n subscriptions.
\n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.
\n TracingConfig – Tracing mode of an Amazon SNS topic. By default\n TracingConfig is set to PassThrough, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.
HTTP
\n\n HTTPSuccessFeedbackRoleArn – Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.
\n HTTPSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an HTTP endpoint.
\n HTTPFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.
Amazon Data Firehose
\n\n FirehoseSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Amazon Data Firehose endpoint.
\n FirehoseSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon Data Firehose endpoint.
\n FirehoseFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon Data Firehose endpoint.
Lambda
\n\n LambdaSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Lambda endpoint.
\n LambdaSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Lambda endpoint.
\n LambdaFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Lambda endpoint.
Platform application endpoint
\n\n ApplicationSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to a platform application endpoint.
\n ApplicationSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an platform application endpoint.
\n ApplicationFailureFeedbackRoleArn – Indicates\n failed message delivery status for an Amazon SNS topic that is subscribed to\n an platform application endpoint.
In addition to being able to configure topic attributes for message\n delivery status of notification messages sent to Amazon SNS application\n endpoints, you can also configure application attributes for the delivery\n status of push notification messages sent to push notification\n services.
\nFor example, For more information, see Using Amazon SNS Application\n Attributes for Message Delivery Status.
\nAmazon SQS
\n\n SQSSuccessFeedbackRoleArn – Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.
\n SQSSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon SQS endpoint.
\n SQSFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.
The
The following attribute applies only to server-side\n encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
\n\n ArchivePolicy – The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.
\n ContentBasedDeduplication – Enables content-based\n deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to\n false. If you create a FIFO topic and this attribute is\n false, you must specify a value for the\n MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to\n true, Amazon SNS uses a SHA-256 hash to\n generate the MessageDeduplicationId using the body of the\n message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId parameter for the\n Publish action.
\n FifoThroughputScope – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:
\n Topic – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.
\n MessageGroup – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.
The list of tags to add to a new topic.
\nTo be able to tag a topic on creation, you must have the\n sns:CreateTopic and sns:TagResource\n permissions.
The body of the policy document you want to use for this topic.
\nYou can only add one policy per topic.
\nThe policy must be in JSON string format.
\nLength Constraints: Maximum length of 30,720.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for CreateTopic action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#CreateTopicResponse": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the created topic.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Response from CreateTopic action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#DelegatesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#delegate" + } + }, + "com.amazonaws.sns#DeleteEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#DeleteEndpointInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the endpoint for a device and mobile app from Amazon SNS. This action is\n idempotent. For more information, see Using Amazon SNS Mobile Push\n Notifications.
\nWhen you delete an endpoint that is also subscribed to a topic, then you must also\n unsubscribe the endpoint from the topic.
" + } + }, + "com.amazonaws.sns#DeleteEndpointInput": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "\n EndpointArn of endpoint to delete.
Input for DeleteEndpoint action.
Deletes a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see\n Using Amazon SNS\n Mobile Push Notifications.
" + } + }, + "com.amazonaws.sns#DeletePlatformApplicationInput": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "\n PlatformApplicationArn of platform application object to delete.
Input for DeletePlatformApplication action.
Deletes an Amazon Web Services account's verified or pending phone number from the SMS\n sandbox.
\nWhen you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.
" + } + }, + "com.amazonaws.sns#DeleteSMSSandboxPhoneNumberInput": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.sns#PhoneNumberString", + "traits": { + "smithy.api#documentation": "The destination phone number to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#DeleteSMSSandboxPhoneNumberResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#DeleteTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#DeleteTopicInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#ConcurrentAccessException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidStateException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + }, + { + "target": "com.amazonaws.sns#StaleTagException" + }, + { + "target": "com.amazonaws.sns#TagPolicyException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a topic and all its subscriptions. Deleting a topic might prevent some\n messages previously sent to the topic from being delivered to subscribers. This action\n is idempotent, so deleting a topic that does not exist does not result in an\n error.
" + } + }, + "com.amazonaws.sns#DeleteTopicInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "The ARN of the topic you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#EmptyBatchRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EmptyBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The batch request doesn't contain any entries.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#Endpoint": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "The EndpointArn for mobile app and device.
Attributes for endpoint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint for mobile app and device.
" + } + }, + "com.amazonaws.sns#Endpoint2": { + "type": "string" + }, + "com.amazonaws.sns#EndpointDisabledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "Message for endpoint disabled.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EndpointDisabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Exception error indicating endpoint disabled.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#FilterPolicyLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "FilterPolicyLimitExceeded", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To\n add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support\n Center.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#GetDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#GetDataProtectionPolicyInput" + }, + "output": { + "target": "com.amazonaws.sns#GetDataProtectionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified inline DataProtectionPolicy document that is\n stored in the specified Amazon SNS topic.
The ARN of the topic whose DataProtectionPolicy you want to get.
For more information about ARNs, see Amazon Resource Names\n (ARNs) in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#GetDataProtectionPolicyResponse": { + "type": "structure", + "members": { + "DataProtectionPolicy": { + "target": "com.amazonaws.sns#attributeValue", + "traits": { + "smithy.api#documentation": "Retrieves the DataProtectionPolicy in JSON string format.
Retrieves the endpoint attributes for a device on one of the supported push\n notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more\n information, see Using Amazon SNS Mobile Push Notifications.
" + } + }, + "com.amazonaws.sns#GetEndpointAttributesInput": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "\n EndpointArn for GetEndpointAttributes input.
Input for GetEndpointAttributes action.
Attributes include the following:
\n\n CustomUserData – arbitrary user data to associate with the\n endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and\n less than 2KB.
\n Enabled – flag that enables/disables delivery to the\n endpoint. Amazon SNS will set this to false when a notification service indicates to\n Amazon SNS that the endpoint is invalid. Users can set it back to true, typically\n after updating Token.
\n Token – device token, also referred to as a registration id,\n for an app and mobile device. This is returned from the notification service\n when an app and mobile device are registered with the notification\n service.
The device token for the iOS platform is returned in lowercase.
\nResponse from GetEndpointAttributes of the\n EndpointArn.
Retrieves the attributes of the platform application object for the supported push\n notification services, such as APNS and GCM (Firebase Cloud Messaging). For more\n information, see Using Amazon SNS Mobile Push Notifications.
" + } + }, + "com.amazonaws.sns#GetPlatformApplicationAttributesInput": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "\n PlatformApplicationArn for GetPlatformApplicationAttributesInput.
Input for GetPlatformApplicationAttributes action.
Attributes include the following:
\n\n AppleCertificateExpiryDate – The expiry date of the SSL\n certificate used to configure certificate-based authentication.
\n ApplePlatformTeamID – The Apple developer account ID used to\n configure token-based authentication.
\n ApplePlatformBundleID – The app identifier used to configure\n token-based authentication.
\n AuthenticationMethod – Returns the credential type used when\n sending push notifications from application to APNS/APNS_Sandbox, or application\n to GCM.
APNS – Returns the token or certificate.
\nGCM – Returns the token or key.
\n\n EventEndpointCreated – Topic ARN to which EndpointCreated\n event notifications should be sent.
\n EventEndpointDeleted – Topic ARN to which EndpointDeleted\n event notifications should be sent.
\n EventEndpointUpdated – Topic ARN to which EndpointUpdate\n event notifications should be sent.
\n EventDeliveryFailure – Topic ARN to which DeliveryFailure\n event notifications should be sent upon Direct Publish delivery failure\n (permanent) to one of the application's endpoints.
Response for GetPlatformApplicationAttributes action.
Returns the settings for sending SMS messages from your Amazon Web Services account.
\nThese settings are set with the SetSMSAttributes action.
A list of the individual attribute names, such as MonthlySpendLimit, for\n which you want values.
For all attribute names, see SetSMSAttributes.
\nIf you don't use this parameter, Amazon SNS returns all SMS attributes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the GetSMSAttributes request.
The SMS attribute names and their values.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The response from the GetSMSAttributes request.
Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target\n Amazon Web Services Region.
\nWhen you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.
" + } + }, + "com.amazonaws.sns#GetSMSSandboxAccountStatusInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#GetSMSSandboxAccountStatusResult": { + "type": "structure", + "members": { + "IsInSandbox": { + "target": "com.amazonaws.sns#boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether the calling Amazon Web Services account is in the SMS sandbox.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#GetSubscriptionAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#GetSubscriptionAttributesInput" + }, + "output": { + "target": "com.amazonaws.sns#GetSubscriptionAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns all of the properties of a subscription.
" + } + }, + "com.amazonaws.sns#GetSubscriptionAttributesInput": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", + "traits": { + "smithy.api#documentation": "The ARN of the subscription whose properties you want to get.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for GetSubscriptionAttributes.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#GetSubscriptionAttributesResponse": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.sns#SubscriptionAttributesMap", + "traits": { + "smithy.api#documentation": "A map of the subscription's attributes. Attributes in this map include the\n following:
\n\n ConfirmationWasAuthenticated – true if the\n subscription confirmation request was authenticated.
\n DeliveryPolicy – The JSON serialization of the\n subscription's delivery policy.
\n EffectiveDeliveryPolicy – The JSON serialization of the\n effective delivery policy that takes into account the topic delivery policy and\n account system defaults.
\n FilterPolicy – The filter policy JSON that is assigned to\n the subscription. For more information, see Amazon SNS Message\n Filtering in the Amazon SNS Developer Guide.
\n FilterPolicyScope – This attribute lets you choose the\n filtering scope by using one of the following string value types:
\n MessageAttributes (default) – The filter is\n applied on the message attributes.
\n MessageBody – The filter is applied on the message\n body.
\n Owner – The Amazon Web Services account ID of the subscription's\n owner.
\n PendingConfirmation – true if the subscription\n hasn't been confirmed. To confirm a pending subscription, call the\n ConfirmSubscription action with a confirmation token.
\n RawMessageDelivery – true if raw message\n delivery is enabled for the subscription. Raw messages are free of JSON\n formatting and can be sent to HTTP/S and Amazon SQS endpoints.
\n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.
\n SubscriptionArn – The subscription's ARN.
\n TopicArn – The topic ARN that the subscription is associated\n with.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
\n\n SubscriptionRoleArn – The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
\nAmazon SNS listed as a trusted entity
\nSpecifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Firehose delivery streams in the Amazon SNS Developer Guide.
\nResponse for GetSubscriptionAttributes action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#GetTopicAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#GetTopicAttributesInput" + }, + "output": { + "target": "com.amazonaws.sns#GetTopicAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns all of the properties of a topic. Topic properties returned might differ based\n on the authorization of the user.
" + } + }, + "com.amazonaws.sns#GetTopicAttributesInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "The ARN of the topic whose properties you want to get.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for GetTopicAttributes action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#GetTopicAttributesResponse": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.sns#TopicAttributesMap", + "traits": { + "smithy.api#documentation": "A map of the topic's attributes. Attributes in this map include the following:
\n\n DeliveryPolicy – The JSON serialization of the topic's\n delivery policy.
\n DisplayName – The human-readable name used in the\n From field for notifications to email and\n email-json endpoints.
\n EffectiveDeliveryPolicy – The JSON serialization of the\n effective delivery policy, taking system defaults into account.
\n Owner – The Amazon Web Services account ID of the topic's owner.
\n Policy – The JSON serialization of the topic's access\n control policy.
\n SignatureVersion – The signature version corresponds to\n the hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by\n Amazon SNS.
By default, SignatureVersion is set to 1. The signature is a Base64-encoded\n SHA1withRSA signature.
When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
If the API response does not include the\n SignatureVersion attribute, it means that the\n SignatureVersion for the topic has value 1.
\n SubscriptionsConfirmed – The number of confirmed\n subscriptions for the topic.
\n SubscriptionsDeleted – The number of deleted subscriptions\n for the topic.
\n SubscriptionsPending – The number of subscriptions pending\n confirmation for the topic.
\n TopicArn – The topic's ARN.
\n TracingConfig – Tracing mode of an Amazon SNS topic. By default\n TracingConfig is set to PassThrough, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.
The following attribute applies only to server-side-encryption:
\n\n KmsMasterKeyId - The ID of an Amazon Web Services managed customer master key\n (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
\n\n ArchivePolicy – The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.
\n BeginningArchiveTime – The earliest starting point at\n which a message in the topic’s archive can be replayed from. This point in time\n is based on the configured message retention period set by the topic’s message\n archiving policy.
\n ContentBasedDeduplication – Enables content-based\n deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to\n false. If you create a FIFO topic and this attribute is\n false, you must specify a value for the\n MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to\n true, Amazon SNS uses a SHA-256 hash to\n generate the MessageDeduplicationId using the body of the\n message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId parameter for the\n Publish action.
\n FifoTopic – When this is set to true, a FIFO\n topic is created.
Response for GetTopicAttributes action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#InternalErrorException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InternalError", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "Indicates an internal service error.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.sns#InvalidBatchEntryIdException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidBatchEntryId", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The Id of a batch entry in a batch request doesn't abide by the specification.
Indicates that a request parameter does not comply with the associated\n constraints.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#InvalidParameterValueException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "The parameter of an entry in a request doesn't abide by the specification.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ParameterValueInvalid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Indicates that a request parameter does not comply with the associated constraints.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#InvalidSecurityException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSecurity", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "The credential signature isn't valid. You must use an HTTPS endpoint and sign your\n request using Signature Version 4.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#InvalidStateException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Indicates that the specified state is not a valid state for an event source.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#Iso2CountryCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. For example, GB or US.", + "smithy.api#length": { + "min": 0, + "max": 2 + }, + "smithy.api#pattern": "^[A-Za-z]{2}$" + } + }, + "com.amazonaws.sns#KMSAccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSAccessDenied", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The ciphertext references a key that doesn't exist or that you don't have access\n to.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#KMSDisabledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSDisabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The request was rejected because the specified Amazon Web Services KMS key isn't\n enabled.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#KMSInvalidStateException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSInvalidState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The request was rejected because the state of the specified resource isn't valid for\n this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer\n Guide.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#KMSNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSNotFound", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The request was rejected because the specified entity or resource can't be\n found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#KMSOptInRequired": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSOptInRequired", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "The Amazon Web Services access key ID needs a subscription for the service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#KMSThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSThrottling", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The request was denied due to request throttling. For more information about\n throttling, see Limits in\n the Key Management Service Developer Guide.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#LanguageCodeString": { + "type": "enum", + "members": { + "en_US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-US" + } + }, + "en_GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-GB" + } + }, + "es_419": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es-419" + } + }, + "es_ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es-ES" + } + }, + "de_DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de-DE" + } + }, + "fr_CA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr-CA" + } + }, + "fr_FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr-FR" + } + }, + "it_IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it-IT" + } + }, + "jp_JP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ja-JP" + } + }, + "pt_BR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt-BR" + } + }, + "kr_KR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kr-KR" + } + }, + "zh_CN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh-CN" + } + }, + "zh_TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh-TW" + } + } + }, + "traits": { + "smithy.api#documentation": "Supported language code for sending OTP message" + } + }, + "com.amazonaws.sns#ListEndpointsByPlatformApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListEndpointsByPlatformApplicationInput" + }, + "output": { + "target": "com.amazonaws.sns#ListEndpointsByPlatformApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the endpoints and endpoint attributes for devices in a supported push\n notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for\n ListEndpointsByPlatformApplication are paginated and return a limited\n list of endpoints, up to 100. If additional records are available after the first page\n results, then a NextToken string will be returned. To receive the next page, you call\n ListEndpointsByPlatformApplication again using the NextToken string\n received from the previous call. When there are no more records to return, NextToken\n will be null. For more information, see Using Amazon SNS Mobile Push\n Notifications.
This action is throttled at 30 transactions per second (TPS).
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Endpoints" + } + } + }, + "com.amazonaws.sns#ListEndpointsByPlatformApplicationInput": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "\n PlatformApplicationArn for\n ListEndpointsByPlatformApplicationInput action.
\n NextToken string is used when calling\n ListEndpointsByPlatformApplication action to retrieve additional\n records that are available after the first page results.
Input for ListEndpointsByPlatformApplication action.
Endpoints returned for ListEndpointsByPlatformApplication action.
\n NextToken string is returned when calling\n ListEndpointsByPlatformApplication action if additional records are\n available after the first page results.
Response for ListEndpointsByPlatformApplication action.
Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.\n For more information about origination numbers, see Origination numbers in the Amazon SNS Developer\n Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PhoneNumbers", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sns#ListOriginationNumbersRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "Token that the previous ListOriginationNumbers request returns.
The maximum number of origination numbers to return.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListOriginationNumbersResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "A NextToken string is returned when you call the\n ListOriginationNumbers operation if additional pages of records are\n available.
A list of the calling account's verified and pending origination numbers.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ListPhoneNumbersOptedOut": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListPhoneNumbersOptedOutInput" + }, + "output": { + "target": "com.amazonaws.sns#ListPhoneNumbersOptedOutResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of phone numbers that are opted out, meaning you cannot send SMS\n messages to them.
\nThe results for ListPhoneNumbersOptedOut are paginated, and each page\n returns up to 100 phone numbers. If additional phone numbers are available after the\n first page of results, then a NextToken string will be returned. To receive\n the next page, you call ListPhoneNumbersOptedOut again using the\n NextToken string received from the previous call. When there are no\n more records to return, NextToken will be null.
A NextToken string is used when you call the\n ListPhoneNumbersOptedOut action to retrieve additional records that are\n available after the first page of results.
The input for the ListPhoneNumbersOptedOut action.
A list of phone numbers that are opted out of receiving SMS messages. The list is\n paginated, and each page can contain up to 100 phone numbers.
" + } + }, + "nextToken": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "A NextToken string is returned when you call the\n ListPhoneNumbersOptedOut action if additional records are available\n after the first page of results.
The response from the ListPhoneNumbersOptedOut action.
Lists the platform application objects for the supported push notification services,\n such as APNS and GCM (Firebase Cloud Messaging). The results for\n ListPlatformApplications are paginated and return a limited list of\n applications, up to 100. If additional records are available after the first page\n results, then a NextToken string will be returned. To receive the next page, you call\n ListPlatformApplications using the NextToken string received from the\n previous call. When there are no more records to return, NextToken will be\n null. For more information, see Using Amazon SNS Mobile Push\n Notifications.
This action is throttled at 15 transactions per second (TPS).
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PlatformApplications" + } + } + }, + "com.amazonaws.sns#ListPlatformApplicationsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "\n NextToken string is used when calling\n ListPlatformApplications action to retrieve additional records that are\n available after the first page results.
Input for ListPlatformApplications action.
Platform applications returned when calling ListPlatformApplications\n action.
\n NextToken string is returned when calling\n ListPlatformApplications action if additional records are available\n after the first page results.
Response for ListPlatformApplications action.
Lists the calling Amazon Web Services account's current verified and pending destination phone\n numbers in the SMS sandbox.
\nWhen you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PhoneNumbers", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sns#ListSMSSandboxPhoneNumbersInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "Token that the previous ListSMSSandboxPhoneNumbersInput request\n returns.
The maximum number of phone numbers to return.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListSMSSandboxPhoneNumbersResult": { + "type": "structure", + "members": { + "PhoneNumbers": { + "target": "com.amazonaws.sns#SMSSandboxPhoneNumberList", + "traits": { + "smithy.api#documentation": "A list of the calling account's pending and verified phone numbers.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "A NextToken string is returned when you call the\n ListSMSSandboxPhoneNumbersInput operation if additional pages of\n records are available.
Returns a list of the requester's subscriptions. Each call returns a limited list of\n subscriptions, up to 100. If there are more subscriptions, a NextToken is\n also returned. Use the NextToken parameter in a new\n ListSubscriptions call to get further results.
This action is throttled at 30 transactions per second (TPS).
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Subscriptions" + } + } + }, + "com.amazonaws.sns#ListSubscriptionsByTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListSubscriptionsByTopicInput" + }, + "output": { + "target": "com.amazonaws.sns#ListSubscriptionsByTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the subscriptions to a specific topic. Each call returns a limited\n list of subscriptions, up to 100. If there are more subscriptions, a\n NextToken is also returned. Use the NextToken parameter in\n a new ListSubscriptionsByTopic call to get further results.
This action is throttled at 30 transactions per second (TPS).
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Subscriptions" + } + } + }, + "com.amazonaws.sns#ListSubscriptionsByTopicInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "The ARN of the topic for which you wish to find subscriptions.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "Token returned by the previous ListSubscriptionsByTopic request.
Input for ListSubscriptionsByTopic action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListSubscriptionsByTopicResponse": { + "type": "structure", + "members": { + "Subscriptions": { + "target": "com.amazonaws.sns#SubscriptionsList", + "traits": { + "smithy.api#documentation": "A list of subscriptions.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "Token to pass along to the next ListSubscriptionsByTopic request. This\n element is returned if there are more subscriptions to retrieve.
Response for ListSubscriptionsByTopic action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ListSubscriptionsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "Token returned by the previous ListSubscriptions request.
Input for ListSubscriptions action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListSubscriptionsResponse": { + "type": "structure", + "members": { + "Subscriptions": { + "target": "com.amazonaws.sns#SubscriptionsList", + "traits": { + "smithy.api#documentation": "A list of subscriptions.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "Token to pass along to the next ListSubscriptions request. This element\n is returned if there are more subscriptions to retrieve.
Response for ListSubscriptions action
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.sns#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#ConcurrentAccessException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sns#TagPolicyException" + } + ], + "traits": { + "smithy.api#documentation": "List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the\n Amazon Simple Notification Service Developer Guide.
" + } + }, + "com.amazonaws.sns#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sns#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the topic for which to list tags.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.sns#TagList", + "traits": { + "smithy.api#documentation": "The tags associated with the specified topic.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#ListTopics": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#ListTopicsInput" + }, + "output": { + "target": "com.amazonaws.sns#ListTopicsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the requester's topics. Each call returns a limited list of topics,\n up to 100. If there are more topics, a NextToken is also returned. Use the\n NextToken parameter in a new ListTopics call to get\n further results.
This action is throttled at 30 transactions per second (TPS).
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Topics" + }, + "smithy.test#smokeTests": [ + { + "id": "ListTopicsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.sns#ListTopicsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "Token returned by the previous ListTopics request.
A list of topic ARNs.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "Token to pass along to the next ListTopics request. This element is\n returned if there are additional topics to retrieve.
Response for ListTopics action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#MapStringToString": { + "type": "map", + "key": { + "target": "com.amazonaws.sns#String" + }, + "value": { + "target": "com.amazonaws.sns#String" + } + }, + "com.amazonaws.sns#MaxItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sns#MaxItemsListOriginationNumbers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.sns#MessageAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sns#MessageAttributeValue", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sns#MessageAttributeValue": { + "type": "structure", + "members": { + "DataType": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "Amazon SNS supports the following logical data types: String, String.Array, Number, and\n Binary. For more information, see Message\n Attribute Data Types.
", + "smithy.api#required": {} + } + }, + "StringValue": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable\n Characters.
" + } + }, + "BinaryValue": { + "target": "com.amazonaws.sns#Binary", + "traits": { + "smithy.api#documentation": "Binary type attributes can store any binary data, for example, compressed data,\n encrypted data, or images.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The user-specified message attribute value. For string data types, the value attribute\n has the same restrictions on the content as the message body. For more information, see\n Publish.
\nName, type, and value must not be empty or null. In addition, the message body should\n not be empty or null. All parts of the message attribute, including name, type, and\n value, are included in the message size restriction, which is currently 256 KB (262,144\n bytes). For more information, see Amazon SNS message attributes and\n Publishing\n to a mobile phone in the Amazon SNS Developer Guide.\n
" + } + }, + "com.amazonaws.sns#NotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "Indicates that the requested resource does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.sns#NumberCapability": { + "type": "enum", + "members": { + "SMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMS" + } + }, + "MMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MMS" + } + }, + "VOICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOICE" + } + } + }, + "traits": { + "smithy.api#documentation": "Enum listing out all supported number capabilities." + } + }, + "com.amazonaws.sns#NumberCapabilityList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#NumberCapability" + }, + "traits": { + "smithy.api#documentation": "List of number capability (SMS,MMS,Voice)." + } + }, + "com.amazonaws.sns#OTPCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "String of Origination/Destination address including phone numbers and email addresses", + "smithy.api#length": { + "min": 5, + "max": 8 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.sns#OptInPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#OptInPhoneNumberInput" + }, + "output": { + "target": "com.amazonaws.sns#OptInPhoneNumberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "Use this request to opt in a phone number that is opted out, which enables you to\n resume sending SMS messages to the number.
\nYou can opt in a phone number only once every 30 days.
" + } + }, + "com.amazonaws.sns#OptInPhoneNumberInput": { + "type": "structure", + "members": { + "phoneNumber": { + "target": "com.amazonaws.sns#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number to opt in. Use E.164 format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for the OptInPhoneNumber action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#OptInPhoneNumberResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The response for the OptInPhoneNumber action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#OptedOutException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OptedOut", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Indicates that the specified phone number opted out of receiving SMS messages from\n your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#PhoneNumber": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sns#PhoneNumberInformation": { + "type": "structure", + "members": { + "CreatedAt": { + "target": "com.amazonaws.sns#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the phone number was created.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.sns#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number.
" + } + }, + "Status": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "The status of the phone number.
" + } + }, + "Iso2CountryCode": { + "target": "com.amazonaws.sns#Iso2CountryCode", + "traits": { + "smithy.api#documentation": "The two-character code for the country or region, in ISO 3166-1 alpha-2 format.
" + } + }, + "RouteType": { + "target": "com.amazonaws.sns#RouteType", + "traits": { + "smithy.api#documentation": "The list of supported routes.
" + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.sns#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "The capabilities of each phone number.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of phone numbers and their metadata.
" + } + }, + "com.amazonaws.sns#PhoneNumberInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#PhoneNumberInformation" + }, + "traits": { + "smithy.api#documentation": "List of customer owned phone numbers." + } + }, + "com.amazonaws.sns#PhoneNumberList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#PhoneNumber" + } + }, + "com.amazonaws.sns#PhoneNumberString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + }, + "smithy.api#pattern": "^(\\+[0-9]{8,}|[0-9]{0,9})$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sns#PlatformApplication": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "PlatformApplicationArn for platform application object.
" + } + }, + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "Attributes for platform application object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Platform application object.
" + } + }, + "com.amazonaws.sns#PlatformApplicationDisabledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "Message for platform application disabled.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "PlatformApplicationDisabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Exception error indicating platform application disabled.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#Publish": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#PublishInput" + }, + "output": { + "target": "com.amazonaws.sns#PublishResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#EndpointDisabledException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.sns#KMSDisabledException" + }, + { + "target": "com.amazonaws.sns#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.sns#KMSNotFoundException" + }, + { + "target": "com.amazonaws.sns#KMSOptInRequired" + }, + { + "target": "com.amazonaws.sns#KMSThrottlingException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + }, + { + "target": "com.amazonaws.sns#PlatformApplicationDisabledException" + }, + { + "target": "com.amazonaws.sns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone\n number, or a message to a mobile platform endpoint (when you specify the\n TargetArn).
If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is\n subscribed to the topic. The format of the message depends on the notification protocol\n for each subscribed endpoint.
\nWhen a messageId is returned, the message is saved and Amazon SNS immediately\n delivers it to subscribers.
To use the Publish action for publishing a message to a mobile endpoint,\n such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for\n the TargetArn parameter. The EndpointArn is returned when making a call with the\n CreatePlatformEndpoint action.
For more information about formatting messages, see Send Custom\n Platform-Specific Payloads in Messages to Mobile Devices.
\nYou can publish messages only to topics and endpoints in the same\n Amazon Web Services Region.
\nPublishes up to 10 messages to the specified topic in a single batch. This is a batch\n version of the Publish API. If you try to send more than 10 messages in a\n single batch request, you will receive a TooManyEntriesInBatchRequest\n exception.
For FIFO topics, multiple messages within a single batch are published in the order\n they are sent, and messages are deduplicated within the batch and across batches for\n five minutes.
\nThe result of publishing each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful\n actions, you should check for batch errors even when the call returns an HTTP status\n code of 200.
\nThe maximum allowed individual message size and the maximum total payload size (the sum\n of the individual lengths of all of the batched messages) are both 256 KB (262,144\n bytes).
\nThe PublishBatch API can send up to 10 messages at a time. If you\n attempt to send more than 10 messages in one request, you will encounter a\n TooManyEntriesInBatchRequest exception. In such cases, split your\n messages into multiple requests, each containing no more than 10 messages.
Some actions take lists of parameters. These lists are specified using the\n param.n notation. Values of n are integers starting from\n 1. For example, a parameter list with two elements\n looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
If you send a batch message to a topic, Amazon SNS publishes the batch message to each\n endpoint that is subscribed to the topic. The format of the batch message depends on the\n notification protocol for each subscribed endpoint.
\nWhen a messageId is returned, the batch message is saved, and Amazon SNS\n immediately delivers the message to subscribers.
The Amazon resource name (ARN) of the topic you want to batch publish to.
", + "smithy.api#required": {} + } + }, + "PublishBatchRequestEntries": { + "target": "com.amazonaws.sns#PublishBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "A list of PublishBatch request entries to be sent to the SNS\n topic.
An identifier for the message in this batch.
\nThe Ids of a batch request must be unique within a request.
This identifier can have up to 80 characters. The following characters are\n accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nThe body of the message.
", + "smithy.api#required": {} + } + }, + "Subject": { + "target": "com.amazonaws.sns#subject", + "traits": { + "smithy.api#documentation": "The subject of the batch message.
" + } + }, + "MessageStructure": { + "target": "com.amazonaws.sns#messageStructure", + "traits": { + "smithy.api#documentation": "Set MessageStructure to json if you want to send a different\n message for each protocol. For example, using one publish action, you can send a short\n message to your SMS subscribers and a longer message to your email subscribers. If you\n set MessageStructure to json, the value of the\n Message parameter must:
be a syntactically valid JSON object; and
\ncontain at least a top-level JSON key of \"default\" with a value that is a\n string.
\nYou can define other top-level keys that define the message you want to send to a\n specific transport protocol (for example, http).
" + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sns#MessageAttributeMap", + "traits": { + "smithy.api#documentation": "Each message attribute consists of a Name, Type, and\n Value. For more information, see Amazon SNS message attributes in\n the Amazon SNS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) topics.
\nThis parameter applies only to FIFO (first-in-first-out) topics. The\n MessageDeduplicationId can contain up to 128 alphanumeric\n characters (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
Every message must have a unique MessageDeduplicationId, which is\n a token used for deduplication of sent messages within the 5 minute minimum\n deduplication interval.
The scope of deduplication depends on the FifoThroughputScope\n attribute, when set to Topic the message deduplication scope is\n across the entire topic, when set to MessageGroup the message\n deduplication scope is within each individual message group.
If a message with a particular MessageDeduplicationId is sent\n successfully, subsequent messages within the deduplication scope and interval,\n with the same MessageDeduplicationId, are accepted successfully but\n aren't delivered.
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a MessageDeduplicationId\n and you enable ContentBasedDeduplication for your topic,\n Amazon SNS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the\n topic doesn't have ContentBasedDeduplication set, the\n action fails with an error.
If the topic has a ContentBasedDeduplication set, your\n MessageDeduplicationId overrides the generated one.\n
When ContentBasedDeduplication is in effect, messages with\n identical content sent within the deduplication scope and interval are treated\n as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled,\n and then another message with a MessageDeduplicationId that is the\n same as the one generated for the first MessageDeduplicationId, the\n two messages are treated as duplicates, within the deduplication scope and\n interval, and only one copy of the message is delivered.
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId after the deduplication\n interval, Amazon SNS can't detect duplicate messages.
Amazon SNS continues to keep track of the message deduplication ID even after the\n message is received and deleted.
\nFIFO topics: The tag that specifies that a message belongs to a specific message group.\n Messages that belong to the same message group are processed in a FIFO manner\n (however, messages in different message groups might be processed out of order). \n To interleave multiple ordered streams within a single topic, use MessageGroupId values \n (for example, session data for multiple users). In this scenario, multiple consumers can process the topic, \n but the session data of each user is processed in a FIFO fashion. \n You must associate a non-empty MessageGroupId with a message. \n If you do not provide a MessageGroupId, the action fails.\n
Standard topics: The MessageGroupId is optional and is forwarded only to Amazon SQS \n standard subscriptions to activate fair queues. \n The MessageGroupId is not used for, or sent to, any other endpoint types.
The length of MessageGroupId is 128 characters.
\n MessageGroupId can contain alphanumeric characters (a-z, A-Z,\n 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
Contains the details of a single Amazon SNS message along with an Id that\n identifies a message within the batch.
A list of successful PublishBatch responses.
A list of failed PublishBatch responses.
The Id of an entry in a batch request.
An identifier for the message.
" + } + }, + "SequenceNumber": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "This parameter applies only to FIFO (first-in-first-out) topics.
\nThe large, non-consecutive number that Amazon SNS assigns to each message.
\nThe length of SequenceNumber is 128 bits. SequenceNumber\n continues to increase for a particular MessageGroupId.
Encloses data related to a successful message in a batch request for topic.
" + } + }, + "com.amazonaws.sns#PublishBatchResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#PublishBatchResultEntry" + } + }, + "com.amazonaws.sns#PublishInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "The topic you want to publish to.
\nIf you don't specify a value for the TopicArn parameter, you must specify\n a value for the PhoneNumber or TargetArn parameters.
If you don't specify a value for the TargetArn parameter, you must\n specify a value for the PhoneNumber or TopicArn\n parameters.
The phone number to which you want to deliver an SMS message. Use E.164 format.
\nIf you don't specify a value for the PhoneNumber parameter, you must\n specify a value for the TargetArn or TopicArn\n parameters.
The message you want to send.
\nIf you are publishing to a topic and you want to send the same message to all\n transport protocols, include the text of the message as a String value. If you want to\n send different messages for each transport protocol, set the value of the\n MessageStructure parameter to json and use a JSON object\n for the Message parameter. \n
Constraints:
\nWith the exception of SMS, messages must be UTF-8 encoded strings and at most\n 256 KB in size (262,144 bytes, not 262,144 characters).
\nFor SMS, each message can contain up to 140 characters. This character limit\n depends on the encoding schema. For example, an SMS message can contain 160 GSM\n characters, 140 ASCII characters, or 70 UCS-2 characters.
\nIf you publish a message that exceeds this size limit, Amazon SNS sends the message\n as multiple messages, each fitting within the size limit. Messages aren't\n truncated mid-word but are cut off at whole-word boundaries.
\nThe total size limit for a single SMS Publish action is 1,600\n characters.
JSON-specific constraints:
\nKeys in the JSON object that correspond to supported transport protocols must\n have simple JSON string values.
\nThe values will be parsed (unescaped) before they are used in outgoing\n messages.
\nOutbound notifications are JSON encoded (meaning that the characters will be\n reescaped for sending).
\nValues have a minimum length of 0 (the empty string, \"\", is allowed).
\nValues have a maximum length bounded by the overall message size (so,\n including multiple protocols may limit message sizes).
\nNon-string values will cause the key to be ignored.
\nKeys that do not correspond to supported transport protocols are\n ignored.
\nDuplicate keys are not allowed.
\nFailure to parse or validate any key or value in the message will cause the\n Publish call to return an error (no partial delivery).
Optional parameter to be used as the \"Subject\" line when the message is delivered to\n email endpoints. This field will also be included, if present, in the standard JSON\n messages delivered to other endpoints.
\nConstraints: Subjects must be UTF-8 text with no line breaks or control characters,\n and less than 100 characters long.
" + } + }, + "MessageStructure": { + "target": "com.amazonaws.sns#messageStructure", + "traits": { + "smithy.api#documentation": "Set MessageStructure to json if you want to send a different\n message for each protocol. For example, using one publish action, you can send a short\n message to your SMS subscribers and a longer message to your email subscribers. If you\n set MessageStructure to json, the value of the\n Message parameter must:
be a syntactically valid JSON object; and
\ncontain at least a top-level JSON key of \"default\" with a value that is a\n string.
\nYou can define other top-level keys that define the message you want to send to a\n specific transport protocol (e.g., \"http\").
\nValid value: json\n
Message attributes for Publish action.
" + } + }, + "MessageDeduplicationId": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "This parameter applies only to FIFO (first-in-first-out) topics. The\n MessageDeduplicationId can contain up to 128 alphanumeric\n characters (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
Every message must have a unique MessageDeduplicationId, which is\n a token used for deduplication of sent messages within the 5 minute minimum\n deduplication interval.
The scope of deduplication depends on the FifoThroughputScope\n attribute, when set to Topic the message deduplication scope is\n across the entire topic, when set to MessageGroup the message\n deduplication scope is within each individual message group.
If a message with a particular MessageDeduplicationId is sent\n successfully, subsequent messages within the deduplication scope and interval,\n with the same MessageDeduplicationId, are accepted successfully but\n aren't delivered.
Every message must have a unique MessageDeduplicationId:
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a MessageDeduplicationId\n and you enable ContentBasedDeduplication for your topic,\n Amazon SNS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the\n topic doesn't have ContentBasedDeduplication set, the\n action fails with an error.
If the topic has a ContentBasedDeduplication set, your\n MessageDeduplicationId overrides the generated one.\n
When ContentBasedDeduplication is in effect, messages with\n identical content sent within the deduplication scope and interval are treated\n as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled,\n and then another message with a MessageDeduplicationId that is the\n same as the one generated for the first MessageDeduplicationId, the\n two messages are treated as duplicates, within the deduplication scope and\n interval, and only one copy of the message is delivered.
The\n MessageGroupId can contain up to 128 alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
\n For FIFO topics: The MessageGroupId is a tag that specifies that a message belongs to a\n specific message group. Messages that belong to the same message group are processed in\n a FIFO manner (however, messages in different message groups might be processed out of\n order). Every message must include a MessageGroupId.\n
\n For standard topics: The MessageGroupId is optional\n and is forwarded only to Amazon SQS standard subscriptions to activate fair queues.\n The MessageGroupId is not used for, or sent to, any other endpoint types.\n When provided, the same validation rules apply as for FIFO topics.\n
Input for Publish action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#PublishResponse": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.sns#messageId", + "traits": { + "smithy.api#documentation": "Unique identifier assigned to the published message.
\nLength Constraint: Maximum 100 characters
" + } + }, + "SequenceNumber": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "This response element applies only to FIFO (first-in-first-out) topics.
\nThe sequence number is a large, non-consecutive number that Amazon SNS assigns to each\n message. The length of SequenceNumber is 128 bits.\n SequenceNumber continues to increase for each\n MessageGroupId.
Response for Publish action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#PutDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#PutDataProtectionPolicyInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Adds or updates an inline policy document that is stored in the specified Amazon SNS\n topic.
" + } + }, + "com.amazonaws.sns#PutDataProtectionPolicyInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "The ARN of the topic whose DataProtectionPolicy you want to add or\n update.
For more information about ARNs, see Amazon Resource Names\n (ARNs) in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "DataProtectionPolicy": { + "target": "com.amazonaws.sns#attributeValue", + "traits": { + "smithy.api#documentation": "The JSON serialization of the topic's DataProtectionPolicy.
The DataProtectionPolicy must be in JSON string format.
Length Constraints: Maximum length of 30,720.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#RemovePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#RemovePermissionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Removes a statement from a topic's access control policy.
\nTo remove the ability to change topic permissions, you must deny permissions to\n the AddPermission, RemovePermission, and\n SetTopicAttributes actions in your IAM policy.
The ARN of the topic whose access control policy you wish to modify.
", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.sns#label", + "traits": { + "smithy.api#documentation": "The unique label of the statement you want to remove.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for RemovePermission action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#ReplayLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplayLimitExceeded", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "Indicates that the request parameter has exceeded the maximum number of concurrent message replays.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "Can’t perform the action on the specified resource. Make sure that the resource\n exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.sns#RouteType": { + "type": "enum", + "members": { + "Transactional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Transactional" + } + }, + "Promotional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Promotional" + } + }, + "Premium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Premium" + } + } + }, + "traits": { + "smithy.api#documentation": "Enum listing out all supported route types. The following enum values are supported.\n 1. Transactional : Non-marketing traffic\n 2. Promotional : Marketing\n 3. Premium : Premium routes for OTP delivery to the carriers" + } + }, + "com.amazonaws.sns#SMSSandboxPhoneNumber": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.sns#PhoneNumberString", + "traits": { + "smithy.api#documentation": "The destination phone number.
" + } + }, + "Status": { + "target": "com.amazonaws.sns#SMSSandboxPhoneNumberVerificationStatus", + "traits": { + "smithy.api#documentation": "The destination phone number's verification status.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A verified or pending destination phone number in the SMS sandbox.
\nWhen you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.
" + } + }, + "com.amazonaws.sns#SMSSandboxPhoneNumberList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#SMSSandboxPhoneNumber" + } + }, + "com.amazonaws.sns#SMSSandboxPhoneNumberVerificationStatus": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Verified": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Verified" + } + } + }, + "traits": { + "smithy.api#documentation": "Enum listing out all supported destination phone number verification statuses. The following enum values are\n supported.\n 1. PENDING : The destination phone number is pending verification.\n 2. VERIFIED : The destination phone number is verified." + } + }, + "com.amazonaws.sns#SetEndpointAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#SetEndpointAttributesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Sets the attributes for an endpoint for a device on one of the supported push\n notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more\n information, see Using Amazon SNS Mobile Push Notifications.
" + } + }, + "com.amazonaws.sns#SetEndpointAttributesInput": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "EndpointArn used for SetEndpointAttributes action.
A map of the endpoint attributes. Attributes in this map include the following:
\n\n CustomUserData – arbitrary user data to associate with the\n endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and\n less than 2KB.
\n Enabled – flag that enables/disables delivery to the\n endpoint. Amazon SNS will set this to false when a notification service indicates to\n Amazon SNS that the endpoint is invalid. Users can set it back to true, typically\n after updating Token.
\n Token – device token, also referred to as a registration id,\n for an app and mobile device. This is returned from the notification service\n when an app and mobile device are registered with the notification\n service.
Input for SetEndpointAttributes action.
Sets the attributes of the platform application object for the supported push\n notification services, such as APNS and GCM (Firebase Cloud Messaging). For more\n information, see Using Amazon SNS Mobile Push Notifications. For information on configuring\n attributes for message delivery status, see Using Amazon SNS Application Attributes for\n Message Delivery Status.
" + } + }, + "com.amazonaws.sns#SetPlatformApplicationAttributesInput": { + "type": "structure", + "members": { + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "\n PlatformApplicationArn for SetPlatformApplicationAttributes\n action.
A map of the platform application attributes. Attributes in this map include the\n following:
\n\n PlatformCredential – The credential received from the\n notification service.
For ADM, PlatformCredentialis client secret.
For Apple Services using certificate credentials,\n PlatformCredential is private key.
For Apple Services using token credentials,\n PlatformCredential is signing key.
For GCM (Firebase Cloud Messaging) using key credentials, there is no\n PlatformPrincipal. The PlatformCredential\n is API key.
For GCM (Firebase Cloud Messaging) using token credentials, there is\n no PlatformPrincipal. The PlatformCredential\n is a JSON formatted private key file. When using the Amazon Web Services CLI, the file\n must be in string format and special characters must be ignored. To\n format the file correctly, Amazon SNS recommends using the following command:\n SERVICE_JSON=`jq @json <<< cat\n service.json`.
\n PlatformPrincipal – The principal received from the\n notification service.
For ADM, PlatformPrincipalis client id.
For Apple Services using certificate credentials,\n PlatformPrincipal is SSL certificate.
For Apple Services using token credentials,\n PlatformPrincipal is signing key ID.
For GCM (Firebase Cloud Messaging), there is no\n PlatformPrincipal.
\n EventEndpointCreated – Topic ARN to which\n EndpointCreated event notifications are sent.
\n EventEndpointDeleted – Topic ARN to which\n EndpointDeleted event notifications are sent.
\n EventEndpointUpdated – Topic ARN to which\n EndpointUpdate event notifications are sent.
\n EventDeliveryFailure – Topic ARN to which\n DeliveryFailure event notifications are sent upon Direct\n Publish delivery failure (permanent) to one of the application's\n endpoints.
\n SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS\n write access to use CloudWatch Logs on your behalf.
\n FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS\n write access to use CloudWatch Logs on your behalf.
\n SuccessFeedbackSampleRate – Sample rate percentage (0-100)\n of successfully delivered messages.
The following attributes only apply to APNs token-based\n authentication:
\n ApplePlatformTeamID – The identifier that's assigned to your\n Apple developer account team.
\n ApplePlatformBundleID – The bundle identifier that's assigned to\n your iOS app.
Input for SetPlatformApplicationAttributes action.
Use this request to set the default settings for sending SMS messages and receiving\n daily SMS usage reports.
\nYou can override some of these settings for a single message when you use the\n Publish action with the MessageAttributes.entry.N\n parameter. For more information, see Publishing to a mobile phone\n in the Amazon SNS Developer Guide.
To use this operation, you must grant the Amazon SNS service principal\n (sns.amazonaws.com) permission to perform the\n s3:ListBucket action.
The default settings for sending SMS messages from your Amazon Web Services account. You can set\n values for the following attribute names:
\n\n MonthlySpendLimit – The maximum amount in USD that you are willing to spend\n each month to send SMS messages. When Amazon SNS determines that sending an SMS message would\n incur a cost that exceeds this limit, it stops sending SMS messages within\n minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During\n that interval, if you continue to send SMS messages, you will incur costs that\n exceed your limit.
\nBy default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to\n raise the limit, submit an SNS Limit Increase case. For New limit\n value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting\n an SMS monthly spend limit increase.
\n\n DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write\n logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS\n writes a log that includes the message price, the success or failure status, the reason\n for failure (if the message failed), the message dwell time, and other\n information.
\n DeliveryStatusSuccessSamplingRate – The percentage of successful SMS\n deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an\n integer from 0 - 100. For example, to write logs only for failed deliveries, set this\n value to 0. To write logs for 10% of your successful deliveries, set it to\n 10.
\n DefaultSenderID – A string, such as your business brand, that is displayed\n as the sender on the receiving device. Support for sender IDs varies by country. The\n sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one\n letter.
\n DefaultSMSType – The type of SMS message that you will send by default. You\n can assign the following values:
\n Promotional – (Default) Noncritical messages, such as marketing\n messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
\n Transactional – Critical messages that support customer\n transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS\n optimizes the message delivery to achieve the highest reliability.
\n UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS\n usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to\n the bucket. The report includes the following information for each SMS message that was\n successfully delivered by your Amazon Web Services account:
Time that the message was published (in UTC)
\nMessage ID
\nDestination phone number
\nMessage type
\nDelivery status
\nMessage price (in USD)
\nPart number (a message is split into multiple parts if it is too long for a\n single message)
\nTotal number of parts
\nTo receive the report, the bucket must have a policy that allows the Amazon SNS service\n principal to perform the s3:PutObject and s3:GetBucketLocation\n actions.
For an example bucket policy and usage report, see Monitoring SMS Activity in the\n Amazon SNS Developer Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the SetSMSAttributes action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#SetSMSAttributesResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The response for the SetSMSAttributes action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#SetSubscriptionAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#SetSubscriptionAttributesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#FilterPolicyLimitExceededException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + }, + { + "target": "com.amazonaws.sns#ReplayLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Allows a subscription owner to set an attribute of the subscription to a new\n value.
" + } + }, + "com.amazonaws.sns#SetSubscriptionAttributesInput": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", + "traits": { + "smithy.api#documentation": "The ARN of the subscription to modify.
", + "smithy.api#required": {} + } + }, + "AttributeName": { + "target": "com.amazonaws.sns#attributeName", + "traits": { + "smithy.api#documentation": "A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that this action uses:
\n\n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n FilterPolicy – The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.
\n FilterPolicyScope – This attribute lets you choose the\n filtering scope by using one of the following string value types:
\n MessageAttributes (default) – The filter is\n applied on the message attributes.
\n MessageBody – The filter is applied on the message\n body.
\n RawMessageDelivery – When set to true,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.
\n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
\n\n SubscriptionRoleArn – The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
\nAmazon SNS listed as a trusted entity
\nSpecifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Firehose delivery streams in the Amazon SNS Developer Guide.
\nThe new value for the attribute in JSON format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for SetSubscriptionAttributes action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#SetTopicAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#SetTopicAttributesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Allows a topic owner to set an attribute of the topic to a new value.
\nTo remove the ability to change topic permissions, you must deny permissions to\n the AddPermission, RemovePermission, and\n SetTopicAttributes actions in your IAM policy.
The ARN of the topic to modify.
", + "smithy.api#required": {} + } + }, + "AttributeName": { + "target": "com.amazonaws.sns#attributeName", + "traits": { + "smithy.api#documentation": "A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the SetTopicAttributes action uses:
\n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n DisplayName – The display name to use for a topic with SMS\n subscriptions.
\n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.
\n TracingConfig – Tracing mode of an Amazon SNS topic. By default\n TracingConfig is set to PassThrough, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.
HTTP
\n\n HTTPSuccessFeedbackRoleArn – Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.
\n HTTPSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an HTTP endpoint.
\n HTTPFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.
Amazon Data Firehose
\n\n FirehoseSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Amazon Data Firehose endpoint.
\n FirehoseSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon Data Firehose endpoint.
\n FirehoseFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon Data Firehose endpoint.
Lambda
\n\n LambdaSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Lambda endpoint.
\n LambdaSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Lambda endpoint.
\n LambdaFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Lambda endpoint.
Platform application endpoint
\n\n ApplicationSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an platform application endpoint.
\n ApplicationSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an platform application endpoint.
\n ApplicationFailureFeedbackRoleArn – Indicates\n failed message delivery status for an Amazon SNS topic that is subscribed to\n an platform application endpoint.
In addition to being able to configure topic attributes for message\n delivery status of notification messages sent to Amazon SNS application\n endpoints, you can also configure application attributes for the delivery\n status of push notification messages sent to push notification\n services.
\nFor example, For more information, see Using Amazon SNS Application\n Attributes for Message Delivery Status.
\nAmazon SQS
\n\n SQSSuccessFeedbackRoleArn – Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.
\n SQSSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon SQS endpoint.
\n SQSFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.
The
The following attribute applies only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.
\n SignatureVersion – The signature version corresponds to the\n hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion is set to 1.
The following attribute applies only to FIFO topics:
\n\n ArchivePolicy – The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.
\n ContentBasedDeduplication – Enables content-based\n deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to\n false. If you create a FIFO topic and this attribute is\n false, you must specify a value for the\n MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to\n true, Amazon SNS uses a SHA-256 hash to\n generate the MessageDeduplicationId using the body of the\n message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId parameter for the\n Publish action.
\n FifoThroughputScope – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:
\n Topic – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.
\n MessageGroup – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.
The new value for the attribute.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for SetTopicAttributes action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#StaleTagException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StaleTag", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "A tag has been added to a resource with the same ARN as a deleted resource. Wait a\n short while and then retry the operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#String": { + "type": "string" + }, + "com.amazonaws.sns#Subscribe": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#SubscribeInput" + }, + "output": { + "target": "com.amazonaws.sns#SubscribeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#FilterPolicyLimitExceededException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + }, + { + "target": "com.amazonaws.sns#ReplayLimitExceededException" + }, + { + "target": "com.amazonaws.sns#SubscriptionLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or\n if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must\n run the ConfirmSubscription action to confirm the subscription.
You call the ConfirmSubscription action with the token from the\n subscription response. Confirmation tokens are valid for two days.
This action is throttled at 100 transactions per second (TPS).
" + } + }, + "com.amazonaws.sns#SubscribeInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "The ARN of the topic you want to subscribe to.
", + "smithy.api#required": {} + } + }, + "Protocol": { + "target": "com.amazonaws.sns#protocol", + "traits": { + "smithy.api#documentation": "The protocol that you want to use. Supported protocols include:
\n\n http – delivery of JSON-encoded message via HTTP\n POST
\n https – delivery of JSON-encoded message via HTTPS\n POST
\n email – delivery of message via SMTP
\n email-json – delivery of JSON-encoded message via\n SMTP
\n sms – delivery of message via SMS
\n sqs – delivery of JSON-encoded message to an Amazon SQS\n queue
\n application – delivery of JSON-encoded message to an\n EndpointArn for a mobile app and device
\n lambda – delivery of JSON-encoded message to an Lambda\n function
\n firehose – delivery of JSON-encoded message to an Amazon\n Data Firehose delivery stream.
The endpoint that you want to receive notifications. Endpoints vary by\n protocol:
\nFor the http protocol, the (public) endpoint is a URL beginning\n with http://.
For the https protocol, the (public) endpoint is a URL beginning\n with https://.
For the email protocol, the endpoint is an email address.
For the email-json protocol, the endpoint is an email\n address.
For the sms protocol, the endpoint is a phone number of an\n SMS-enabled device.
For the sqs protocol, the endpoint is the ARN of an Amazon SQS\n queue.
For the application protocol, the endpoint is the EndpointArn of\n a mobile app and device.
For the lambda protocol, the endpoint is the ARN of an Lambda\n function.
For the firehose protocol, the endpoint is the ARN of an Amazon\n Data Firehose delivery stream.
A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the Subscribe action uses:
\n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n FilterPolicy – The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.
\n FilterPolicyScope – This attribute lets you choose the\n filtering scope by using one of the following string value types:
\n MessageAttributes (default) – The filter is\n applied on the message attributes.
\n MessageBody – The filter is applied on the message\n body.
\n RawMessageDelivery – When set to true,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.
\n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
\n\n SubscriptionRoleArn – The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
\nAmazon SNS listed as a trusted entity
\nSpecifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Firehose delivery streams in the Amazon SNS Developer Guide.
\nThe following attributes apply only to FIFO topics:
\n\n ReplayPolicy – Adds or updates an inline policy document\n for a subscription to replay messages stored in the specified Amazon SNS\n topic.
\n ReplayStatus – Retrieves the status of the subscription\n message replay, which can be one of the following:
\n Completed – The replay has successfully\n redelivered all messages, and is now delivering newly published\n messages. If an ending point was specified in the\n ReplayPolicy then the subscription will no longer\n receive newly published messages.
\n In progress – The replay is currently replaying\n the selected messages.
\n Failed – The replay was unable to complete.
\n Pending – The default state while the replay\n initiates.
Sets whether the response from the Subscribe request includes the\n subscription ARN, even if the subscription is not yet confirmed.
If you set this parameter to true, the response includes the ARN in all\n cases, even if the subscription is not yet confirmed. In addition to the ARN for\n confirmed subscriptions, the response also includes the pending\n subscription ARN value for subscriptions that aren't yet confirmed. A\n subscription becomes confirmed when the subscriber calls the\n ConfirmSubscription action with a confirmation token.
The default value is false.
Input for Subscribe action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#SubscribeResponse": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", + "traits": { + "smithy.api#documentation": "The ARN of the subscription if it is confirmed, or the string \"pending confirmation\"\n if the subscription requires confirmation. However, if the API request parameter\n ReturnSubscriptionArn is true, then the value is always the\n subscription ARN, even if the subscription requires confirmation.
Response for Subscribe action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#Subscription": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", + "traits": { + "smithy.api#documentation": "The subscription's ARN.
" + } + }, + "Owner": { + "target": "com.amazonaws.sns#account", + "traits": { + "smithy.api#documentation": "The subscription's owner.
" + } + }, + "Protocol": { + "target": "com.amazonaws.sns#protocol", + "traits": { + "smithy.api#documentation": "The subscription's protocol.
" + } + }, + "Endpoint": { + "target": "com.amazonaws.sns#Endpoint2", + "traits": { + "smithy.api#documentation": "The subscription's endpoint (format depends on the protocol).
" + } + }, + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "The ARN of the subscription's topic.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A wrapper type for the attributes of an Amazon SNS subscription.
" + } + }, + "com.amazonaws.sns#SubscriptionAttributesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sns#attributeName" + }, + "value": { + "target": "com.amazonaws.sns#attributeValue" + } + }, + "com.amazonaws.sns#SubscriptionLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionLimitExceeded", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "Indicates that the customer already owns the maximum allowed number of\n subscriptions.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#SubscriptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#Subscription" + } + }, + "com.amazonaws.sns#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sns#TagKey", + "traits": { + "smithy.api#documentation": "The required key portion of the tag.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sns#TagValue", + "traits": { + "smithy.api#documentation": "The optional value portion of the tag.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The list of tags to be added to the specified topic.
" + } + }, + "com.amazonaws.sns#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.sns#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#TagKey" + } + }, + "com.amazonaws.sns#TagLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TagLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Can't add more than 50 tags to a topic.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#Tag" + } + }, + "com.amazonaws.sns#TagPolicyException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TagPolicy", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The request doesn't comply with the IAM tag policy. Correct your request and then\n retry it.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.sns#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#ConcurrentAccessException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sns#StaleTagException" + }, + { + "target": "com.amazonaws.sns#TagLimitExceededException" + }, + { + "target": "com.amazonaws.sns#TagPolicyException" + } + ], + "traits": { + "smithy.api#documentation": "Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the\n Amazon SNS Developer Guide.
\nWhen you use topic tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a topic isn't recommended.
\nTags don't have any semantic meaning. Amazon SNS interprets tags as character\n strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the\n existing tag.
\nTagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If\n your application requires a higher throughput, file a technical support request.
\nThe ARN of the topic to which to add tags.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sns#TagList", + "traits": { + "smithy.api#documentation": "The tags to be added to the specified topic. A tag consists of a required key and an\n optional value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.sns#ThrottledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "Throttled request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "Throttled", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.sns#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.sns#TooManyEntriesInBatchRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TooManyEntriesInBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The batch request contains more entries than permissible (more than 10).
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#Topic": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "The topic's ARN.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's\n attributes, use GetTopicAttributes.
Indicates that the customer already owns the maximum allowed number of topics.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sns#TopicsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#Topic" + } + }, + "com.amazonaws.sns#Unsubscribe": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#UnsubscribeInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a subscription. If the subscription requires authentication for deletion, only\n the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services\n signature is required. If the Unsubscribe call does not require\n authentication and the requester is not the subscription owner, a final cancellation\n message is delivered to the endpoint, so that the endpoint owner can easily resubscribe\n to the topic if the Unsubscribe request was unintended.
This action is throttled at 100 transactions per second (TPS).
" + } + }, + "com.amazonaws.sns#UnsubscribeInput": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", + "traits": { + "smithy.api#documentation": "The ARN of the subscription to be deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for Unsubscribe action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.sns#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#ConcurrentAccessException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sns#StaleTagException" + }, + { + "target": "com.amazonaws.sns#TagLimitExceededException" + }, + { + "target": "com.amazonaws.sns#TagPolicyException" + } + ], + "traits": { + "smithy.api#documentation": "Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the\n Amazon SNS Developer Guide.
" + } + }, + "com.amazonaws.sns#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sns#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the topic from which to remove tags.
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.sns#TagKeyList", + "traits": { + "smithy.api#documentation": "The list of tag keys to remove from the specified topic.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sns#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#UserErrorException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserError", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Indicates that a request parameter does not comply with the associated\n constraints.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ValidationException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Indicates that a parameter in the request is invalid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#VerificationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "The status of the verification error.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates that the one-time password (OTP) used for verification is invalid.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sns#VerifySMSSandboxPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#VerifySMSSandboxPhoneNumberInput" + }, + "output": { + "target": "com.amazonaws.sns#VerifySMSSandboxPhoneNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sns#ThrottledException" + }, + { + "target": "com.amazonaws.sns#VerificationException" + } + ], + "traits": { + "smithy.api#documentation": "Verifies a destination phone number with a one-time password (OTP) for the calling\n Amazon Web Services account.
\nWhen you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.
" + } + }, + "com.amazonaws.sns#VerifySMSSandboxPhoneNumberInput": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.sns#PhoneNumberString", + "traits": { + "smithy.api#documentation": "The destination phone number to verify.
", + "smithy.api#required": {} + } + }, + "OneTimePassword": { + "target": "com.amazonaws.sns#OTPCode", + "traits": { + "smithy.api#documentation": "The OTP sent to the destination number from the\n CreateSMSSandBoxPhoneNumber call.
The destination phone number's verification status.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sns#account": { + "type": "string" + }, + "com.amazonaws.sns#action": { + "type": "string" + }, + "com.amazonaws.sns#attributeName": { + "type": "string" + }, + "com.amazonaws.sns#attributeValue": { + "type": "string" + }, + "com.amazonaws.sns#authenticateOnUnsubscribe": { + "type": "string" + }, + "com.amazonaws.sns#boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.sns#delegate": { + "type": "string" + }, + "com.amazonaws.sns#label": { + "type": "string" + }, + "com.amazonaws.sns#message": { + "type": "string" + }, + "com.amazonaws.sns#messageId": { + "type": "string" + }, + "com.amazonaws.sns#messageStructure": { + "type": "string" + }, + "com.amazonaws.sns#nextToken": { + "type": "string" + }, + "com.amazonaws.sns#protocol": { + "type": "string" + }, + "com.amazonaws.sns#subject": { + "type": "string" + }, + "com.amazonaws.sns#subscriptionARN": { + "type": "string" + }, + "com.amazonaws.sns#token": { + "type": "string" + }, + "com.amazonaws.sns#topicARN": { + "type": "string" + }, + "com.amazonaws.sns#topicName": { + "type": "string" + } + } +} diff --git a/codegen/aws-models/sts.json b/codegen/aws-models/sts.json new file mode 100644 index 0000000..dcf278b --- /dev/null +++ b/codegen/aws-models/sts.json @@ -0,0 +1,4504 @@ +{ + "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.sts#AWSSecurityTokenServiceV20110615": { + "type": "service", + "version": "2011-06-15", + "operations": [ + { + "target": "com.amazonaws.sts#AssumeRole" + }, + { + "target": "com.amazonaws.sts#AssumeRoleWithSAML" + }, + { + "target": "com.amazonaws.sts#AssumeRoleWithWebIdentity" + }, + { + "target": "com.amazonaws.sts#AssumeRoot" + }, + { + "target": "com.amazonaws.sts#DecodeAuthorizationMessage" + }, + { + "target": "com.amazonaws.sts#GetAccessKeyInfo" + }, + { + "target": "com.amazonaws.sts#GetCallerIdentity" + }, + { + "target": "com.amazonaws.sts#GetDelegatedAccessToken" + }, + { + "target": "com.amazonaws.sts#GetFederationToken" + }, + { + "target": "com.amazonaws.sts#GetSessionToken" + }, + { + "target": "com.amazonaws.sts#GetWebIdentityToken" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "STS", + "arnNamespace": "sts", + "cloudFormationName": "STS", + "cloudTrailEventSource": "sts.amazonaws.com", + "endpointPrefix": "sts" + }, + "aws.auth#sigv4": { + "name": "sts" + }, + "aws.auth#sigv4a": { + "name": "sts" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#auth": [ + "aws.auth#sigv4", + "aws.auth#sigv4a" + ], + "smithy.api#documentation": "Security Token Service (STS) enables you to request temporary, limited-privilege \n credentials for users. This guide provides descriptions of the STS API. For \n more information about using this service, see Temporary Security Credentials.
", + "smithy.api#title": "AWS Security Token Service", + "smithy.api#xmlNamespace": { + "uri": "https://sts.amazonaws.com/doc/2011-06-15/" + }, + "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" + }, + "UseGlobalEndpoint": { + "builtIn": "AWS::STS::UseGlobalEndpoint", + "required": true, + "default": false, + "documentation": "Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.", + "type": "boolean" + } + }, + "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": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "eu-central-1" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "ap-south-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "eu-north-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "eu-west-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "eu-west-2" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "eu-west-3" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "sa-east-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-2" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-west-2" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-west-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "ca-central-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "ap-southeast-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "ap-northeast-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "ap-southeast-2" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "results": [ + { + "conditions": [], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sts.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "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://sts-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://sts.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sts-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://sts.{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://sts.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 31, + "nodes": "/////wAAAAH/////AAAAAAAAAB4AAAADAAAAAQAAAAQF9eEOAAAAAgAAAAUF9eEOAAAAAwAAABkAAAAGAAAABAAAABgAAAAHAAAABQX14QEAAAAIAAAABgAAAAkF9eENAAAABwX14QEAAAAKAAAACgX14QEAAAALAAAACwX14QEAAAAMAAAADAX14QEAAAANAAAADQX14QEAAAAOAAAADgX14QEAAAAPAAAADwX14QEAAAAQAAAAEAX14QEAAAARAAAAEQX14QEAAAASAAAAEgX14QEAAAATAAAAEwX14QEAAAAUAAAAFAX14QEAAAAVAAAAFQX14QEAAAAWAAAAFgX14QEAAAAXAAAAFwX14QEF9eECAAAACAX14QsF9eEMAAAABAAAABwAAAAaAAAACQAAABsF9eEKAAAAGAX14QgF9eEJAAAACAAAAB0F9eEHAAAACQX14QYF9eEHAAAAAwX14QMAAAAfAAAABAX14QQF9eEF" + }, + "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" + }, + "UseGlobalEndpoint": { + "builtIn": "AWS::STS::UseGlobalEndpoint", + "required": true, + "default": false, + "documentation": "Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.", + "type": "boolean" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseGlobalEndpoint" + }, + true + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + }, + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "ap-northeast-1" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "ap-south-1" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "ap-southeast-1" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "ap-southeast-2" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "ca-central-1" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "eu-central-1" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "eu-north-1" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "eu-west-1" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "eu-west-2" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "eu-west-3" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "sa-east-1" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-2" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-west-1" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-west-2" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sts.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "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://sts-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-us-gov" + ] + } + ], + "endpoint": { + "url": "https://sts.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sts-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://sts.{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": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://sts.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sts.{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://sts.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://sts.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://sts.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://sts.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://sts.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://sts.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://sts.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://sts.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sts.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sts.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://sts.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://sts.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://sts.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://sts.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://sts.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://sts.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://sts.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://sts.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://sts.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://sts-fips.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://sts.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://sts-fips.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://sts.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://sts-fips.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://sts.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://sts-fips.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://sts-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://sts.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://sts.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://sts.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://sts-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://sts-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://sts.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sts.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sts.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sts.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://sts.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://sts-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 disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sts.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sts.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sts.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sts-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 disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sts.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sts-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "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" + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `ap-northeast-1`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "ap-northeast-1", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `ap-south-1`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "ap-south-1", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `ap-southeast-1`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "ap-southeast-1", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `ap-southeast-2`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "ap-southeast-2", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `aws-global`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `ca-central-1`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "ca-central-1", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `eu-central-1`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "eu-central-1", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `eu-north-1`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "eu-north-1", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `eu-west-1`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "eu-west-1", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `eu-west-2`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "eu-west-2", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `eu-west-3`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "eu-west-3", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `sa-east-1`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "sa-east-1", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `us-east-1`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `us-east-2`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-2", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `us-west-1`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-1", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region `us-west-2`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://sts.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with Non-legacy region `us-east-3`", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "sts", + "signingRegion": "us-east-3" + } + ] + }, + "url": "https://sts.us-east-3.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-3", + "AWS::STS::UseGlobalEndpoint": true + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "us-east-3", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "UseGlobalEndpoint with legacy region and custom endpoint", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-1", + "AWS::STS::UseGlobalEndpoint": true, + "SDK::Endpoint": "https://example.com" + }, + "operationName": "GetCallerIdentity" + } + ], + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "UseGlobalEndpoint with unset region and custom endpoint", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "UseGlobalEndpoint": false, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.sts#AssumeRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.sts#AssumeRoleRequest" + }, + "output": { + "target": "com.amazonaws.sts#AssumeRoleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sts#ExpiredTokenException" + }, + { + "target": "com.amazonaws.sts#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.sts#PackedPolicyTooLargeException" + }, + { + "target": "com.amazonaws.sts#RegionDisabledException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a set of temporary security credentials that you can use to access Amazon Web Services\n resources. These temporary credentials consist of an access key ID, a secret access key,\n and a security token. Typically, you use AssumeRole within your account or for\n cross-account access. For a comparison of AssumeRole with other API operations\n that produce temporary credentials, see Requesting Temporary Security\n Credentials and Compare STS\n credentials in the IAM User Guide.
\n Permissions\n
\nThe temporary security credentials created by AssumeRole can be used to\n make API calls to any Amazon Web Services service with the following exception: You cannot call the\n Amazon Web Services STS GetFederationToken or GetSessionToken API\n operations.
(Optional) You can pass inline or managed session policies to this operation. You can\n pass a single JSON policy document to use as an inline session policy. You can also specify\n up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nWhen you create a role, you create two policies: a role trust policy that specifies\n who can assume the role, and a permissions policy that specifies\n what can be done with the role. You specify the trusted principal\n that is allowed to assume the role in the role trust policy.
\nTo assume a role from a different account, your Amazon Web Services account must be trusted by the\n role. The trust relationship is defined in the role's trust policy when the role is\n created. That trust policy states which accounts are allowed to delegate that access to\n users in the account.
\nA user who wants to access a role in a different account must also have permissions that\n are delegated from the account administrator. The administrator must attach a policy that\n allows the user to call AssumeRole for the ARN of the role in the other\n account.
To allow a user to assume a role in the same account, you can do either of the\n following:
\nAttach a policy to the user that allows the user to call AssumeRole\n (as long as the role's trust policy trusts the account).
Add the user as a principal directly in the role's trust policy.
\nYou can do either because the role’s trust policy acts as an IAM resource-based\n policy. When a resource-based policy grants access to a principal in the same account, no\n additional identity-based policy is required. For more information about trust policies and\n resource-based policies, see IAM Policies in the\n IAM User Guide.
\n\n Tags\n
\n(Optional) You can pass tag key-value pairs to your session. These tags are called\n session tags. For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nAn administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.
\nYou can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.
\n\n Using MFA with AssumeRole\n
\n(Optional) You can include multi-factor authentication (MFA) information when you call\n AssumeRole. This is useful for cross-account scenarios to ensure that the\n user that assumes the role has been authenticated with an Amazon Web Services MFA device. In that\n scenario, the trust policy of the role being assumed includes a condition that tests for\n MFA authentication. If the caller does not include valid MFA information, the request to\n assume the role is denied. The condition in a trust policy that tests for MFA\n authentication might look like the following example.
\n \"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}\n
For more information, see Configuring MFA-Protected API Access\n in the IAM User Guide guide.
\nTo use MFA with AssumeRole, you pass values for the\n SerialNumber and TokenCode parameters. The\n SerialNumber value identifies the user's hardware or virtual MFA device.\n The TokenCode is the time-based one-time password (TOTP) that the MFA device\n produces.
The Amazon Resource Name (ARN) of the role to assume.
", + "smithy.api#required": {} + } + }, + "RoleSessionName": { + "target": "com.amazonaws.sts#roleSessionNameType", + "traits": { + "smithy.api#documentation": "An identifier for the assumed role session.
\nUse the role session name to uniquely identify a session when the same role is assumed\n by different principals or for different reasons. In cross-account scenarios, the role\n session name is visible to, and can be logged by the account that owns the role. The role\n session name is also used in the ARN of the assumed role principal. This means that\n subsequent cross-account API requests that use the temporary security credentials will\n expose the role session name to the external account in their CloudTrail logs.
\nFor security purposes, administrators can view this field in CloudTrail logs to help identify who performed an action in Amazon Web Services. Your\n administrator might require that you specify your user name as the session name when you\n assume the role. For more information, see \n sts:RoleSessionName\n .
The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: +=,.@-
", + "smithy.api#required": {} + } + }, + "PolicyArns": { + "target": "com.amazonaws.sts#policyDescriptorListType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.
\nThis parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
" + } + }, + "Policy": { + "target": "com.amazonaws.sts#unrestrictedSessionPolicyDocumentType", + "traits": { + "smithy.api#documentation": "An IAM policy in JSON format that you want to use as an inline session policy.
\nThis parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nThe plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
For more information about role session permissions, see Session\n policies.
" + } + }, + "DurationSeconds": { + "target": "com.amazonaws.sts#roleDurationSecondsType", + "traits": { + "smithy.api#documentation": "The duration, in seconds, of the role session. The value specified can range from 900\n seconds (15 minutes) up to the maximum session duration set for the role. The maximum\n session duration setting can have a value from 1 hour to 12 hours. If you specify a value\n higher than this setting or the administrator setting (whichever is lower), the operation\n fails. For example, if you specify a session duration of 12 hours, but your administrator\n set the maximum session duration to 6 hours, your operation fails.
\nRole chaining limits your Amazon Web Services CLI or Amazon Web Services API role session to a maximum of one hour.\n When you use the AssumeRole API operation to assume a role, you can specify\n the duration of your role session with the DurationSeconds parameter. You can\n specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum\n session duration setting for your role. However, if you assume a role using role chaining\n and provide a DurationSeconds parameter value greater than one hour, the\n operation fails. To learn how to view the maximum value for your role, see Update the maximum session duration for a role.
By default, the value is set to 3600 seconds.
The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the Amazon Web Services Management Console in the\n IAM User Guide.
A list of session tags that you want to pass. Each session tag consists of a key name\n and an associated value. For more information about session tags, see Tagging Amazon Web Services STS\n Sessions in the IAM User Guide.
\nThis parameter is optional. You can pass up to 50 session tags. The plaintext session\n tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is already attached to the\n role. When you do, session tags override a role tag with the same key.
\nTag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.
Additionally, if you used temporary credentials to perform this operation, the new\n session inherits any transitive session tags from the calling session. If you pass a\n session tag with the same key as an inherited tag, the operation fails. To view the\n inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the\n IAM User Guide.
" + } + }, + "TransitiveTagKeys": { + "target": "com.amazonaws.sts#tagKeyListType", + "traits": { + "smithy.api#documentation": "A list of keys for session tags that you want to set as transitive. If you set a tag key\n as transitive, the corresponding key and value passes to subsequent sessions in a role\n chain. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.
\nThis parameter is optional. The transitive status of a session tag does not impact its\n packed binary size.
\nIf you choose not to specify a transitive tag key, then no tags are passed from this\n session to any subsequent sessions.
" + } + }, + "ExternalId": { + "target": "com.amazonaws.sts#externalIdType", + "traits": { + "smithy.api#documentation": "A unique identifier that might be required when you assume a role in another account. If\n the administrator of the account to which the role belongs provided you with an external\n ID, then provide that value in the ExternalId parameter. This value can be any\n string, such as a passphrase or account number. A cross-account role is usually set up to\n trust everyone in an account. Therefore, the administrator of the trusting account might\n send an external ID to the administrator of the trusted account. That way, only someone\n with the ID can assume the role, rather than everyone in the account. For more information\n about the external ID, see How to Use an External ID\n When Granting Access to Your Amazon Web Services Resources to a Third Party in the\n IAM User Guide.
The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: +=,.@:\\/-
" + } + }, + "SerialNumber": { + "target": "com.amazonaws.sts#serialNumberType", + "traits": { + "smithy.api#documentation": "The identification number of the MFA device that is associated with the user who is\n making the AssumeRole call. Specify this value if the trust policy of the role\n being assumed includes a condition that requires MFA authentication. The value is either\n the serial number for a hardware device (such as GAHT12345678) or an Amazon\n Resource Name (ARN) for a virtual device (such as\n arn:aws:iam::123456789012:mfa/user).
The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: +=/:,.@-
" + } + }, + "TokenCode": { + "target": "com.amazonaws.sts#tokenCodeType", + "traits": { + "smithy.api#documentation": "The value provided by the MFA device, if the trust policy of the role being assumed\n requires MFA. (In other words, if the policy includes a condition that tests for MFA). If\n the role being assumed requires MFA and if the TokenCode value is missing or\n expired, the AssumeRole call returns an \"access denied\" error.
The format for this parameter, as described by its regex pattern, is a sequence of six\n numeric digits.
" + } + }, + "SourceIdentity": { + "target": "com.amazonaws.sts#sourceIdentityType", + "traits": { + "smithy.api#documentation": "The source identity specified by the principal that is calling the\n AssumeRole operation. The source identity value persists across chained role sessions.
You can require users to specify a source identity when they assume a role. You do this\n by using the \n sts:SourceIdentity\n condition key in a role trust policy. You\n can use source identity information in CloudTrail logs to determine who took actions with a\n role. You can use the aws:SourceIdentity condition key to further control\n access to Amazon Web Services resources based on the value of source identity. For more information about\n using source identity, see Monitor and control\n actions taken with assumed roles in the\n IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper-\n and lower-case alphanumeric characters with no spaces. You can also include underscores or\n any of the following characters: +=,.@-. You cannot use a value that begins with the text\n aws:. This prefix is reserved for Amazon Web Services internal use.
A list of previously acquired trusted context assertions in the format of a JSON array.\n The trusted context assertion is signed and encrypted by Amazon Web Services STS.
\nThe following is an example of a ProvidedContext value that includes a\n single trusted context assertion and the ARN of the context provider from which the trusted\n context assertion was generated.
\n [{\"ProviderArn\":\"arn:aws:iam::aws:contextProvider/IdentityCenter\",\"ContextAssertion\":\"trusted-context-assertion\"}]\n
The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.
\nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nThe Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you\n can use to refer to the resulting temporary security credentials. For example, you can\n reference these credentials as a principal in a resource-based policy by using the ARN or\n assumed role ID. The ARN and ID include the RoleSessionName that you specified\n when you called AssumeRole.
A percentage value that indicates the packed size of the session policies and session \n tags combined passed in the request. The request fails if the packed size is greater than 100 percent, \n which means the policies and tags exceeded the allowed space.
" + } + }, + "SourceIdentity": { + "target": "com.amazonaws.sts#sourceIdentityType", + "traits": { + "smithy.api#documentation": "The source identity specified by the principal that is calling the\n AssumeRole operation.
You can require users to specify a source identity when they assume a role. You do this\n by using the sts:SourceIdentity condition key in a role trust policy. You can\n use source identity information in CloudTrail logs to determine who took actions with a role.\n You can use the aws:SourceIdentity condition key to further control access to\n Amazon Web Services resources based on the value of source identity. For more information about using\n source identity, see Monitor and control\n actions taken with assumed roles in the\n IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper-\n and lower-case alphanumeric characters with no spaces. You can also include underscores or\n any of the following characters: =,.@-
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the response to a successful AssumeRole request, including\n temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sts#AssumeRoleWithSAML": { + "type": "operation", + "input": { + "target": "com.amazonaws.sts#AssumeRoleWithSAMLRequest" + }, + "output": { + "target": "com.amazonaws.sts#AssumeRoleWithSAMLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sts#ExpiredTokenException" + }, + { + "target": "com.amazonaws.sts#IDPRejectedClaimException" + }, + { + "target": "com.amazonaws.sts#InvalidIdentityTokenException" + }, + { + "target": "com.amazonaws.sts#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.sts#PackedPolicyTooLargeException" + }, + { + "target": "com.amazonaws.sts#RegionDisabledException" + } + ], + "traits": { + "smithy.api#auth": [], + "smithy.api#documentation": "Returns a set of temporary security credentials for users who have been authenticated\n via a SAML authentication response. This operation provides a mechanism for tying an\n enterprise identity store or directory to role-based Amazon Web Services access without user-specific\n credentials or configuration. For a comparison of AssumeRoleWithSAML with the\n other API operations that produce temporary credentials, see Requesting Temporary Security\n Credentials and Compare STS\n credentials in the IAM User Guide.
The temporary security credentials returned by this operation consist of an access key\n ID, a secret access key, and a security token. Applications can use these temporary\n security credentials to sign calls to Amazon Web Services services.
\nAssumeRoleWithSAML will not work on IAM Identity Center managed roles. These roles' names start\n with AWSReservedSSO_.
\n Session Duration\n
\nBy default, the temporary security credentials created by\n AssumeRoleWithSAML last for one hour. However, you can use the optional\n DurationSeconds parameter to specify the duration of your session. Your\n role session lasts for the duration that you specify, or until the time specified in the\n SAML authentication response's SessionNotOnOrAfter value, whichever is\n shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes)\n up to the maximum session duration setting for the role. This setting can have a value from\n 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide. The maximum session duration limit applies when\n you use the AssumeRole* API operations or the assume-role* CLI\n commands. However the limit does not apply when you use those operations to create a\n console URL. For more information, see Using IAM Roles in the\n IAM User Guide.
\n Role chaining limits your CLI or Amazon Web Services API role\n session to a maximum of one hour. When you use the AssumeRole API operation\n to assume a role, you can specify the duration of your role session with the\n DurationSeconds parameter. You can specify a parameter value of up to\n 43200 seconds (12 hours), depending on the maximum session duration setting for your\n role. However, if you assume a role using role chaining and provide a\n DurationSeconds parameter value greater than one hour, the operation\n fails.
\n Permissions\n
\nThe temporary security credentials created by AssumeRoleWithSAML can be\n used to make API calls to any Amazon Web Services service with the following exception: you cannot call\n the STS GetFederationToken or GetSessionToken API\n operations.
(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as\n managed session policies. The plaintext that you use for both inline and managed session\n policies can't exceed 2,048 characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nCalling AssumeRoleWithSAML does not require the use of Amazon Web Services security\n credentials. The identity of the caller is validated by using keys in the metadata document\n that is uploaded for the SAML provider entity for your identity provider.
Calling AssumeRoleWithSAML can result in an entry in your CloudTrail logs.\n The entry includes the value in the NameID element of the SAML assertion.\n We recommend that you use a NameIDType that is not associated with any\n personally identifiable information (PII). For example, you could instead use the\n persistent identifier\n (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).
\n Tags\n
\n(Optional) You can configure your IdP to pass attributes into your SAML assertion as\n session tags. Each session tag consists of a key name and an associated value. For more\n information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nYou can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128\n characters and the values can’t exceed 256 characters. For these and additional limits, see\n IAM\n and STS Character Limits in the IAM User Guide.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is attached to the role. When\n you do, session tags override the role's tags with the same key.
\nAn administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.
\nYou can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.
\n\n SAML Configuration\n
\nBefore your application can call AssumeRoleWithSAML, you must configure\n your SAML identity provider (IdP) to issue the claims required by Amazon Web Services. Additionally, you\n must use Identity and Access Management (IAM) to create a SAML provider entity in your Amazon Web Services account that\n represents your identity provider. You must also create an IAM role that specifies this\n SAML provider in its trust policy.
For more information, see the following resources:
\n\n About\n SAML 2.0-based Federation in the IAM User Guide.\n
\n\n Creating SAML Identity Providers in the\n IAM User Guide.
\n\n Configuring\n a Relying Party and Claims in the IAM User Guide.\n
\n\n Creating a Role for SAML 2.0 Federation in the\n IAM User Guide.
\nThe Amazon Resource Name (ARN) of the role that the caller is assuming.
", + "smithy.api#required": {} + } + }, + "PrincipalArn": { + "target": "com.amazonaws.sts#arnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the\n IdP.
", + "smithy.api#required": {} + } + }, + "SAMLAssertion": { + "target": "com.amazonaws.sts#SAMLAssertionType", + "traits": { + "smithy.api#documentation": "The base64 encoded SAML authentication response provided by the IdP.
\nFor more information, see Configuring a Relying Party and\n Adding Claims in the IAM User Guide.
", + "smithy.api#required": {} + } + }, + "PolicyArns": { + "target": "com.amazonaws.sts#policyDescriptorListType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.
\nThis parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
" + } + }, + "Policy": { + "target": "com.amazonaws.sts#sessionPolicyDocumentType", + "traits": { + "smithy.api#documentation": "An IAM policy in JSON format that you want to use as an inline session policy.
\nThis parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nThe plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\nFor more information about role session permissions, see Session\n policies.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
The duration, in seconds, of the role session. Your role session lasts for the duration\n that you specify for the DurationSeconds parameter, or until the time\n specified in the SAML authentication response's SessionNotOnOrAfter value,\n whichever is shorter. You can provide a DurationSeconds value from 900 seconds\n (15 minutes) up to the maximum session duration setting for the role. This setting can have\n a value from 1 hour to 12 hours. If you specify a value higher than this setting, the\n operation fails. For example, if you specify a session duration of 12 hours, but your\n administrator set the maximum session duration to 6 hours, your operation fails. To learn\n how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide.
By default, the value is set to 3600 seconds.
The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the Amazon Web Services Management Console in the\n IAM User Guide.
The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.
\nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nThe identifiers for the temporary security credentials that the operation\n returns.
" + } + }, + "PackedPolicySize": { + "target": "com.amazonaws.sts#nonNegativeIntegerType", + "traits": { + "smithy.api#documentation": "A percentage value that indicates the packed size of the session policies and session \n tags combined passed in the request. The request fails if the packed size is greater than 100 percent, \n which means the policies and tags exceeded the allowed space.
" + } + }, + "Subject": { + "target": "com.amazonaws.sts#Subject", + "traits": { + "smithy.api#documentation": "The value of the NameID element in the Subject element of the\n SAML assertion.
The format of the name ID, as defined by the Format attribute in the\n NameID element of the SAML assertion. Typical examples of the format are\n transient or persistent.
If the format includes the prefix\n urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For\n example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as\n transient. If the format includes any other prefix, the format is returned\n with no modifications.
The value of the Issuer element of the SAML assertion.
The value of the Recipient attribute of the\n SubjectConfirmationData element of the SAML assertion.
A hash value based on the concatenation of the following:
\nThe Issuer response value.
The Amazon Web Services account ID.
\nThe friendly name (the last part of the ARN) of the SAML provider in IAM.
\nThe combination of NameQualifier and Subject can be used to\n uniquely identify a user.
The following pseudocode shows how the hash value is calculated:
\n\n BASE64 ( SHA1 ( \"https://example.com/saml\" + \"123456789012\" + \"/MySAMLIdP\" ) )\n
The value in the SourceIdentity attribute in the SAML assertion. The source\n identity value persists across chained role\n sessions.
You can require users to set a source identity value when they assume a role. You do\n this by using the sts:SourceIdentity condition key in a role trust policy.\n That way, actions that are taken with the role are associated with that user. After the\n source identity is set, the value cannot be changed. It is present in the request for all\n actions that are taken by the role and persists across chained role\n sessions. You can configure your SAML identity provider to use an attribute associated with\n your users, like user name or email, as the source identity when calling\n AssumeRoleWithSAML. You do this by adding an attribute to the SAML\n assertion. For more information about using source identity, see Monitor and control\n actions taken with assumed roles in the\n IAM User Guide.
The regex used to validate this parameter is a string of characters \n consisting of upper- and lower-case alphanumeric characters with no spaces. You can \n also include underscores or any of the following characters: =,.@-
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the response to a successful AssumeRoleWithSAML request,\n including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sts#AssumeRoleWithWebIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.sts#AssumeRoleWithWebIdentityRequest" + }, + "output": { + "target": "com.amazonaws.sts#AssumeRoleWithWebIdentityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sts#ExpiredTokenException" + }, + { + "target": "com.amazonaws.sts#IDPCommunicationErrorException" + }, + { + "target": "com.amazonaws.sts#IDPRejectedClaimException" + }, + { + "target": "com.amazonaws.sts#InvalidIdentityTokenException" + }, + { + "target": "com.amazonaws.sts#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.sts#PackedPolicyTooLargeException" + }, + { + "target": "com.amazonaws.sts#RegionDisabledException" + } + ], + "traits": { + "smithy.api#auth": [], + "smithy.api#documentation": "Returns a set of temporary security credentials for users who have been authenticated in\n a mobile or web application with a web identity provider. Example providers include the\n OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible\n identity provider such as Google or Amazon Cognito federated identities.
\nFor mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the\n Amazon Web Services SDK for iOS Developer Guide and the Amazon Web Services SDK for Android Developer Guide to uniquely\n identify a user. You can also supply the user with a consistent identity throughout the\n lifetime of an application.
\nTo learn more about Amazon Cognito, see Amazon Cognito identity\n pools in Amazon Cognito Developer Guide.
\nCalling AssumeRoleWithWebIdentity does not require the use of Amazon Web Services\n security credentials. Therefore, you can distribute an application (for example, on mobile\n devices) that requests temporary security credentials without including long-term Amazon Web Services\n credentials in the application. You also don't need to deploy server-based proxy services\n that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by\n using a token from the web identity provider. For a comparison of\n AssumeRoleWithWebIdentity with the other API operations that produce\n temporary credentials, see Requesting Temporary Security\n Credentials and Compare STS\n credentials in the IAM User Guide.
The temporary security credentials returned by this API consist of an access key ID, a\n secret access key, and a security token. Applications can use these temporary security\n credentials to sign calls to Amazon Web Services service API operations.
\n\n Session Duration\n
\nBy default, the temporary security credentials created by\n AssumeRoleWithWebIdentity last for one hour. However, you can use the\n optional DurationSeconds parameter to specify the duration of your session.\n You can provide a value from 900 seconds (15 minutes) up to the maximum session duration\n setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how\n to view the maximum value for your role, see Update the maximum session duration for a role in the\n IAM User Guide. The maximum session duration limit applies when\n you use the AssumeRole* API operations or the assume-role* CLI\n commands. However the limit does not apply when you use those operations to create a\n console URL. For more information, see Using IAM Roles in the\n IAM User Guide.
\n Permissions\n
\nThe temporary security credentials created by AssumeRoleWithWebIdentity can\n be used to make API calls to any Amazon Web Services service with the following exception: you cannot\n call the STS GetFederationToken or GetSessionToken API\n operations.
(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as\n managed session policies. The plaintext that you use for both inline and managed session\n policies can't exceed 2,048 characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\n\n Tags\n
\n(Optional) You can configure your IdP to pass attributes into your web identity token as\n session tags. Each session tag consists of a key name and an associated value. For more\n information about session tags, see Passing\n session tags using AssumeRoleWithWebIdentity in the\n IAM User Guide.
\nYou can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128\n characters and the values can’t exceed 256 characters. For these and additional limits, see\n IAM\n and STS Character Limits in the IAM User Guide.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is attached to the role. When\n you do, the session tag overrides the role tag with the same key.
\nAn administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.
\nYou can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.
\n\n Identities\n
\nBefore your application can call AssumeRoleWithWebIdentity, you must have\n an identity token from a supported identity provider and create a role that the application\n can assume. The role that your application assumes must trust the identity provider that is\n associated with the identity token. In other words, the identity provider must be specified\n in the role's trust policy.
Calling AssumeRoleWithWebIdentity can result in an entry in your\n CloudTrail logs. The entry includes the Subject of\n the provided web identity token. We recommend that you avoid using any personally\n identifiable information (PII) in this field. For example, you could instead use a GUID\n or a pairwise identifier, as suggested\n in the OIDC specification.
For more information about how to use OIDC federation and the\n AssumeRoleWithWebIdentity API, see the following resources:
\n Using Web Identity Federation API Operations for Mobile Apps and Federation Through a Web-based Identity Provider.
\n\n Amazon Web Services SDK for iOS Developer Guide and Amazon Web Services SDK for Android Developer Guide. These toolkits\n contain sample apps that show how to invoke the identity providers. The toolkits then\n show how to use the information from these providers to get and use temporary\n security credentials.
\nThe Amazon Resource Name (ARN) of the role that the caller is assuming.
\nAdditional considerations apply to Amazon Cognito identity pools that assume cross-account IAM roles. The trust policies of these roles must accept the\n cognito-identity.amazonaws.com service principal and must contain the\n cognito-identity.amazonaws.com:aud condition key to restrict role\n assumption to users from your intended identity pools. A policy that trusts Amazon Cognito\n identity pools without this condition creates a risk that a user from an unintended\n identity pool can assume the role. For more information, see Trust policies for\n IAM roles in Basic (Classic) authentication in the Amazon Cognito\n Developer Guide.
An identifier for the assumed role session. Typically, you pass the name or identifier\n that is associated with the user who is using your application. That way, the temporary\n security credentials that your application will use are associated with that user. This\n session name is included as part of the ARN and assumed role ID in the\n AssumedRoleUser response element.
For security purposes, administrators can view this field in CloudTrail logs to help identify who performed an action in Amazon Web Services. Your\n administrator might require that you specify your user name as the session name when you\n assume the role. For more information, see \n sts:RoleSessionName\n .
The regex used to validate this parameter is a string of characters \n consisting of upper- and lower-case alphanumeric characters with no spaces. You can \n also include underscores or any of the following characters: =,.@-
", + "smithy.api#required": {} + } + }, + "WebIdentityToken": { + "target": "com.amazonaws.sts#clientTokenType", + "traits": { + "smithy.api#documentation": "The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity\n provider. Your application must get this token by authenticating the user who is using your\n application with a web identity provider before the application makes an\n AssumeRoleWithWebIdentity call. Timestamps in the token must be formatted\n as either an integer or a long integer. Tokens must be signed using either RSA keys (RS256,\n RS384, or RS512) or ECDSA keys (ES256, ES384, or ES512).
The fully qualified host component of the domain name of the OAuth 2.0 identity\n provider. Do not specify this value for an OpenID Connect identity provider.
\nCurrently www.amazon.com and graph.facebook.com are the only\n supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and\n port numbers.
Do not specify this value for OpenID Connect ID tokens.
" + } + }, + "PolicyArns": { + "target": "com.amazonaws.sts#policyDescriptorListType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.
\nThis parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
" + } + }, + "Policy": { + "target": "com.amazonaws.sts#sessionPolicyDocumentType", + "traits": { + "smithy.api#documentation": "An IAM policy in JSON format that you want to use as an inline session policy.
\nThis parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nThe plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\nFor more information about role session permissions, see Session\n policies.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
The duration, in seconds, of the role session. The value can range from 900 seconds (15\n minutes) up to the maximum session duration setting for the role. This setting can have a\n value from 1 hour to 12 hours. If you specify a value higher than this setting, the\n operation fails. For example, if you specify a session duration of 12 hours, but your\n administrator set the maximum session duration to 6 hours, your operation fails. To learn\n how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide.
\nBy default, the value is set to 3600 seconds.
The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the Amazon Web Services Management Console in the\n IAM User Guide.
The temporary security credentials, which include an access key ID, a secret access key,\n and a security token.
\nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nThe unique user identifier that is returned by the identity provider. This identifier is\n associated with the WebIdentityToken that was submitted with the\n AssumeRoleWithWebIdentity call. The identifier is typically unique to the\n user and the application that acquired the WebIdentityToken (pairwise\n identifier). For OpenID Connect ID tokens, this field contains the value returned by the\n identity provider as the token's sub (Subject) claim.
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you\n can use to refer to the resulting temporary security credentials. For example, you can\n reference these credentials as a principal in a resource-based policy by using the ARN or\n assumed role ID. The ARN and ID include the RoleSessionName that you specified\n when you called AssumeRole.
A percentage value that indicates the packed size of the session policies and session \n tags combined passed in the request. The request fails if the packed size is greater than 100 percent, \n which means the policies and tags exceeded the allowed space.
" + } + }, + "Provider": { + "target": "com.amazonaws.sts#Issuer", + "traits": { + "smithy.api#documentation": " The issuing authority of the web identity token presented. For OpenID Connect ID\n tokens, this contains the value of the iss field. For OAuth 2.0 access tokens,\n this contains the value of the ProviderId parameter that was passed in the\n AssumeRoleWithWebIdentity request.
The intended audience (also known as client ID) of the web identity token. This is\n traditionally the client identifier issued to the application that requested the web\n identity token.
" + } + }, + "SourceIdentity": { + "target": "com.amazonaws.sts#sourceIdentityType", + "traits": { + "smithy.api#documentation": "The value of the source identity that is returned in the JSON web token (JWT) from the\n identity provider.
\nYou can require users to set a source identity value when they assume a role. You do\n this by using the sts:SourceIdentity condition key in a role trust policy.\n That way, actions that are taken with the role are associated with that user. After the\n source identity is set, the value cannot be changed. It is present in the request for all\n actions that are taken by the role and persists across chained role\n sessions. You can configure your identity provider to use an attribute associated with your\n users, like user name or email, as the source identity when calling\n AssumeRoleWithWebIdentity. You do this by adding a claim to the JSON web\n token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide.\n For more information about using source identity, see Monitor and control\n actions taken with assumed roles in the\n IAM User Guide.
The regex used to validate this parameter is a string of characters \n consisting of upper- and lower-case alphanumeric characters with no spaces. You can \n also include underscores or any of the following characters: =,.@-
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the response to a successful AssumeRoleWithWebIdentity\n request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sts#AssumeRoot": { + "type": "operation", + "input": { + "target": "com.amazonaws.sts#AssumeRootRequest" + }, + "output": { + "target": "com.amazonaws.sts#AssumeRootResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sts#ExpiredTokenException" + }, + { + "target": "com.amazonaws.sts#RegionDisabledException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a set of short term credentials you can use to perform privileged tasks on a\n member account in your organization. You must use credentials from an Organizations management\n account or a delegated administrator account for IAM to call AssumeRoot. You\n cannot use root user credentials to make this call.
Before you can launch a privileged session, you must have centralized root access in\n your organization. For steps to enable this feature, see Centralize root access for\n member accounts in the IAM User Guide.
\nThe STS global endpoint is not supported for AssumeRoot. You must send this request\n to a Regional STS endpoint. For more information, see Endpoints.
\nYou can track AssumeRoot in CloudTrail logs to determine what actions were performed in a\n session. For more information, see Track privileged tasks\n in CloudTrail in the IAM User Guide.
\nWhen granting access to privileged tasks you should only grant the necessary permissions\n required to perform that task. For more information, see Security best practices in\n IAM. In addition, you can use service control\n policies (SCPs) to manage and limit permissions in your organization. See General examples in the Organizations User\n Guide for more information on SCPs.
", + "smithy.api#examples": [ + { + "title": "To launch a privileged session", + "documentation": "The following command retrieves a set of short-term credentials you can use to unlock an S3 bucket for a member account by removing the bucket policy.", + "input": { + "TargetPrincipal": "111122223333", + "TaskPolicyArn": { + "arn": "arn:aws:iam::aws:policy/root-task/S3UnlockBucketPolicy" + }, + "DurationSeconds": 900 + }, + "output": { + "Credentials": { + "SecretAccessKey": "9drTJvcXLB89EXAMPLELB8923FB892xMFI", + "SessionToken": "AQoXdzELDDY//////////wEaoAK1wvxJY12r2IrDFT2IvAzTCn3zHoZ7YNtpiQLF0MqZye/qwjzP2iEXAMPLEbw/m3hsj8VBTkPORGvr9jM5sgP+w9IZWZnU+LWhmg+a5fDi2oTGUYcdg9uexQ4mtCHIHfi4citgqZTgco40Yqr4lIlo4V2b2Dyauk0eYFNebHtYlFVgAUj+7Indz3LU0aTWk1WKIjHmmMCIoTkyYp/k7kUG7moeEYKSitwQIi6Gjn+nyzM+PtoA3685ixzv0R7i5rjQi0YE0lf1oeie3bDiNHncmzosRM6SFiPzSvp6h/32xQuZsjcypmwsPSDtTPYcs0+YN/8BRi2/IcrxSpnWEXAMPLEXSDFTAQAM6Dl9zR0tXoybnlrZIwMLlMi1Kcgo5OytwU=", + "Expiration": "2024-11-15T00:05:07Z", + "AccessKeyId": "ASIAJEXAMPLEXEG2JICEA" + }, + "SourceIdentity": "Alice" + } + } + ] + } + }, + "com.amazonaws.sts#AssumeRootRequest": { + "type": "structure", + "members": { + "TargetPrincipal": { + "target": "com.amazonaws.sts#TargetPrincipalType", + "traits": { + "smithy.api#documentation": "The member account principal ARN or account ID.
", + "smithy.api#required": {} + } + }, + "TaskPolicyArn": { + "target": "com.amazonaws.sts#PolicyDescriptorType", + "traits": { + "smithy.api#documentation": "The identity based policy that scopes the session to the privileged tasks that can be\n performed. You must\n \n use one of following Amazon Web Services managed policies to scope root session\n actions:
\n\n S3UnlockBucketPolicy\n
\n\n SQSUnlockQueuePolicy\n
\nThe duration, in seconds, of the privileged session. The value can range from 0 seconds\n up to the maximum session duration of 900 seconds (15 minutes). If you specify a value\n higher than this setting, the operation fails.
\nBy default, the value is set to 900 seconds.
The temporary security credentials, which include an access key ID, a secret access key,\n and a security token.
\nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nThe source identity specified by the principal that is calling the\n AssumeRoot operation.
You can use the aws:SourceIdentity condition key to control access based on\n the value of source identity. For more information about using source identity, see Monitor and control\n actions taken with assumed roles in the\n IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper-\n and lower-case alphanumeric characters with no spaces. You can also include underscores or\n any of the following characters: =,.@-
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sts#AssumedRoleUser": { + "type": "structure", + "members": { + "AssumedRoleId": { + "target": "com.amazonaws.sts#assumedRoleIdType", + "traits": { + "smithy.api#documentation": "A unique identifier that contains the role ID and the role session name of the role that\n is being assumed. The role ID is generated by Amazon Web Services when the role is created.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.sts#arnType", + "traits": { + "smithy.api#documentation": "The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in\n policies, see IAM Identifiers in the\n IAM User Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The identifiers for the temporary security credentials that the operation\n returns.
" + } + }, + "com.amazonaws.sts#Audience": { + "type": "string" + }, + "com.amazonaws.sts#Credentials": { + "type": "structure", + "members": { + "AccessKeyId": { + "target": "com.amazonaws.sts#accessKeyIdType", + "traits": { + "smithy.api#documentation": "The access key ID that identifies the temporary security credentials.
", + "smithy.api#required": {} + } + }, + "SecretAccessKey": { + "target": "com.amazonaws.sts#accessKeySecretType", + "traits": { + "smithy.api#documentation": "The secret access key that can be used to sign requests.
", + "smithy.api#required": {} + } + }, + "SessionToken": { + "target": "com.amazonaws.sts#tokenType", + "traits": { + "smithy.api#documentation": "The token that users must pass to the service API to use the temporary\n credentials.
", + "smithy.api#required": {} + } + }, + "Expiration": { + "target": "com.amazonaws.sts#dateType", + "traits": { + "smithy.api#documentation": "The date on which the current credentials expire.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Amazon Web Services credentials for API authentication.
" + } + }, + "com.amazonaws.sts#DecodeAuthorizationMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sts#DecodeAuthorizationMessageRequest" + }, + "output": { + "target": "com.amazonaws.sts#DecodeAuthorizationMessageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sts#InvalidAuthorizationMessageException" + } + ], + "traits": { + "smithy.api#documentation": "Decodes additional information about the authorization status of a request from an\n encoded message returned in response to an Amazon Web Services request.
\nFor example, if a user is not authorized to perform an operation that he or she has\n requested, the request returns a Client.UnauthorizedOperation response (an\n HTTP 403 response). Some Amazon Web Services operations additionally return an encoded message that can\n provide details about this authorization failure.
Only certain Amazon Web Services operations return an encoded authorization message. The\n documentation for an individual operation indicates whether that operation returns an\n encoded message in addition to returning an HTTP code.
\nThe message is encoded because the details of the authorization status can contain\n privileged information that the user who requested the operation should not see. To decode\n an authorization status message, a user must be granted permissions through an IAM policy to\n request the DecodeAuthorizationMessage\n (sts:DecodeAuthorizationMessage) action.
The decoded message includes the following type of information:
\nWhether the request was denied due to an explicit deny or due to the absence of an\n explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the\n IAM User Guide.
\nThe principal who made the request.
\nThe requested action.
\nThe requested resource.
\nThe values of condition keys in the context of the user's request.
\nThe encoded message that was returned with the response.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sts#DecodeAuthorizationMessageResponse": { + "type": "structure", + "members": { + "DecodedMessage": { + "target": "com.amazonaws.sts#decodedMessageType", + "traits": { + "smithy.api#documentation": "The API returns a response with the decoded message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A document that contains additional information about the authorization status of a\n request from an encoded message that is returned in response to an Amazon Web Services request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sts#ExpiredTokenException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sts#expiredIdentityTokenMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ExpiredTokenException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The web identity token that was passed is expired or is not valid. Get a new identity\n token from the identity provider and then retry the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sts#ExpiredTradeInTokenException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sts#expiredTradeInTokenExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ExpiredTradeInTokenException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The trade-in token provided in the request has expired and can no longer be exchanged\n for credentials. Request a new token and retry the operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sts#FederatedUser": { + "type": "structure", + "members": { + "FederatedUserId": { + "target": "com.amazonaws.sts#federatedIdType", + "traits": { + "smithy.api#documentation": "The string that identifies the federated user associated with the credentials, similar\n to the unique ID of an IAM user.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.sts#arnType", + "traits": { + "smithy.api#documentation": "The ARN that specifies the federated user that is associated with the credentials. For\n more information about ARNs and how to use them in policies, see IAM\n Identifiers in the IAM User Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Identifiers for the federated user that is associated with the credentials.
" + } + }, + "com.amazonaws.sts#GetAccessKeyInfo": { + "type": "operation", + "input": { + "target": "com.amazonaws.sts#GetAccessKeyInfoRequest" + }, + "output": { + "target": "com.amazonaws.sts#GetAccessKeyInfoResponse" + }, + "traits": { + "smithy.api#documentation": "Returns the account identifier for the specified access key ID.
\nAccess keys consist of two parts: an access key ID (for example,\n AKIAIOSFODNN7EXAMPLE) and a secret access key (for example,\n wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For more information about\n access keys, see Managing Access Keys for IAM\n Users in the IAM User Guide.
When you pass an access key ID to this operation, it returns the ID of the Amazon Web Services account\n to which the keys belong. Access key IDs beginning with AKIA are long-term\n credentials for an IAM user or the Amazon Web Services account root user. Access key IDs\n beginning with ASIA are temporary credentials that are created using STS\n operations. If the account in the response belongs to you, you can sign in as the root user and review your root user access keys. Then, you can pull a credentials\n report to learn which IAM user owns the keys. To learn who\n requested the temporary credentials for an ASIA access key, view the STS\n events in your CloudTrail logs in the IAM User Guide.
This operation does not indicate the state of the access key. The key might be active,\n inactive, or deleted. Active keys might not have permissions to perform an operation.\n Providing a deleted access key might return an error that the key doesn't exist.
" + } + }, + "com.amazonaws.sts#GetAccessKeyInfoRequest": { + "type": "structure", + "members": { + "AccessKeyId": { + "target": "com.amazonaws.sts#accessKeyIdType", + "traits": { + "smithy.api#documentation": "The identifier of an access key.
\nThis parameter allows (through its regex pattern) a string of characters that can\n consist of any upper- or lowercase letter or digit.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sts#GetAccessKeyInfoResponse": { + "type": "structure", + "members": { + "Account": { + "target": "com.amazonaws.sts#accountType", + "traits": { + "smithy.api#documentation": "The number used to identify the Amazon Web Services account.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sts#GetCallerIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.sts#GetCallerIdentityRequest" + }, + "output": { + "target": "com.amazonaws.sts#GetCallerIdentityResponse" + }, + "traits": { + "smithy.api#documentation": "Returns details about the IAM user or role whose credentials are used to\n call the operation.
\nNo permissions are required to perform this operation. If an administrator attaches a\n policy to your identity that explicitly denies access to the\n sts:GetCallerIdentity action, you can still perform this operation.\n Permissions are not required because the same information is returned when access is\n denied. To view an example response, see I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the\n IAM User Guide.
The unique identifier of the calling entity. The exact value depends on the type of\n entity that is making the call. The values returned are those listed in the aws:userid column in the Principal\n table found on the Policy Variables reference\n page in the IAM User Guide.
" + } + }, + "Account": { + "target": "com.amazonaws.sts#accountType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID number of the account that owns or contains the calling\n entity.
" + } + }, + "Arn": { + "target": "com.amazonaws.sts#arnType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services ARN associated with the calling entity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the response to a successful GetCallerIdentity request,\n including information about the entity making the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sts#GetDelegatedAccessToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.sts#GetDelegatedAccessTokenRequest" + }, + "output": { + "target": "com.amazonaws.sts#GetDelegatedAccessTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sts#ExpiredTradeInTokenException" + }, + { + "target": "com.amazonaws.sts#PackedPolicyTooLargeException" + }, + { + "target": "com.amazonaws.sts#RegionDisabledException" + } + ], + "traits": { + "smithy.api#documentation": "Exchanges a trade-in token for temporary Amazon Web Services credentials with the permissions\n associated with the assumed principal. This operation allows you to obtain credentials for\n a specific principal based on a trade-in token, enabling delegation of access to Amazon Web Services\n resources.
" + } + }, + "com.amazonaws.sts#GetDelegatedAccessTokenRequest": { + "type": "structure", + "members": { + "TradeInToken": { + "target": "com.amazonaws.sts#tradeInTokenType", + "traits": { + "smithy.api#documentation": "The token to exchange for temporary Amazon Web Services credentials. This token must be valid and\n unexpired at the time of the request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sts#GetDelegatedAccessTokenResponse": { + "type": "structure", + "members": { + "Credentials": { + "target": "com.amazonaws.sts#Credentials" + }, + "PackedPolicySize": { + "target": "com.amazonaws.sts#nonNegativeIntegerType", + "traits": { + "smithy.api#documentation": "The percentage of the maximum policy size that is used by the session policy. The policy\n size is calculated as the sum of all the session policies and permission boundaries\n attached to the session. If the packed size exceeds 100%, the request fails.
" + } + }, + "AssumedPrincipal": { + "target": "com.amazonaws.sts#arnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the principal that was assumed when obtaining the\n delegated access token. This ARN identifies the IAM entity whose permissions are granted\n by the temporary credentials.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sts#GetFederationToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.sts#GetFederationTokenRequest" + }, + "output": { + "target": "com.amazonaws.sts#GetFederationTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sts#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.sts#PackedPolicyTooLargeException" + }, + { + "target": "com.amazonaws.sts#RegionDisabledException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a set of temporary security credentials (consisting of an access key ID, a\n secret access key, and a security token) for a user. A typical use is in a proxy\n application that gets temporary security credentials on behalf of distributed applications\n inside a corporate network.
\nYou must call the GetFederationToken operation using the long-term security\n credentials of an IAM user. As a result, this call is appropriate in\n contexts where those credentials can be safeguarded, usually in a server-based application.\n For a comparison of GetFederationToken with the other API operations that\n produce temporary credentials, see Requesting Temporary Security\n Credentials and Compare STS\n credentials in the IAM User Guide.
Although it is possible to call GetFederationToken using the security\n credentials of an Amazon Web Services account root user rather than an IAM user that you\n create for the purpose of a proxy application, we do not recommend it. For more\n information, see Safeguard your root user credentials and don't use them for everyday tasks in the\n IAM User Guide.
You can create a mobile-based or browser-based app that can authenticate users using\n a web identity provider like Login with Amazon, Facebook, Google, or an OpenID\n Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or\n AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the\n IAM User Guide.
\n Session duration\n
\nThe temporary credentials are valid for the specified duration, from 900 seconds (15\n minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is\n 43,200 seconds (12 hours). Temporary credentials obtained by using the root user\n credentials have a maximum duration of 3,600 seconds (1 hour).
\n\n Permissions\n
\nYou can use the temporary credentials created by GetFederationToken in any\n Amazon Web Services service with the following exceptions:
You cannot call any IAM operations using the CLI or the Amazon Web Services API. This\n limitation does not apply to console sessions.
\nYou cannot call any STS operations except GetCallerIdentity.
You can use temporary credentials for single sign-on (SSO) to the console.
\nYou must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as\n managed session policies. The plaintext that you use for both inline and managed session\n policies can't exceed 2,048 characters.
\nThough the session policy parameters are optional, if you do not pass a policy, then the\n resulting federated user session has no permissions. When you pass session policies, the\n session permissions are the intersection of the IAM user policies and the\n session policies that you pass. This gives you a way to further restrict the permissions\n for a federated user. You cannot use session policies to grant more permissions than those\n that are defined in the permissions policy of the IAM user. For more\n information, see Session Policies in\n the IAM User Guide. For information about using\n GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.
You can use the credentials to access a resource that has a resource-based policy. If\n that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions granted by the\n session policies.
\n Tags\n
\n(Optional) You can pass tag key-value pairs to your session. These are called session\n tags. For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nYou can create a mobile-based or browser-based app that can authenticate users using\n a web identity provider like Login with Amazon, Facebook, Google, or an OpenID\n Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or\n AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the\n IAM User Guide.
An administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.
\nTag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the user that you are federating has the\n Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the user tag.
The name of the federated user. The name is used as an identifier for the temporary\n security credentials (such as Bob). For example, you can reference the\n federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.
The regex used to validate this parameter is a string of characters \n consisting of upper- and lower-case alphanumeric characters with no spaces. You can \n also include underscores or any of the following characters: =,.@-
", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.sts#sessionPolicyDocumentType", + "traits": { + "smithy.api#documentation": "An IAM policy in JSON format that you want to use as an inline session policy.
\nYou must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as\n managed session policies.
\nThis parameter is optional. However, if you do not pass any session policies, then the\n resulting federated user session has no permissions.
\nWhen you pass session policies, the session permissions are the intersection of the\n IAM user policies and the session policies that you pass. This gives you\n a way to further restrict the permissions for a federated user. You cannot use session\n policies to grant more permissions than those that are defined in the permissions policy of\n the IAM user. For more information, see Session Policies in\n the IAM User Guide.
\nThe resulting credentials can be used to access a resource that has a resource-based\n policy. If that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions that are granted\n by the session policies.
The plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a\n managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.
\nYou must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as\n managed session policies. The plaintext that you use for both inline and managed session\n policies can't exceed 2,048 characters. You can provide up to 10 managed policy ARNs. For\n more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.
\nThis parameter is optional. However, if you do not pass any session policies, then the\n resulting federated user session has no permissions.
\nWhen you pass session policies, the session permissions are the intersection of the\n IAM user policies and the session policies that you pass. This gives you\n a way to further restrict the permissions for a federated user. You cannot use session\n policies to grant more permissions than those that are defined in the permissions policy of\n the IAM user. For more information, see Session Policies in\n the IAM User Guide.
\nThe resulting credentials can be used to access a resource that has a resource-based\n policy. If that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions that are granted\n by the session policies.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
The duration, in seconds, that the session should last. Acceptable durations for\n federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with\n 43,200 seconds (12 hours) as the default. Sessions obtained using root user\n credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified\n duration is longer than one hour, the session obtained by using root user\n credentials defaults to one hour.
" + } + }, + "Tags": { + "target": "com.amazonaws.sts#tagListType", + "traits": { + "smithy.api#documentation": "A list of session tags. Each session tag consists of a key name and an associated value.\n For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nThis parameter is optional. You can pass up to 50 session tags. The plaintext session\n tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is already attached to the\n user you are federating. When you do, session tags override a user tag with the same key.
\nTag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.
The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.
\nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nIdentifiers for the federated user associated with the credentials (such as\n arn:aws:sts::123456789012:federated-user/Bob or\n 123456789012:Bob). You can use the federated user's ARN in your\n resource-based policies, such as an Amazon S3 bucket policy.
A percentage value that indicates the packed size of the session policies and session \n tags combined passed in the request. The request fails if the packed size is greater than 100 percent, \n which means the policies and tags exceeded the allowed space.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the response to a successful GetFederationToken request,\n including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sts#GetSessionToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.sts#GetSessionTokenRequest" + }, + "output": { + "target": "com.amazonaws.sts#GetSessionTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sts#RegionDisabledException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a set of temporary credentials for an Amazon Web Services account or IAM user.\n The credentials consist of an access key ID, a secret access key, and a security token.\n Typically, you use GetSessionToken if you want to use MFA to protect\n programmatic calls to specific Amazon Web Services API operations like Amazon EC2\n StopInstances.
MFA-enabled IAM users must call GetSessionToken and submit\n an MFA code that is associated with their MFA device. Using the temporary security\n credentials that the call returns, IAM users can then make programmatic\n calls to API operations that require MFA authentication. An incorrect MFA code causes the\n API to return an access denied error. For a comparison of GetSessionToken with\n the other API operations that produce temporary credentials, see Requesting\n Temporary Security Credentials and Compare STS\n credentials in the IAM User Guide.
No permissions are required for users to perform this operation. The purpose of the\n sts:GetSessionToken operation is to authenticate the user using MFA. You\n cannot use policies to control authentication operations. For more information, see\n Permissions for GetSessionToken in the\n IAM User Guide.
\n Session Duration\n
\nThe GetSessionToken operation must be called by using the long-term Amazon Web Services\n security credentials of an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range\n from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default\n of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900\n seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.
\n Permissions\n
\nThe temporary security credentials created by GetSessionToken can be used\n to make API calls to any Amazon Web Services service with the following exceptions:
You cannot call any IAM API operations unless MFA authentication information is\n included in the request.
\nYou cannot call any STS API except\n AssumeRole or GetCallerIdentity.
The credentials that GetSessionToken returns are based on permissions\n associated with the IAM user whose credentials were used to call the\n operation. The temporary credentials have the same permissions as the IAM user.
Although it is possible to call GetSessionToken using the security\n credentials of an Amazon Web Services account root user rather than an IAM user, we do\n not recommend it. If GetSessionToken is called using root user\n credentials, the temporary credentials have root user permissions. For more\n information, see Safeguard your root user credentials and don't use them for everyday tasks in the\n IAM User Guide\n
For more information about using GetSessionToken to create temporary\n credentials, see Temporary\n Credentials for Users in Untrusted Environments in the\n IAM User Guide.
The duration, in seconds, that the credentials should remain valid. Acceptable durations\n for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds\n (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account\n owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer\n than one hour, the session for Amazon Web Services account owners defaults to one hour.
" + } + }, + "SerialNumber": { + "target": "com.amazonaws.sts#serialNumberType", + "traits": { + "smithy.api#documentation": "The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value\n if the IAM user has a policy that requires MFA authentication. The value is\n either the serial number for a hardware device (such as GAHT12345678) or an\n Amazon Resource Name (ARN) for a virtual device (such as\n arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the Amazon Web Services Management Console and viewing the user's security credentials.
The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: =,.@:/-
" + } + }, + "TokenCode": { + "target": "com.amazonaws.sts#tokenCodeType", + "traits": { + "smithy.api#documentation": "The value provided by the MFA device, if MFA is required. If any policy requires the\n IAM user to submit an MFA code, specify this value. If MFA authentication\n is required, the user must provide a code when requesting a set of temporary security\n credentials. A user who fails to provide the code receives an \"access denied\" response when\n requesting resources that require MFA authentication.
\nThe format for this parameter, as described by its regex pattern, is a sequence of six\n numeric digits.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sts#GetSessionTokenResponse": { + "type": "structure", + "members": { + "Credentials": { + "target": "com.amazonaws.sts#Credentials", + "traits": { + "smithy.api#documentation": "The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.
\nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nContains the response to a successful GetSessionToken request,\n including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sts#GetWebIdentityToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.sts#GetWebIdentityTokenRequest" + }, + "output": { + "target": "com.amazonaws.sts#GetWebIdentityTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sts#JWTPayloadSizeExceededException" + }, + { + "target": "com.amazonaws.sts#OutboundWebIdentityFederationDisabledException" + }, + { + "target": "com.amazonaws.sts#SessionDurationEscalationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a signed JSON Web Token (JWT) that represents the calling Amazon Web Services identity. \n The returned JWT can be used to authenticate with external services that support OIDC discovery. \n The token is signed by Amazon Web Services STS and can be publicly verified using the verification keys published at the issuer's JWKS endpoint.
" + } + }, + "com.amazonaws.sts#GetWebIdentityTokenRequest": { + "type": "structure", + "members": { + "Audience": { + "target": "com.amazonaws.sts#webIdentityTokenAudienceListType", + "traits": { + "smithy.api#documentation": "The intended recipient of the web identity token. This value populates the\n aud claim in the JWT and should identify the service or application that\n will validate and use the token. The external service should verify this claim to ensure the token was intended for their use.
The duration, in seconds, for which the JSON Web Token (JWT) will remain valid. \n The value can range from 60 seconds (1 minute) to 3600 seconds (1 hour). If not specified, \n the default duration is 300 seconds (5 minutes). The token is designed to be short-lived and \n should be used for proof of identity, then exchanged for credentials or short-lived tokens in the external service.
" + } + }, + "SigningAlgorithm": { + "target": "com.amazonaws.sts#jwtAlgorithmType", + "traits": { + "smithy.api#documentation": "The cryptographic algorithm to use for signing the JSON Web Token (JWT). Valid values are \n RS256 (RSA with SHA-256) and ES384 (ECDSA using P-384 curve with SHA-384).
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sts#tagListType", + "traits": { + "smithy.api#documentation": "An optional list of tags to include in the JSON Web Token (JWT). These tags are added as custom \n claims to the JWT and can be used by the downstream service for authorization decisions.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sts#GetWebIdentityTokenResponse": { + "type": "structure", + "members": { + "WebIdentityToken": { + "target": "com.amazonaws.sts#webIdentityTokenType", + "traits": { + "smithy.api#documentation": "A signed JSON Web Token (JWT) that represents the caller's Amazon Web Services identity. The token contains \n standard JWT claims such as subject, audience, expiration time, and additional identity attributes \n added by STS as custom claims. You can also add your own custom claims to the token by passing tags \n as request parameters to the GetWebIdentityToken API. The token is signed using the specified signing \n algorithm and can be verified using the verification keys available at the issuer's JWKS endpoint.
The date and time when the web identity token expires, in UTC. The expiration is\n determined by adding the DurationSeconds value to the time the token was\n issued. After this time, the token should no longer be considered valid.
The request could not be fulfilled because the identity provider (IDP) that was asked\n to verify the incoming identity token could not be reached. This is often a transient\n error caused by network conditions. Retry the request a limited number of times so that\n you don't exceed the request rate. If the error persists, the identity provider might be\n down or not responding.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sts#IDPRejectedClaimException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sts#idpRejectedClaimMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IDPRejectedClaim", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "The identity provider (IdP) reported that authentication failed. This might be because\n the claim is invalid.
\nIf this error is returned for the AssumeRoleWithWebIdentity operation, it\n can also mean that the claim has expired or has been explicitly revoked.
The error returned if the message passed to DecodeAuthorizationMessage\n was invalid. This can happen if the token contains invalid characters, such as line\n breaks, or if the message has expired.
The web identity token that was passed could not be validated by Amazon Web Services. Get a new\n identity token from the identity provider and then retry the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sts#Issuer": { + "type": "string" + }, + "com.amazonaws.sts#JWTPayloadSizeExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sts#JWTPayloadSizeExceededException2" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "JWTPayloadSizeExceededException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The requested token payload size exceeds the maximum allowed size. Reduce the number of request tags included in the GetWebIdentityToken API call to reduce the token payload size.
The request was rejected because the policy document was malformed. The error message\n describes the specific error.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sts#NameQualifier": { + "type": "string" + }, + "com.amazonaws.sts#OutboundWebIdentityFederationDisabledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sts#OutboundWebIdentityFederationDisabledException2" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OutboundWebIdentityFederationDisabledException", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "The outbound web identity federation feature is not enabled for this account. To use\n this feature, you must first enable it through the Amazon Web Services Management Console or API.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sts#OutboundWebIdentityFederationDisabledException2": { + "type": "string" + }, + "com.amazonaws.sts#PackedPolicyTooLargeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sts#packedPolicyTooLargeMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "PackedPolicyTooLarge", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The request was rejected because the total packed size of the session policies and\n session tags combined was too large. An Amazon Web Services conversion compresses the session policy\n document, session policy ARNs, and session tags into a packed binary format that has a\n separate limit. The error message indicates by percentage how close the policies and\n tags are to the upper size limit. For more information, see Passing Session Tags in STS in\n the IAM User Guide.
\nYou could receive this error even though you meet other defined session policy and\n session tag limits. For more information, see IAM and STS Entity Character Limits in the IAM User\n Guide.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sts#PolicyDescriptorType": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.sts#arnType", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM managed policy to use as a session policy\n for the role. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A reference to the IAM managed policy that is passed as a session policy for a role\n session or a federated user session.
" + } + }, + "com.amazonaws.sts#ProvidedContext": { + "type": "structure", + "members": { + "ProviderArn": { + "target": "com.amazonaws.sts#arnType", + "traits": { + "smithy.api#documentation": "The context provider ARN from which the trusted context assertion was generated.
" + } + }, + "ContextAssertion": { + "target": "com.amazonaws.sts#contextAssertionType", + "traits": { + "smithy.api#documentation": "The signed and encrypted trusted context assertion generated by the context provider.\n The trusted context assertion is signed and encrypted by Amazon Web Services STS.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the provided context. This includes the signed and encrypted\n trusted context assertion and the context provider ARN from which the trusted context\n assertion was generated.
" + } + }, + "com.amazonaws.sts#ProvidedContextsListType": { + "type": "list", + "member": { + "target": "com.amazonaws.sts#ProvidedContext" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sts#RegionDisabledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sts#regionDisabledMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "RegionDisabledException", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "STS is not activated in the requested region for the account that is being asked to\n generate credentials. The account administrator must use the IAM console to activate\n STS in that region. For more information, see Activating and Deactivating STS in an Amazon Web Services Region in the IAM\n User Guide.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sts#RootDurationSecondsType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 900 + } + } + }, + "com.amazonaws.sts#SAMLAssertionType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 100000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sts#SessionDurationEscalationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sts#SessionDurationEscalationException2" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SessionDurationEscalationException", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "The requested token duration would extend the session beyond its original expiration time. \n You cannot use this operation to extend the lifetime of a session beyond what was granted when the session was originally created.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sts#SessionDurationEscalationException2": { + "type": "string" + }, + "com.amazonaws.sts#Subject": { + "type": "string" + }, + "com.amazonaws.sts#SubjectType": { + "type": "string" + }, + "com.amazonaws.sts#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sts#tagKeyType", + "traits": { + "smithy.api#documentation": "The key for a session tag.
\nYou can pass up to 50 session tags. The plain text session tag keys can’t exceed 128\n characters. For these and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sts#tagValueType", + "traits": { + "smithy.api#documentation": "The value for a session tag.
\nYou can pass up to 50 session tags. The plain text session tag values can’t exceed 256\n characters. For these and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You can pass custom key-value pair attributes when you assume a role or federate a user.\n These are called session tags. You can then use the session tags to control access to\n resources. For more information, see Tagging Amazon Web Services STS Sessions in the\n IAM User Guide.
" + } + }, + "com.amazonaws.sts#TargetPrincipalType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 2048 + } + } + }, + "com.amazonaws.sts#accessKeyIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 128 + }, + "smithy.api#pattern": "^[\\w]*$" + } + }, + "com.amazonaws.sts#accessKeySecretType": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sts#accountType": { + "type": "string" + }, + "com.amazonaws.sts#arnType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]+$" + } + }, + "com.amazonaws.sts#assumedRoleIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 193 + }, + "smithy.api#pattern": "^[\\w+=,.@:-]*$" + } + }, + "com.amazonaws.sts#clientTokenType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 20000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sts#contextAssertionType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 2048 + } + } + }, + "com.amazonaws.sts#dateType": { + "type": "timestamp" + }, + "com.amazonaws.sts#decodedMessageType": { + "type": "string" + }, + "com.amazonaws.sts#durationSecondsType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 900, + "max": 129600 + } + } + }, + "com.amazonaws.sts#encodedMessageType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10240 + } + } + }, + "com.amazonaws.sts#expiredIdentityTokenMessage": { + "type": "string" + }, + "com.amazonaws.sts#expiredTradeInTokenExceptionMessage": { + "type": "string" + }, + "com.amazonaws.sts#externalIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 1224 + }, + "smithy.api#pattern": "^[\\w+=,.@:\\/-]*$" + } + }, + "com.amazonaws.sts#federatedIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 193 + }, + "smithy.api#pattern": "^[\\w+=,.@\\:-]*$" + } + }, + "com.amazonaws.sts#idpCommunicationErrorMessage": { + "type": "string" + }, + "com.amazonaws.sts#idpRejectedClaimMessage": { + "type": "string" + }, + "com.amazonaws.sts#invalidAuthorizationMessage": { + "type": "string" + }, + "com.amazonaws.sts#invalidIdentityTokenMessage": { + "type": "string" + }, + "com.amazonaws.sts#jwtAlgorithmType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 5 + } + } + }, + "com.amazonaws.sts#malformedPolicyDocumentMessage": { + "type": "string" + }, + "com.amazonaws.sts#nonNegativeIntegerType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sts#packedPolicyTooLargeMessage": { + "type": "string" + }, + "com.amazonaws.sts#policyDescriptorListType": { + "type": "list", + "member": { + "target": "com.amazonaws.sts#PolicyDescriptorType" + } + }, + "com.amazonaws.sts#regionDisabledMessage": { + "type": "string" + }, + "com.amazonaws.sts#roleDurationSecondsType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 900, + "max": 43200 + } + } + }, + "com.amazonaws.sts#roleSessionNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#pattern": "^[\\w+=,.@-]*$" + } + }, + "com.amazonaws.sts#serialNumberType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 256 + }, + "smithy.api#pattern": "^[\\w+=/:,.@-]*$" + } + }, + "com.amazonaws.sts#sessionPolicyDocumentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.sts#sourceIdentityType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#pattern": "^[\\w+=,.@-]*$" + } + }, + "com.amazonaws.sts#tagKeyListType": { + "type": "list", + "member": { + "target": "com.amazonaws.sts#tagKeyType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sts#tagKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+$" + } + }, + "com.amazonaws.sts#tagListType": { + "type": "list", + "member": { + "target": "com.amazonaws.sts#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.sts#tagValueType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" + } + }, + "com.amazonaws.sts#tokenCodeType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 6, + "max": 6 + }, + "smithy.api#pattern": "^[\\d]*$" + } + }, + "com.amazonaws.sts#tokenType": { + "type": "string" + }, + "com.amazonaws.sts#tradeInTokenType": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sts#unrestrictedSessionPolicyDocumentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.sts#urlType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 2048 + } + } + }, + "com.amazonaws.sts#userIdType": { + "type": "string" + }, + "com.amazonaws.sts#userNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 32 + }, + "smithy.api#pattern": "^[\\w+=,.@-]*$" + } + }, + "com.amazonaws.sts#webIdentitySubjectType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 6, + "max": 255 + } + } + }, + "com.amazonaws.sts#webIdentityTokenAudienceListType": { + "type": "list", + "member": { + "target": "com.amazonaws.sts#webIdentityTokenAudienceStringType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sts#webIdentityTokenAudienceStringType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.sts#webIdentityTokenDurationSecondsType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.sts#webIdentityTokenType": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + } + } +} diff --git a/codegen/aws-models/transcribe-streaming.json b/codegen/aws-models/transcribe-streaming.json index efcfa6d..9be357d 100644 --- a/codegen/aws-models/transcribe-streaming.json +++ b/codegen/aws-models/transcribe-streaming.json @@ -1513,7 +1513,7 @@ } }, "traits": { - "smithy.api#documentation": "Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length\n limit. Break your audio stream into smaller chunks and try your request again.
", + "smithy.api#documentation": "Your client has exceeded one of the Amazon Transcribe limits, typically the concurrent stream\n service quota. This error can also occur if a stream exceeds the maximum session duration. In rare\n cases, this error can also occur if you increase your number of concurrent streams too quickly.\n Reduce your number of concurrent streams and try your request again using an exponential backoff\n strategy.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -1550,6 +1550,24 @@ "traits": { "smithy.api#enumValue": "flac" } + }, + "G711_ALAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g711-alaw" + } + }, + "G711_ULAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g711-ulaw" + } + }, + "G729": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g729" + } } } }, @@ -3738,6 +3756,13 @@ "smithy.api#documentation": "Specify the time window, in minutes, during which your transcription session can be resumed,\n measured from the stream start time. This optional parameter accepts integer values from 1 to 300 (5 hours).
\n For example, if your stream starts at 1 PM and you specify a SessionResumeWindow of 30 minutes,\n you can reconnect to the session as many times as you want until 1:30 PM.
Specify how numbers, dates, and other alphanumeric entities are rendered in your\n transcription results.
\n\n WRITTEN renders these entities in their standard written form\n (for example, $50, 10:30 AM, and 101).
\n SPOKEN renders these entities as words, exactly as they were\n spoken (for example, fifty dollars, ten thirty a m, and\n one oh one).
If you don't specify a value, Amazon Transcribe uses WRITTEN by default.
Provides the session resume window, in minutes, that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-session-resume-window" } + }, + "TranscriptFormat": { + "target": "com.amazonaws.transcribestreaming#TranscriptFormat", + "traits": { + "smithy.api#documentation": "Provides the transcript format that you specified in your request.
", + "smithy.api#httpHeader": "x-amzn-transcribe-transcript-format" + } } }, "traits": { @@ -4967,6 +4999,23 @@ "smithy.api#documentation": "The TranscriptEvent associated with a \n TranscriptResultStream.
Contains a set of transcription results from one or more audio segments, along with additional \n information per your request parameters.
" } }, + "com.amazonaws.transcribestreaming#TranscriptFormat": { + "type": "enum", + "members": { + "SPOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spoken" + } + }, + "WRITTEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "written" + } + } + } + }, "com.amazonaws.transcribestreaming#TranscriptResultStream": { "type": "union", "members": { @@ -4985,7 +5034,7 @@ "LimitExceededException": { "target": "com.amazonaws.transcribestreaming#LimitExceededException", "traits": { - "smithy.api#documentation": "Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length\n limit. Break your audio stream into smaller chunks and try your request again.
" + "smithy.api#documentation": "Your client has exceeded one of the Amazon Transcribe limits, typically the concurrent stream\n service quota. This error can also occur if a stream exceeds the maximum session duration. In rare\n cases, this error can also occur if you increase your number of concurrent streams too quickly.\n Reduce your number of concurrent streams and try your request again using an exponential backoff\n strategy.
" } }, "InternalFailureException": {