From 311665aa21a736059ab120e1a3e1e7c255403eb9 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Tue, 23 Apr 2024 18:11:20 +0000 Subject: [PATCH] Update API model --- .../aws-models/bedrock-agent-runtime.json | 190 + .../sdk-codegen/aws-models/bedrock-agent.json | 69 + .../aws-models/bedrock-runtime.json | 121 +- codegen/sdk-codegen/aws-models/bedrock.json | 4603 ++++++++++++++--- .../sdk-codegen/aws-models/cost-explorer.json | 22 +- codegen/sdk-codegen/aws-models/ec2.json | 204 +- codegen/sdk-codegen/aws-models/pi.json | 50 +- codegen/sdk-codegen/aws-models/rds.json | 2 +- .../aws-models/workspaces-web.json | 228 +- 9 files changed, 4579 insertions(+), 910 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json index dbda49dc0fc..f31a18b8655 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json @@ -993,6 +993,45 @@ "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}))$" } }, + "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#Citation": { "type": "structure", "members": { @@ -1055,6 +1094,12 @@ "target": "com.amazonaws.bedrockagentruntime#Parameters" } }, + "com.amazonaws.bedrockagentruntime#ContentType": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-z]{1,20}/.{1,20}" + } + }, "com.amazonaws.bedrockagentruntime#CreationMode": { "type": "enum", "members": { @@ -1091,6 +1136,104 @@ "smithy.api#httpError": 424 } }, + "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.

" + } + } + }, + "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 modelArn used with the external source wrapper object in the retrieveAndGenerate function.

", + "smithy.api#required": {} + } + }, + "sources": { + "target": "com.amazonaws.bedrockagentruntime#ExternalSources", + "traits": { + "smithy.api#documentation": "

The document used with the external source wrapper object in the retrieveAndGenerate function.

", + "smithy.api#required": {} + } + }, + "generationConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ExternalSourcesGenerationConfiguration", + "traits": { + "smithy.api#documentation": "

The prompt used with the external source wrapper object with the retrieveAndGenerate function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configurations of the external source wrapper object in the retrieveAndGenerate function.

" + } + }, "com.amazonaws.bedrockagentruntime#FailureReasonString": { "type": "string", "traits": { @@ -1298,6 +1441,16 @@ "smithy.api#documentation": "

Contains configurations for response generation based on the knowledge base query results.

\n

This data type is used in the following API operations:

\n " } }, + "com.amazonaws.bedrockagentruntime#Identifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#InferenceConfiguration": { "type": "structure", "members": { @@ -2707,6 +2860,12 @@ "traits": { "smithy.api#documentation": "

Contains details about the resource being queried.

" } + }, + "externalSourcesConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ExternalSourcesRetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration used with the external source wrapper object in the retrieveAndGenerate function.

" + } } }, "traits": { @@ -2840,6 +2999,12 @@ "traits": { "smithy.api#enumValue": "KNOWLEDGE_BASE" } + }, + "EXTERNAL_SOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL_SOURCES" + } } } }, @@ -2972,6 +3137,31 @@ "smithy.api#sensitive": {} } }, + "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#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#SearchType": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent.json b/codegen/sdk-codegen/aws-models/bedrock-agent.json index 8acc8289a0c..bb6a96d59e6 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent.json @@ -1933,6 +1933,16 @@ "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}))$" } }, + "com.amazonaws.bedrockagent#BucketOwnerAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, "com.amazonaws.bedrockagent#ChunkingConfiguration": { "type": "structure", "members": { @@ -2451,6 +2461,12 @@ "smithy.api#required": {} } }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "

The deletion policy for the requested data source

" + } + }, "serverSideEncryptionConfiguration": { "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", "traits": { @@ -2622,6 +2638,23 @@ } } }, + "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": { @@ -2678,6 +2711,12 @@ "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 deletion policy for the data source.

" + } + }, "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { @@ -2691,6 +2730,12 @@ "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 details of the failure reasons related to the data source.

" + } } }, "traits": { @@ -2752,6 +2797,12 @@ "traits": { "smithy.api#enumValue": "DELETING" } + }, + "DELETE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" + } } } }, @@ -4847,6 +4898,12 @@ "traits": { "smithy.api#enumValue": "FAILED" } + }, + "DELETE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" + } } } }, @@ -6499,6 +6556,12 @@ "traits": { "smithy.api#documentation": "

A list of S3 prefixes that define the object containing the data sources. 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": { @@ -7578,6 +7641,12 @@ "smithy.api#required": {} } }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "

The data deletion policy of the updated data source.

" + } + }, "serverSideEncryptionConfiguration": { "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", "traits": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-runtime.json index c3f00c8025e..e19538049ae 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-runtime.json +++ b/codegen/sdk-codegen/aws-models/bedrock-runtime.json @@ -32,7 +32,7 @@ "name": "bedrock" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Describes the API operations for running inference using Bedrock models.

", + "smithy.api#documentation": "

Describes the API operations for running inference using Amazon Bedrock models.

", "smithy.api#title": "Amazon Bedrock Runtime", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -709,6 +709,21 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockruntime#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.bedrockruntime#GuardrailVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" + } + }, "com.amazonaws.bedrockruntime#InferenceResource": { "type": "resource", "operations": [ @@ -771,7 +786,7 @@ } ], "traits": { - "smithy.api#documentation": "

Invokes the specified Bedrock model to run inference using the input provided in the request body. \n You use InvokeModel to run inference for text models, image models, and embedding models.

\n

For more information, see Run inference in the Bedrock User Guide.

\n

For example requests, see Examples (after the Errors section).

", + "smithy.api#documentation": "

Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. \n You use model inference to generate text, images, and embeddings.

\n

For example code, see Invoke model code examples in the Amazon Bedrock User Guide.\n

\n

This operation requires permission for the bedrock:InvokeModel action.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -795,7 +810,7 @@ "body": { "target": "com.amazonaws.bedrockruntime#Body", "traits": { - "smithy.api#documentation": "

Input data in the format specified in the content-type request header. To see the format and content of this field for different models, refer to Inference parameters.

", + "smithy.api#documentation": "

The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -810,17 +825,38 @@ "accept": { "target": "com.amazonaws.bedrockruntime#MimeType", "traits": { - "smithy.api#documentation": "

The desired MIME type of the inference body in the response. The default value is\n application/json.

", + "smithy.api#documentation": "

The desired MIME type of the inference body in the response. The default value is application/json.

", "smithy.api#httpHeader": "Accept" } }, "modelId": { "target": "com.amazonaws.bedrockruntime#InvokeModelIdentifier", "traits": { - "smithy.api#documentation": "

Identifier of the model.

", + "smithy.api#documentation": "

The unique identifier of the model to invoke to run inference.

\n

The modelId to provide depends on the type of model that you use:

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "trace": { + "target": "com.amazonaws.bedrockruntime#Trace", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

", + "smithy.api#httpHeader": "X-Amzn-Bedrock-Trace" + } + }, + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockruntime#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied\n to the invocation.

\n

An error will be thrown in the following situations.

\n ", + "smithy.api#httpHeader": "X-Amzn-Bedrock-GuardrailIdentifier" + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrockruntime#GuardrailVersion", + "traits": { + "smithy.api#documentation": "

The version number for the guardrail. The value can also be DRAFT.

", + "smithy.api#httpHeader": "X-Amzn-Bedrock-GuardrailVersion" + } } }, "traits": { @@ -833,7 +869,7 @@ "body": { "target": "com.amazonaws.bedrockruntime#Body", "traits": { - "smithy.api#documentation": "

Inference response from the model in the format specified in the content-type header field. To see the format and content of this field for different models, refer to Inference parameters.

", + "smithy.api#documentation": "

Inference response from the model in the format specified in the contentType header. To see the format and content of the request and response bodies for different models, refer to Inference parameters.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -892,7 +928,7 @@ } ], "traits": { - "smithy.api#documentation": "

Invoke the specified Bedrock model to run inference using the input provided.\n Return the response in a stream.

\n

For more information, see Run inference in the Bedrock User Guide.

\n

For an example request and response, see Examples (after the Errors section).

", + "smithy.api#documentation": "

Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.

\n

To see if a model supports streaming, call GetFoundationModel\n and check the responseStreamingSupported field in the response.

\n \n

The CLI doesn't support InvokeModelWithResponseStream.

\n \n

For example code, see Invoke model with streaming code\n example in the Amazon Bedrock User Guide.\n

\n

This operation requires permissions to perform the bedrock:InvokeModelWithResponseStream action.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -906,7 +942,7 @@ "body": { "target": "com.amazonaws.bedrockruntime#Body", "traits": { - "smithy.api#documentation": "

Inference input in the format specified by the \n content-type. To see the format and content of this field for different models, refer to Inference parameters.

", + "smithy.api#documentation": "

The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -928,10 +964,31 @@ "modelId": { "target": "com.amazonaws.bedrockruntime#InvokeModelIdentifier", "traits": { - "smithy.api#documentation": "

Id of the model to invoke using the streaming request.

", + "smithy.api#documentation": "

The unique identifier of the model to invoke to run inference.

\n

The modelId to provide depends on the type of model that you use:

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "trace": { + "target": "com.amazonaws.bedrockruntime#Trace", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

", + "smithy.api#httpHeader": "X-Amzn-Bedrock-Trace" + } + }, + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockruntime#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied\n to the invocation.

\n

An error is thrown in the following situations.

\n ", + "smithy.api#httpHeader": "X-Amzn-Bedrock-GuardrailIdentifier" + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrockruntime#GuardrailVersion", + "traits": { + "smithy.api#documentation": "

The version number for the guardrail. The value can also be DRAFT.

", + "smithy.api#httpHeader": "X-Amzn-Bedrock-GuardrailVersion" + } } }, "traits": { @@ -944,7 +1001,7 @@ "body": { "target": "com.amazonaws.bedrockruntime#ResponseStream", "traits": { - "smithy.api#documentation": "

Inference response from the model in the format specified by Content-Type. To see the format and content of this field for different models, refer to Inference parameters.

", + "smithy.api#documentation": "

Inference response from the model in the format specified by the contentType header. To see the format and content of this field for different models, refer to Inference parameters.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -1023,7 +1080,7 @@ } }, "traits": { - "smithy.api#documentation": "

An error occurred while streaming the response.

", + "smithy.api#documentation": "

An error occurred while streaming the response. Retry your request.

", "smithy.api#error": "client", "smithy.api#httpError": 424 } @@ -1094,19 +1151,34 @@ } }, "internalServerException": { - "target": "com.amazonaws.bedrockruntime#InternalServerException" + "target": "com.amazonaws.bedrockruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "

An internal server error occurred. Retry your request.

" + } }, "modelStreamErrorException": { - "target": "com.amazonaws.bedrockruntime#ModelStreamErrorException" + "target": "com.amazonaws.bedrockruntime#ModelStreamErrorException", + "traits": { + "smithy.api#documentation": "

An error occurred while streaming the response. Retry your request.

" + } }, "validationException": { - "target": "com.amazonaws.bedrockruntime#ValidationException" + "target": "com.amazonaws.bedrockruntime#ValidationException", + "traits": { + "smithy.api#documentation": "

Input validation failed. Check your request parameters and retry the request.

" + } }, "throttlingException": { - "target": "com.amazonaws.bedrockruntime#ThrottlingException" + "target": "com.amazonaws.bedrockruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "

The number or frequency of requests exceeds the limit. Resubmit your request later.

" + } }, "modelTimeoutException": { - "target": "com.amazonaws.bedrockruntime#ModelTimeoutException" + "target": "com.amazonaws.bedrockruntime#ModelTimeoutException", + "traits": { + "smithy.api#documentation": "

The request took too long to process. Processing time exceeded the model timeout length.

" + } } }, "traits": { @@ -1149,6 +1221,23 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.bedrockruntime#Trace": { + "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.bedrockruntime#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/bedrock.json b/codegen/sdk-codegen/aws-models/bedrock.json index e866df5a4d7..ab3ccfd847e 100644 --- a/codegen/sdk-codegen/aws-models/bedrock.json +++ b/codegen/sdk-codegen/aws-models/bedrock.json @@ -18,6 +18,12 @@ "type": "service", "version": "2023-04-20", "resources": [ + { + "target": "com.amazonaws.bedrock#EvaluationJobResource" + }, + { + "target": "com.amazonaws.bedrock#GuardrailsResource" + }, { "target": "com.amazonaws.bedrock#LoggingResource" }, @@ -46,7 +52,7 @@ "name": "bedrock" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Describes the API operations for creating and managing Amazon Bedrock models.

", + "smithy.api#documentation": "

Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.

", "smithy.api#title": "Amazon Bedrock", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -714,6 +720,21 @@ } } }, + "com.amazonaws.bedrock#AutomatedEvaluationConfig": { + "type": "structure", + "members": { + "datasetMetricConfigs": { + "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs", + "traits": { + "smithy.api#documentation": "

Specifies the required elements for an automatic model evaluation job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Use to specify a automatic model evaluation job. The EvaluationDatasetMetricConfig object is used to specify the prompt datasets, task type, and metric names.

" + } + }, "com.amazonaws.bedrock#BaseModelIdentifier": { "type": "string", "traits": { @@ -765,7 +786,7 @@ "roleArn": { "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#documentation": "

The role ARN.

", + "smithy.api#documentation": "

The role Amazon Resource Name (ARN).

", "smithy.api#required": {} } }, @@ -810,13 +831,13 @@ "smithy.api#httpError": 400 } }, - "com.amazonaws.bedrock#CreateModelCustomizationJob": { + "com.amazonaws.bedrock#CreateEvaluationJob": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#CreateModelCustomizationJobRequest" + "target": "com.amazonaws.bedrock#CreateEvaluationJobRequest" }, "output": { - "target": "com.amazonaws.bedrock#CreateModelCustomizationJobResponse" + "target": "com.amazonaws.bedrock#CreateEvaluationJobResponse" }, "errors": [ { @@ -837,130 +858,95 @@ { "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.

\n

You specify the base foundation model and the location of the training data.\n After the model-customization job completes successfully, your custom model resource will be ready to use. Training data\n contains input and output text for each record in a JSONL format. Optionally, you can specify validation data\n in the same format as the training data. Amazon Bedrock returns validation loss metrics and output generations \n after the job completes.\n

\n

\n Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.\n To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

\n

For more information, see Custom models in the Bedrock User Guide.

", + "smithy.api#documentation": "

API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluations.

", "smithy.api#http": { - "code": 201, + "code": 202, "method": "POST", - "uri": "/model-customization-jobs" + "uri": "/evaluation-jobs" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#CreateModelCustomizationJobRequest": { + "com.amazonaws.bedrock#CreateEvaluationJobRequest": { "type": "structure", "members": { "jobName": { - "target": "com.amazonaws.bedrock#JobName", + "target": "com.amazonaws.bedrock#EvaluationJobName", "traits": { - "smithy.api#documentation": "

Enter a unique name for the fine-tuning job.

", + "smithy.api#documentation": "

The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.

", "smithy.api#required": {} } }, - "customModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

Enter a name for the custom model.

", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", + "jobDescription": { + "target": "com.amazonaws.bedrock#EvaluationJobDescription", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon Bedrock can assume to perform tasks on your behalf.\n 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.\n To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description of the model evaluation job.

" } }, "clientRequestToken": { "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Unique token value that you can provide. The GetModelCustomizationJob response includes the same token value.

", + "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,\n 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", + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#documentation": "

Name of the base model.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.

", "smithy.api#required": {} } }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", - "traits": { - "smithy.api#documentation": "

The customization type.

" - } - }, - "customModelKmsKeyId": { + "customerEncryptionKeyId": { "target": "com.amazonaws.bedrock#KmsKeyId", "traits": { - "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" + "smithy.api#documentation": "

Specify your customer managed key ARN that will be used to encrypt your model evaluation job.

" } }, "jobTags": { "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "

Assign tags to the job.

" - } - }, - "customModelTags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

Assign tags to the custom model.

" + "smithy.api#documentation": "

Tags to attach to the model evaluation job.

" } }, - "trainingDataConfig": { - "target": "com.amazonaws.bedrock#TrainingDataConfig", + "evaluationConfig": { + "target": "com.amazonaws.bedrock#EvaluationConfig", "traits": { - "smithy.api#documentation": "

Information about the training dataset.

", + "smithy.api#documentation": "

Specifies whether the model evaluation job is automatic or uses human worker.

", "smithy.api#required": {} } }, - "validationDataConfig": { - "target": "com.amazonaws.bedrock#ValidationDataConfig", - "traits": { - "smithy.api#documentation": "

Information about the validation dataset.

" - } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#OutputDataConfig", + "inferenceConfig": { + "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", "traits": { - "smithy.api#documentation": "

S3 location for the output data.

", + "smithy.api#documentation": "

Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.

", "smithy.api#required": {} } }, - "hyperParameters": { - "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "outputDataConfig": { + "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", "traits": { - "smithy.api#documentation": "

Parameters related to tuning the model.

", + "smithy.api#documentation": "

An object that defines where the results of model evaluation job will be saved in Amazon S3.

", "smithy.api#required": {} } - }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", - "traits": { - "smithy.api#documentation": "

VPC configuration (optional). Configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for this job.

" - } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrock#CreateModelCustomizationJobResponse": { + "com.amazonaws.bedrock#CreateEvaluationJobResponse": { "type": "structure", "members": { "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "target": "com.amazonaws.bedrock#EvaluationJobArn", "traits": { - "smithy.api#documentation": "

ARN of the fine tuning job

", + "smithy.api#documentation": "

The ARN of the model evaluation job.

", "smithy.api#required": {} } } @@ -969,18 +955,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrock#CreateProvisionedModelThroughput": { + "com.amazonaws.bedrock#CreateGuardrail": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest" + "target": "com.amazonaws.bedrock#CreateGuardrailRequest" }, "output": { - "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse" + "target": "com.amazonaws.bedrock#CreateGuardrailResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -1001,177 +990,135 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a provisioned throughput with dedicated capacity for a foundation model or a fine-tuned model.

\n

For more information, see Provisioned throughput in the Bedrock User Guide.

", + "smithy.api#documentation": "

Creates a guardrail to block topics and to filter out harmful content.

\n ", "smithy.api#http": { - "code": 201, + "code": 202, "method": "POST", - "uri": "/provisioned-model-throughput" - }, - "smithy.api#idempotent": {} + "uri": "/guardrails" + } } }, - "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest": { + "com.amazonaws.bedrock#CreateGuardrailRequest": { "type": "structure", "members": { - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", "traits": { - "smithy.api#documentation": "

Unique token value that you can provide. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The name to give the guardrail.

", + "smithy.api#required": {} } }, - "modelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", "traits": { - "smithy.api#documentation": "

Number of model units to allocate.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description of the guardrail.

" } }, - "provisionedModelName": { - "target": "com.amazonaws.bedrock#ProvisionedModelName", + "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.

" + } + }, + "blockedInputMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", "traits": { - "smithy.api#documentation": "

Unique name for this provisioned throughput.

", + "smithy.api#documentation": "

The message to return when the guardrail blocks a prompt.

", "smithy.api#required": {} } }, - "modelId": { - "target": "com.amazonaws.bedrock#ModelIdentifier", + "blockedOutputsMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", "traits": { - "smithy.api#documentation": "

Name or ARN of the model to associate with this provisioned throughput.

", + "smithy.api#documentation": "

The message to return when the guardrail blocks a model response.

", "smithy.api#required": {} } }, - "commitmentDuration": { - "target": "com.amazonaws.bedrock#CommitmentDuration", + "kmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", "traits": { - "smithy.api#documentation": "

Commitment duration requested for the provisioned throughput.

" + "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": "

Tags to associate with this provisioned throughput.

" + "smithy.api#documentation": "

The tags that you want to attach to the guardrail.

" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse": { - "type": "structure", - "members": { - "provisionedModelArn": { - "target": "com.amazonaws.bedrock#ProvisionedModelArn", + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

The ARN for this provisioned throughput.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request \n completes no more than once. If this token matches a previous request, \n Amazon Bedrock ignores the request, but does not return an error. \n For more information, see Ensuring \n idempotency in the Amazon S3 User Guide.

", + "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#CustomModelArn": { - "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/[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#CustomModelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#CustomModelSummary": { + "com.amazonaws.bedrock#CreateGuardrailResponse": { "type": "structure", "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", "traits": { - "smithy.api#documentation": "

The ARN of the custom model.

", + "smithy.api#documentation": "

The unique identifier of the guardrail that was created.

", "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", + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", "traits": { - "smithy.api#documentation": "

Creation time of the model.

", + "smithy.api#documentation": "

The ARN of the guardrail that was created.

", "smithy.api#required": {} } }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "version": { + "target": "com.amazonaws.bedrock#GuardrailDraftVersion", "traits": { - "smithy.api#documentation": "

The base model ARN.

", + "smithy.api#documentation": "

The version of the guardrail that was created. This value should be 1.

", "smithy.api#required": {} } }, - "baseModelName": { - "target": "com.amazonaws.bedrock#ModelName", + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The base model name.

", + "smithy.api#documentation": "

The time at which the guardrail was created.

", "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.

" - } } }, "traits": { - "smithy.api#documentation": "

Summary information for a custom model.

" - } - }, - "com.amazonaws.bedrock#CustomModelSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#CustomModelSummary" - } - }, - "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" - } - } + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#DeleteCustomModel": { + "com.amazonaws.bedrock#CreateGuardrailVersion": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#DeleteCustomModelRequest" + "target": "com.amazonaws.bedrock#CreateGuardrailVersionRequest" }, "output": { - "target": "com.amazonaws.bedrock#DeleteCustomModelResponse" + "target": "com.amazonaws.bedrock#CreateGuardrailVersionResponse" }, "errors": [ { @@ -1186,6 +1133,9 @@ { "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.bedrock#ThrottlingException" }, @@ -1194,381 +1144,435 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom model that you created earlier. For more information, see Custom models in the Bedrock User Guide.

", + "smithy.api#documentation": "

Creates a version of the guardrail. Use this API to create a snapshot of the \n guardrail when you are satisfied with a configuration, or to compare the configuration with another version.

", "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/custom-models/{modelIdentifier}" - }, - "smithy.api#idempotent": {} + "code": 202, + "method": "POST", + "uri": "/guardrails/{guardrailIdentifier}" + } } }, - "com.amazonaws.bedrock#DeleteCustomModelRequest": { + "com.amazonaws.bedrock#CreateGuardrailVersionRequest": { "type": "structure", "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#ModelIdentifier", + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", "traits": { - "smithy.api#documentation": "

Name of the model to delete.

", + "smithy.api#documentation": "

The unique identifier of the guardrail.

", "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 \n completes no more than once. If this token matches a previous request, \n Amazon Bedrock ignores the request, but does not return an error. \n For more information, see Ensuring \n idempotency in the Amazon S3 User Guide.

", + "smithy.api#idempotencyToken": {} + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrock#DeleteCustomModelResponse": { + "com.amazonaws.bedrock#CreateGuardrailVersionResponse": { "type": "structure", - "members": {}, + "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#DeleteModelInvocationLoggingConfiguration": { + "com.amazonaws.bedrock#CreateModelCustomizationJob": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest" + "target": "com.amazonaws.bedrock#CreateModelCustomizationJobRequest" }, "output": { - "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse" + "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#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#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#ResourceNotFoundException" }, { - "target": "com.amazonaws.bedrock#InternalServerException" + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" }, { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "target": "com.amazonaws.bedrock#ThrottlingException" }, { - "target": "com.amazonaws.bedrock#ThrottlingException" + "target": "com.amazonaws.bedrock#TooManyTagsException" }, { "target": "com.amazonaws.bedrock#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Deletes a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.

", + "smithy.api#documentation": "

Creates a fine-tuning job to customize a base model.

\n

You specify the base foundation model and the location of the training data.\n 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.\n

\n

For information on the format of training and validation data, see Prepare the datasets.

\n

\n Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.\n To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

\n

For more information, see Custom models in the Amazon Bedrock User Guide.

", "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/provisioned-model-throughput/{provisionedModelId}" + "code": 201, + "method": "POST", + "uri": "/model-customization-jobs" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest": { + "com.amazonaws.bedrock#CreateModelCustomizationJobRequest": { "type": "structure", "members": { - "provisionedModelId": { - "target": "com.amazonaws.bedrock#ProvisionedModelId", + "jobName": { + "target": "com.amazonaws.bedrock#JobName", "traits": { - "smithy.api#documentation": "

The ARN or name of the provisioned throughput.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

A name for the fine-tuning job.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.bedrock#FineTuningJobStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } }, - "COMPLETED": { - "target": "smithy.api#Unit", + "customModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", "traits": { - "smithy.api#enumValue": "Completed" + "smithy.api#documentation": "

A name for the resulting custom model.

", + "smithy.api#required": {} } }, - "FAILED": { - "target": "smithy.api#Unit", + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#enumValue": "Failed" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf.\n 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.\n To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.\n

", + "smithy.api#required": {} } }, - "STOPPING": { - "target": "smithy.api#Unit", + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#enumValue": "Stopping" + "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,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} } }, - "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", + "baseModelIdentifier": { + "target": "com.amazonaws.bedrock#BaseModelIdentifier", "traits": { - "smithy.api#documentation": "

The model ARN.

", + "smithy.api#documentation": "

Name of the base model.

", "smithy.api#required": {} } }, - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", "traits": { - "smithy.api#documentation": "

The model identifier.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The customization type.

" } }, - "modelName": { - "target": "com.amazonaws.bedrock#BrandedName", + "customModelKmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", "traits": { - "smithy.api#documentation": "

The model name.

" + "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" } }, - "providerName": { - "target": "com.amazonaws.bedrock#BrandedName", + "jobTags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "

he model's provider name.

" + "smithy.api#documentation": "

Tags to attach to the job.

" } }, - "inputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", + "customModelTags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "

The input modalities that the model supports.

" + "smithy.api#documentation": "

Tags to attach to the resulting custom model.

" } }, - "outputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", "traits": { - "smithy.api#documentation": "

The output modalities that the model supports.

" + "smithy.api#documentation": "

Information about the training dataset.

", + "smithy.api#required": {} } }, - "responseStreamingSupported": { - "target": "smithy.api#Boolean", + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", "traits": { - "smithy.api#documentation": "

Indicates whether the model supports streaming.

" + "smithy.api#documentation": "

Information about the validation dataset.

" } }, - "customizationsSupported": { - "target": "com.amazonaws.bedrock#ModelCustomizationList", + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The customization that the model supports.

" + "smithy.api#documentation": "

S3 location for the output data.

", + "smithy.api#required": {} } }, - "inferenceTypesSupported": { - "target": "com.amazonaws.bedrock#InferenceTypeList", + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", "traits": { - "smithy.api#documentation": "

The inference types that the model supports.

" + "smithy.api#documentation": "

Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters.

", + "smithy.api#required": {} } }, - "modelLifecycle": { - "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", "traits": { - "smithy.api#documentation": "

Contains details about whether a model version is available or deprecated

" + "smithy.api#documentation": "

VPC configuration (optional). Configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for this job.

" } } }, "traits": { - "smithy.api#documentation": "

Information about a foundation model.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#FoundationModelLifecycle": { + "com.amazonaws.bedrock#CreateModelCustomizationJobResponse": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.bedrock#FoundationModelLifecycleStatus", + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", "traits": { - "smithy.api#documentation": "

Specifies whether a model version is available (ACTIVE) or deprecated (LEGACY.

", + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the fine tuning job

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Details about whether a model version is available or deprecated.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#FoundationModelLifecycleStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } + "com.amazonaws.bedrock#CreateProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "LEGACY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEGACY" - } + { + "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#FoundationModelSummary": { + "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest": { "type": "structure", "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

The ARN of the foundation model.

", - "smithy.api#required": {} + "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,\n 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": {} } }, - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", "traits": { - "smithy.api#documentation": "

The model Id of the foundation model.

", + "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.

\n

For model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.

\n

For more information about what an MU specifies, contact your Amazon Web Services account manager.

", "smithy.api#required": {} } }, - "modelName": { - "target": "com.amazonaws.bedrock#BrandedName", + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", "traits": { - "smithy.api#documentation": "

The name of the model.

" + "smithy.api#documentation": "

The name for this Provisioned Throughput.

", + "smithy.api#required": {} } }, - "providerName": { - "target": "com.amazonaws.bedrock#BrandedName", + "modelId": { + "target": "com.amazonaws.bedrock#ModelIdentifier", "traits": { - "smithy.api#documentation": "

The model's provider name.

" + "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": {} } }, - "inputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", "traits": { - "smithy.api#documentation": "

The input modalities that the model supports.

" + "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.

\n

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

" } }, - "outputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", + "tags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "

The output modalities that the model supports.

" + "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#CustomModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 }, - "responseStreamingSupported": { - "target": "smithy.api#Boolean", + "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-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#CustomModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + } + }, + "com.amazonaws.bedrock#CustomModelSummary": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", "traits": { - "smithy.api#documentation": "

Indicates whether the model supports streaming.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model.

", + "smithy.api#required": {} } }, - "customizationsSupported": { - "target": "com.amazonaws.bedrock#ModelCustomizationList", + "modelName": { + "target": "com.amazonaws.bedrock#CustomModelName", "traits": { - "smithy.api#documentation": "

Whether the model supports fine-tuning or continual pre-training.

" + "smithy.api#documentation": "

The name of the custom model.

", + "smithy.api#required": {} } }, - "inferenceTypesSupported": { - "target": "com.amazonaws.bedrock#InferenceTypeList", + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The inference types that the model supports.

" + "smithy.api#documentation": "

Creation time of the model.

", + "smithy.api#required": {} } }, - "modelLifecycle": { - "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "baseModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#documentation": "

Contains details about whether a model version is available or deprecated.

" + "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.

" } } }, "traits": { - "smithy.api#documentation": "

Summary information for a foundation model.

" + "smithy.api#documentation": "

Summary information for a custom model.

" } }, - "com.amazonaws.bedrock#FoundationModelSummaryList": { + "com.amazonaws.bedrock#CustomModelSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.bedrock#FoundationModelSummary" + "target": "com.amazonaws.bedrock#CustomModelSummary" } }, - "com.amazonaws.bedrock#GetCustomModel": { + "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" + } + } + } + }, + "com.amazonaws.bedrock#DeleteCustomModel": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetCustomModelRequest" + "target": "com.amazonaws.bedrock#DeleteCustomModelRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetCustomModelResponse" + "target": "com.amazonaws.bedrock#DeleteCustomModelResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -1583,22 +1587,22 @@ } ], "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 Bedrock User Guide.

", + "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": "GET", + "method": "DELETE", "uri": "/custom-models/{modelIdentifier}" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetCustomModelRequest": { + "com.amazonaws.bedrock#DeleteCustomModelRequest": { "type": "structure", "members": { "modelIdentifier": { "target": "com.amazonaws.bedrock#ModelIdentifier", "traits": { - "smithy.api#documentation": "

Name or ARN of the custom model.

", + "smithy.api#documentation": "

Name of the model to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1608,114 +1612,28 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetCustomModelResponse": { + "com.amazonaws.bedrock#DeleteCustomModelResponse": { "type": "structure", - "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

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 ARN associated with this model.

", - "smithy.api#required": {} - } - }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

ARN of the base model.

", - "smithy.api#required": {} - } - }, - "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.

" - } - }, - "trainingDataConfig": { - "target": "com.amazonaws.bedrock#TrainingDataConfig", - "traits": { - "smithy.api#documentation": "

Information about the training dataset.

", - "smithy.api#required": {} - } - }, - "validationDataConfig": { - "target": "com.amazonaws.bedrock#ValidationDataConfig" - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#OutputDataConfig", - "traits": { - "smithy.api#documentation": "

Output data configuration associated with this custom model.

", - "smithy.api#required": {} - } - }, - "trainingMetrics": { - "target": "com.amazonaws.bedrock#TrainingMetrics", - "traits": { - "smithy.api#documentation": "

The 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": {} - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetFoundationModel": { + "com.amazonaws.bedrock#DeleteGuardrail": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetFoundationModelRequest" + "target": "com.amazonaws.bedrock#DeleteGuardrailRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetFoundationModelResponse" + "target": "com.amazonaws.bedrock#DeleteGuardrailResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -1730,52 +1648,52 @@ } ], "traits": { - "smithy.api#documentation": "

Get details about a Amazon Bedrock foundation model.

", + "smithy.api#documentation": "

Deletes a guardrail.

\n ", "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/foundation-models/{modelIdentifier}" + "code": 202, + "method": "DELETE", + "uri": "/guardrails/{guardrailIdentifier}" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetFoundationModelRequest": { + "com.amazonaws.bedrock#DeleteGuardrailRequest": { "type": "structure", "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#ModelIdentifier", + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", "traits": { - "smithy.api#documentation": "

The model identifier.

", + "smithy.api#documentation": "

The unique identifier of the guardrail.

", "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#GetFoundationModelResponse": { + "com.amazonaws.bedrock#DeleteGuardrailResponse": { "type": "structure", - "members": { - "modelDetails": { - "target": "com.amazonaws.bedrock#FoundationModelDetails", - "traits": { - "smithy.api#documentation": "

Information about the foundation model.

" - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetModelCustomizationJob": { + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetModelCustomizationJobRequest" + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetModelCustomizationJobResponse" + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse" }, "errors": [ { @@ -1785,375 +1703,3062 @@ "target": "com.amazonaws.bedrock#InternalServerException" }, { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, + "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#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" + { + "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#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#EvaluationBedrockModel": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationModelIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the Amazon Bedrock model specified.

", + "smithy.api#required": {} + } + }, + "inferenceParams": { + "target": "com.amazonaws.bedrock#EvaluationModelInferenceParams", + "traits": { + "smithy.api#documentation": "

Each Amazon Bedrock support different inference parameters that change how the model behaves during inference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the ARN of the Amazon Bedrock models specified in your model 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.

\n

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.

" + } + }, + "com.amazonaws.bedrock#EvaluationConfig": { + "type": "union", + "members": { + "automated": { + "target": "com.amazonaws.bedrock#AutomatedEvaluationConfig", + "traits": { + "smithy.api#documentation": "

Used to specify an automated model evaluation job.\n See AutomatedEvaluationConfig to view the required parameters.

" + } + }, + "human": { + "target": "com.amazonaws.bedrock#HumanEvaluationConfig", + "traits": { + "smithy.api#documentation": "

Used to specify a model evaluation job that uses human workers.See HumanEvaluationConfig to view the required parameters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Used to specify either a AutomatedEvaluationConfig or HumanEvaluationConfig object.

" + } + }, + "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.

", + "smithy.api#required": {} + } + }, + "datasetLocation": { + "target": "com.amazonaws.bedrock#EvaluationDatasetLocation", + "traits": { + "smithy.api#documentation": "

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 task type you want the model to carry out.

", + "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 used. For automated model evaluation jobs valid values are \"Builtin.Accuracy\", \"Builtin.Robustness\", and \"Builtin.Toxicity\". In human-based model evaluation jobs the array of strings must match the name parameter specified in HumanEvaluationCustomMetric.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the built-in 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": "

Used to specify the models.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Used to define the models you want used in your model evaluation job. Automated model evaluation jobs support only a single model. In a human-based model evaluation job, your annotator can compare the responses for up to two different models.

" + } + }, + "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#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#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" + } + } + } + }, + "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": 10 + } + } + }, + "com.amazonaws.bedrock#EvaluationModelConfig": { + "type": "union", + "members": { + "bedrockModel": { + "target": "com.amazonaws.bedrock#EvaluationBedrockModel", + "traits": { + "smithy.api#documentation": "

Defines the Amazon Bedrock model and inference parameters you want used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the models used in the model evaluation job.

" + } + }, + "com.amazonaws.bedrock#EvaluationModelConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationModelConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrock#EvaluationModelIdentifier": { + "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][_-]?)+)$" + } + }, + "com.amazonaws.bedrock#EvaluationModelIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationModelIdentifier" + }, + "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 model evaluation job are saved.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 location where the results of your model evaluation job are saved.

" + } + }, + "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 model evaluation job.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "

The name of the model evaluation job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the model evaluation job.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

When the model evaluation job was created.

", + "smithy.api#required": {} + } + }, + "jobType": { + "target": "com.amazonaws.bedrock#EvaluationJobType", + "traits": { + "smithy.api#documentation": "

The type, either human or automatic, of model evaluation job.

", + "smithy.api#required": {} + } + }, + "evaluationTaskTypes": { + "target": "com.amazonaws.bedrock#EvaluationTaskTypes", + "traits": { + "smithy.api#documentation": "

What task type was used in the model evaluation job.

", + "smithy.api#required": {} + } + }, + "modelIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationModelIdentifiers", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the model 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#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.

", + "smithy.api#required": {} + } + } + }, + "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#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#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.

", + "smithy.api#required": {} + } + }, + "baseModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

", + "smithy.api#required": {} + } + }, + "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.

", + "smithy.api#required": {} + } + }, + "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.

", + "smithy.api#required": {} + } + }, + "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": {} + } + } + }, + "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": "

Retrieves the properties associated with a model evaluation job, including the\n status of the job. For more information, see Model evaluations.

", + "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 model evaluation job.

", + "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 of the model evaluation job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the model evaluation job.

", + "smithy.api#required": {} + } + }, + "jobArn": { + "target": "com.amazonaws.bedrock#EvaluationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model evaluation job.

", + "smithy.api#required": {} + } + }, + "jobDescription": { + "target": "com.amazonaws.bedrock#EvaluationJobDescription", + "traits": { + "smithy.api#documentation": "

The description of the model 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 model evaluation job.

", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed key specified when the model evaluation job was created.

" + } + }, + "jobType": { + "target": "com.amazonaws.bedrock#EvaluationJobType", + "traits": { + "smithy.api#documentation": "

The type of model evaluation job.

", + "smithy.api#required": {} + } + }, + "evaluationConfig": { + "target": "com.amazonaws.bedrock#EvaluationConfig", + "traits": { + "smithy.api#documentation": "

Contains details about the type of model evaluation job, the metrics used, the task type selected, the datasets used, and any custom metrics you defined.

", + "smithy.api#required": {} + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", + "traits": { + "smithy.api#documentation": "

Details about the models you specified in your model evaluation job.

", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Amazon S3 location for where output data is saved.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

When the model evaluation job was created.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

When the model evaluation job was last modified.

" + } + }, + "failureMessages": { + "target": "com.amazonaws.bedrock#ErrorMessages", + "traits": { + "smithy.api#documentation": "

An array of strings the specify why the model evaluation job has failed.

" + } + } + }, + "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#GetFoundationModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "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.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/guardrails/{guardrailIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetGuardrailRequest": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail for which to get details.

", + "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.

", + "smithy.api#httpQuery": "guardrailVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetGuardrailResponse": { + "type": "structure", + "members": { + "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": "

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 that was created.

", + "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.

" + } + }, + "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.

" + } + }, + "failureRecommendations": { + "target": "com.amazonaws.bedrock#GuardrailFailureRecommendations", + "traits": { + "smithy.api#documentation": "

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

" + } + }, + "blockedInputMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "

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#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.\n 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.

" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

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.\n 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 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.

", + "smithy.api#required": {} + } + }, + "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.

" + } + } + }, + "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#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.

", + "smithy.api#required": {} + } + }, + "foundationModelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "

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#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#GuardrailBlockedMessaging": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#sensitive": {} + } + }, + "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\n increase the filter strength, the likelihood of filtering harmful content increases\n 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\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.

", + "smithy.api#required": {} + } + } + }, + "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.

\n \n

Content filtering depends on the confidence classification of user inputs and FM\n responses across each of the four harmful categories. All input and output statements are\n classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each\n harmful category. For example, if a statement is classified as\n Hate with HIGH confidence, the likelihood of the statement\n representing hateful content is high. A single statement can be classified across\n multiple categories with varying confidence levels. For example, a single statement\n can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.

\n

For more information, see Guardrails content filters.

\n

This data type is used in the following API operations:

\n " + } + }, + "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\n increase the filter strength, the likelihood of filtering harmful content increases\n 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\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.

", + "smithy.api#required": {} + } + } + }, + "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.

\n \n

Content filtering depends on the confidence classification of user inputs and FM\n responses across each of the four harmful categories. All input and output statements are\n classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each\n harmful category. For example, if a statement is classified as\n Hate with HIGH confidence, the likelihood of the statement\n representing hateful content is high. A single statement can be classified across\n multiple categories with varying confidence levels. For example, a single statement\n can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.

\n

For more information, see Guardrails content filters.

\n

This data type is used in the following API operations:

\n " + } + }, + "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#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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about how to handle harmful content.

\n

This data type is used in the following API operations:

\n " + } + }, + "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": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about how to handle harmful content.

\n

This data type is used in the following API operations:

\n " + } + }, + "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\n The managed word type that was configured for the guardrail.\n (For now, we only offer profanity word list)

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The managed word list that was configured for the guardrail.\n (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": {} + } + } + }, + "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#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": {} + } + } + }, + "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.

", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

Configure guardrail action when the PII entity is detected.

", + "smithy.api#required": {} + } + } + }, + "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": {} + } + } + }, + "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": {} + } + } + }, + "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" + } + } + } + }, + "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": "

Retrieves the properties associated with a model-customization job, including the status of the job.\n For more information, see Custom models in the Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/model-customization-jobs/{jobIdentifier}" - }, - "smithy.api#readonly": {} + "smithy.api#documentation": "

Contains details about PII entities and regular expressions configured for the guardrail.

" } }, - "com.amazonaws.bedrock#GetModelCustomizationJobRequest": { + "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig": { "type": "structure", "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", + "piiEntitiesConfig": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntitiesConfig", "traits": { - "smithy.api#documentation": "

Identifier for the customization job.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "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#input": {} + "smithy.api#documentation": "

Contains details about PII entities and regular expressions to configure for the guardrail.

" } }, - "com.amazonaws.bedrock#GetModelCustomizationJobResponse": { - "type": "structure", + "com.amazonaws.bedrock#GuardrailStatus": { + "type": "enum", "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "CREATING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The ARN of the customization job.

", - "smithy.api#required": {} + "smithy.api#enumValue": "CREATING" } }, - "jobName": { - "target": "com.amazonaws.bedrock#JobName", + "UPDATING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The name of the customization job.

", - "smithy.api#required": {} + "smithy.api#enumValue": "UPDATING" } }, - "outputModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", + "VERSIONING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The name of the output model.

", - "smithy.api#required": {} + "smithy.api#enumValue": "VERSIONING" } }, - "outputModelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", + "READY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The ARN of the output model.

" + "smithy.api#enumValue": "READY" } }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The token that you specified in the CreateCustomizationJob request.

" + "smithy.api#enumValue": "FAILED" } }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", + "DELETING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role.

", - "smithy.api#required": {} + "smithy.api#enumValue": "DELETING" } + } + } + }, + "com.amazonaws.bedrock#GuardrailStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 }, - "status": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", + "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 status of the job. A successful job transitions from in-progress to completed when the output model is ready to use.\n If the job failed, the failure message contains information about why the job failed.

" + "smithy.api#documentation": "

The unique identifier of the guardrail.

", + "smithy.api#required": {} } }, - "failureMessage": { - "target": "com.amazonaws.bedrock#ErrorMessage", + "arn": { + "target": "com.amazonaws.bedrock#GuardrailArn", "traits": { - "smithy.api#documentation": "

Information about why the job failed.

" + "smithy.api#documentation": "

The ARN of the guardrail.

", + "smithy.api#required": {} } }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "status": { + "target": "com.amazonaws.bedrock#GuardrailStatus", "traits": { - "smithy.api#documentation": "

Time that the resource was created.

", + "smithy.api#documentation": "

The status of the guardrail.

", "smithy.api#required": {} } }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", "traits": { - "smithy.api#documentation": "

Time that the resource was last modified.

" + "smithy.api#documentation": "

The name of the guardrail.

", + "smithy.api#required": {} } }, - "endTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", "traits": { - "smithy.api#documentation": "

Time that the resource transitioned to terminal state.

" + "smithy.api#documentation": "

A description of the guardrail.

" } }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", + "version": { + "target": "com.amazonaws.bedrock#GuardrailVersion", "traits": { - "smithy.api#documentation": "

ARN of the base model.

", + "smithy.api#documentation": "

The version of the guardrail.

", "smithy.api#required": {} } }, - "hyperParameters": { - "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The hyperparameter values for the job. For information about hyperparameters for specific models, see Guidelines for model customization.

", + "smithy.api#documentation": "

The date and time at which the guardrail was created.

", "smithy.api#required": {} } }, - "trainingDataConfig": { - "target": "com.amazonaws.bedrock#TrainingDataConfig", + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { + "smithy.api#documentation": "

The date and time at which the guardrail was last updated.

", "smithy.api#required": {} } - }, - "validationDataConfig": { - "target": "com.amazonaws.bedrock#ValidationDataConfig", + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about a guardrail.

\n

This data type is used in the following API operations:

\n " + } + }, + "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": {} } }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#OutputDataConfig", + "definition": { + "target": "com.amazonaws.bedrock#GuardrailTopicDefinition", "traits": { - "smithy.api#documentation": "

Output data configuration

", + "smithy.api#documentation": "

A definition of the topic to deny.

", "smithy.api#required": {} } }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", + "examples": { + "target": "com.amazonaws.bedrock#GuardrailTopicExamples", "traits": { - "smithy.api#documentation": "

The type of model customization.

" + "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.

" } }, - "outputModelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", + "type": { + "target": "com.amazonaws.bedrock#GuardrailTopicType", "traits": { - "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" + "smithy.api#documentation": "

Specifies to deny the topic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about topics for the guardrail to identify and deny.

\n

This data type is used in the following API operations:

\n " + } + }, + "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": {} } }, - "trainingMetrics": { - "target": "com.amazonaws.bedrock#TrainingMetrics" + "definition": { + "target": "com.amazonaws.bedrock#GuardrailTopicDefinition", + "traits": { + "smithy.api#documentation": "

A definition of the topic to deny.

", + "smithy.api#required": {} + } }, - "validationMetrics": { - "target": "com.amazonaws.bedrock#ValidationMetrics", + "examples": { + "target": "com.amazonaws.bedrock#GuardrailTopicExamples", "traits": { - "smithy.api#documentation": "

The loss metric for each validator that you provided in the createjob request.

" + "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.

" } }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", + "type": { + "target": "com.amazonaws.bedrock#GuardrailTopicType", "traits": { - "smithy.api#documentation": "

VPC configuration for the custom model job.

" + "smithy.api#documentation": "

Specifies to deny the topic.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Details about topics for the guardrail to identify and deny.

\n

This data type is used in the following API operations:

\n " } }, - "com.amazonaws.bedrock#GetModelInvocationLoggingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" + "com.amazonaws.bedrock#GuardrailTopicDefinition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 }, - { - "target": "com.amazonaws.bedrock#InternalServerException" + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailTopicExample": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" + "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#documentation": "

Get the current configuration values for model invocation logging.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/logging/modelinvocations" + "smithy.api#length": { + "min": 1, + "max": 100 }, - "smithy.api#readonly": {} + "smithy.api#pattern": "^[0-9a-zA-Z-_ !?.]+$", + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest": { + "com.amazonaws.bedrock#GuardrailTopicPolicy": { "type": "structure", - "members": {}, + "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": {} + } + } + }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "

Contains details about topics that the guardrail should identify and deny.

\n

This data type is used in the following API operations:

\n " } }, - "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse": { + "com.amazonaws.bedrock#GuardrailTopicPolicyConfig": { "type": "structure", "members": { - "loggingConfig": { - "target": "com.amazonaws.bedrock#LoggingConfig", + "topicsConfig": { + "target": "com.amazonaws.bedrock#GuardrailTopicsConfig", "traits": { - "smithy.api#documentation": "

The current configuration values.

" + "smithy.api#documentation": "

A list of policies related to topics that the guardrail should deny.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Contains details about topics that the guardrail should identify and deny.

\n

This data type is used in the following API operations:

\n " } }, - "com.amazonaws.bedrock#GetProvisionedModelThroughput": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest" + "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" }, - "output": { - "target": "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse" + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.bedrock#GuardrailTopicsConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailTopicConfig" }, - "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#length": { + "min": 1, + "max": 30 } - ], + } + }, + "com.amazonaws.bedrock#GuardrailVersion": { + "type": "string", "traits": { - "smithy.api#documentation": "

Get details for a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/provisioned-model-throughput/{provisionedModelId}" - }, - "smithy.api#readonly": {} + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" } }, - "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest": { + "com.amazonaws.bedrock#GuardrailWord": { "type": "structure", "members": { - "provisionedModelId": { - "target": "com.amazonaws.bedrock#ProvisionedModelId", + "text": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN or name of the provisioned throughput.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

Text of the word configured for the guardrail to block.

", + "smithy.api#length": { + "min": 1, + "max": 100 + }, "smithy.api#required": {} } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "

A word configured for the guardrail.

" } }, - "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse": { + "com.amazonaws.bedrock#GuardrailWordConfig": { "type": "structure", "members": { - "modelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", + "text": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The current number of model units requested to be available for this provisioned throughput.

", + "smithy.api#documentation": "

Text of the word configured for the guardrail to block.

", + "smithy.api#length": { + "min": 1, + "max": 100 + }, "smithy.api#required": {} } - }, - "desiredModelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", + } + }, + "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": "

The desired number of model units that was requested to be available for this provisioned throughput.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of words configured for the guardrail.

" } }, - "provisionedModelName": { - "target": "com.amazonaws.bedrock#ProvisionedModelName", + "managedWordLists": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordLists", "traits": { - "smithy.api#documentation": "

The name of the provisioned throughput.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of managed words configured for the guardrail.

" } - }, - "provisionedModelArn": { - "target": "com.amazonaws.bedrock#ProvisionedModelArn", + } + }, + "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": "

The ARN of the provisioned throughput.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of words to configure for the guardrail.

" } }, - "modelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "managedWordListsConfig": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordListsConfig", "traits": { - "smithy.api#documentation": "

The ARN or name of the model associated with this provisioned throughput.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of managed words to configure for the guardrail.

" } - }, - "desiredModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + } + }, + "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 ARN of the new model to asssociate with this provisioned throughput.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The parameters of the human workflow.

" } }, - "foundationModelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", + "customMetrics": { + "target": "com.amazonaws.bedrock#HumanEvaluationCustomMetrics", "traits": { - "smithy.api#documentation": "

ARN of the foundation model.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A HumanEvaluationCustomMetric object. It contains the names the metrics, how the metrics are to be evaluated, an optional description.

" } }, - "status": { - "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "datasetMetricConfigs": { + "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs", "traits": { - "smithy.api#documentation": "

Status of the provisioned throughput.

", + "smithy.api#documentation": "

Use to specify the metrics, task, and prompt dataset to be used in your model evaluation job.

", "smithy.api#required": {} } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + } + }, + "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.

\n

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.

" + } + }, + "com.amazonaws.bedrock#HumanEvaluationCustomMetric": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#EvaluationMetricName", "traits": { - "smithy.api#documentation": "

The timestamp of the creation time for this provisioned throughput.

", + "smithy.api#documentation": "

The name of the metric. Your human evaluators will see this name in the evaluation UI.

", "smithy.api#required": {} } }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "description": { + "target": "com.amazonaws.bedrock#EvaluationMetricDescription", "traits": { - "smithy.api#documentation": "

The timestamp of the last modified time of this provisioned throughput.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An optional description of the metric. Use this parameter to provide more details about the metric.

" } }, - "failureMessage": { - "target": "com.amazonaws.bedrock#ErrorMessage", + "ratingMethod": { + "target": "com.amazonaws.bedrock#EvaluationRatingMethod", "traits": { - "smithy.api#documentation": "

Failure message for any issues that the create operation encounters.

" + "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\n

", + "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#documentation": "

In a model evaluation job that uses human workers you must\n define the name of the metric, and how you want that metric rated\n ratingMethod, and an optional description of the metric.

" + } + }, + "com.amazonaws.bedrock#HumanEvaluationCustomMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#HumanEvaluationCustomMetric" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrock#HumanTaskInstructions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 }, - "commitmentDuration": { - "target": "com.amazonaws.bedrock#CommitmentDuration", + "smithy.api#pattern": "^[\\S\\s]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#HumanWorkflowConfig": { + "type": "structure", + "members": { + "flowDefinitionArn": { + "target": "com.amazonaws.bedrock#SageMakerFlowDefinitionArn", "traits": { - "smithy.api#documentation": "

Commitment duration of the provisioned throughput.

" + "smithy.api#documentation": "

The Amazon Resource Number (ARN) for the flow definition

", + "smithy.api#required": {} } }, - "commitmentExpirationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "instructions": { + "target": "com.amazonaws.bedrock#HumanTaskInstructions", "traits": { - "smithy.api#documentation": "

Commitment expiration time for the provisioned throughput.

" + "smithy.api#documentation": "

Instructions for the flow definition

" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Contains SageMakerFlowDefinition object. The object is used to specify the prompt dataset, task type, rating method and metric names.

" } }, "com.amazonaws.bedrock#IdempotencyToken": { @@ -2263,7 +4868,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.

\n

For more information, see Custom models in the Bedrock User Guide.

", + "smithy.api#documentation": "

Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.

\n

For more information, see Custom models in the Amazon Bedrock User Guide.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2302,24 +4907,146 @@ "smithy.api#httpQuery": "nameContains" } }, - "baseModelArnEquals": { - "target": "com.amazonaws.bedrock#ModelArn", + "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": "

Maximum number of results to return in the response.

", + "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#SortModelsBy", + "traits": { + "smithy.api#documentation": "

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" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListCustomModelsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

Continuation token for the next request to list the next set of results.

" + } + }, + "modelSummaries": { + "target": "com.amazonaws.bedrock#CustomModelSummaryList", + "traits": { + "smithy.api#documentation": "

Model summaries.

" + } + } + }, + "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 model 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 that includes model evaluation jobs created after the time specified.

", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that includes model evaluation jobs created prior to the time specified.

", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", "traits": { - "smithy.api#documentation": "

Return custom models only if the base model ARN matches this parameter.

", - "smithy.api#httpQuery": "baseModelArnEquals" + "smithy.api#documentation": "

Only return jobs where the status condition is met.

", + "smithy.api#httpQuery": "statusEquals" } }, - "foundationModelArnEquals": { - "target": "com.amazonaws.bedrock#FoundationModelArn", + "nameContains": { + "target": "com.amazonaws.bedrock#EvaluationJobName", "traits": { - "smithy.api#documentation": "

Return custom models only if the foundation model ARN matches this parameter.

", - "smithy.api#httpQuery": "foundationModelArnEquals" + "smithy.api#documentation": "

Query parameter string for model evaluation job names.

", + "smithy.api#httpQuery": "nameContains" } }, "maxResults": { "target": "com.amazonaws.bedrock#MaxResults", "traits": { - "smithy.api#documentation": "

Maximum number of results to return in the response.

", + "smithy.api#documentation": "

The maximum number of results to return.

", "smithy.api#httpQuery": "maxResults" } }, @@ -2331,16 +5058,16 @@ } }, "sortBy": { - "target": "com.amazonaws.bedrock#SortModelsBy", + "target": "com.amazonaws.bedrock#SortJobsBy", "traits": { - "smithy.api#documentation": "

The field to sort by in the returned list of models.

", + "smithy.api#documentation": "

Allows you to sort model evaluation jobs by when they were created.

", "smithy.api#httpQuery": "sortBy" } }, "sortOrder": { "target": "com.amazonaws.bedrock#SortOrder", "traits": { - "smithy.api#documentation": "

The sort order of the results.

", + "smithy.api#documentation": "

How you want the order of jobs sorted.

", "smithy.api#httpQuery": "sortOrder" } } @@ -2349,19 +5076,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#ListCustomModelsResponse": { + "com.amazonaws.bedrock#ListEvaluationJobsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.bedrock#PaginationToken", "traits": { - "smithy.api#documentation": "

Continuation token for the next request to list the next set of results.

" + "smithy.api#documentation": "

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

" } }, - "modelSummaries": { - "target": "com.amazonaws.bedrock#CustomModelSummaryList", + "jobSummaries": { + "target": "com.amazonaws.bedrock#EvaluationSummaries", "traits": { - "smithy.api#documentation": "

Model summaries.

" + "smithy.api#documentation": "

A summary of the model evaluation jobs.

" } } }, @@ -2392,7 +5119,7 @@ } ], "traits": { - "smithy.api#documentation": "

List of Amazon Bedrock foundation models that you can use. For more information, see Foundation models in the Bedrock User Guide.

", + "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", @@ -2407,28 +5134,28 @@ "byProvider": { "target": "com.amazonaws.bedrock#Provider", "traits": { - "smithy.api#documentation": "

A Amazon Bedrock model provider.

", + "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": "

List by customization type.

", + "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": "

List by output modality type.

", + "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": "

List by inference type.

", + "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" } } @@ -2451,6 +5178,97 @@ "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.

\n

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.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/guardrails" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "guardrails" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListGuardrailsRequest": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail.

", + "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.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListGuardrailsResponse": { + "type": "structure", + "members": { + "guardrails": { + "target": "com.amazonaws.bedrock#GuardrailSummaries", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#ListModelCustomizationJobs": { "type": "operation", "input": { @@ -2474,7 +5292,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria.

\n

For more information, see Custom models in the Bedrock User Guide.

", + "smithy.api#documentation": "

Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria.

\n

For more information, see Custom models in the Amazon Bedrock User Guide.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2596,7 +5414,7 @@ } ], "traits": { - "smithy.api#documentation": "

List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.

", + "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", @@ -2617,56 +5435,56 @@ "creationTimeAfter": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

Return provisioned capacities created after the specified time.

", + "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": "

Return provisioned capacities created before the specified time.

", + "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": "

Return the list of provisioned capacities that match the specified status.

", + "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": "

Return the list of provisioned capacities where their model ARN is equal to this parameter.

", + "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": "

Return the list of provisioned capacities if their name contains these characters.

", + "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.

", + "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\n value. To see the next batch of results, send the nextToken value in another list request.

", "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#documentation": "

If there are more results than the number you specified in the maxResults field, the response returns a nextToken\n value. To see the next batch of results, specify the nextToken value in this field.

", "smithy.api#httpQuery": "nextToken" } }, "sortBy": { "target": "com.amazonaws.bedrock#SortByProvisionedModels", "traits": { - "smithy.api#documentation": "

The field to sort by in the returned list of provisioned capacities.

", + "smithy.api#documentation": "

The field by which to sort the returned list of Provisioned Throughputs.

", "smithy.api#httpQuery": "sortBy" } }, @@ -2688,13 +5506,13 @@ "nextToken": { "target": "com.amazonaws.bedrock#PaginationToken", "traits": { - "smithy.api#documentation": "

Continuation token for the next request to list the next set of results.

" + "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.

" } }, "provisionedModelSummaries": { "target": "com.amazonaws.bedrock#ProvisionedModelSummaries", "traits": { - "smithy.api#documentation": "

List of summaries, one for each provisioned throughput in the response.

" + "smithy.api#documentation": "

A list of summaries, one for each Provisioned Throughput in the response.

" } } }, @@ -2728,7 +5546,7 @@ } ], "traits": { - "smithy.api#documentation": "

List the tags associated with the specified resource.

\n

For more information, see Tagging resources in the Bedrock User Guide.

", + "smithy.api#documentation": "

List the tags associated with the specified resource.

\n

For more information, see Tagging resources in the Amazon Bedrock User Guide.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -2742,7 +5560,7 @@ "resourceARN": { "target": "com.amazonaws.bedrock#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "

The ARN of the resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#required": {} } } @@ -2809,7 +5627,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration fields for invokation logging.

" + "smithy.api#documentation": "

Configuration fields for invocation logging.

" } }, "com.amazonaws.bedrock#LoggingResource": { @@ -2939,14 +5757,14 @@ "jobArn": { "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", "traits": { - "smithy.api#documentation": "

ARN of the customization job.

", + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the customization job.

", "smithy.api#required": {} } }, "baseModelArn": { "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#documentation": "

ARN of the base model.

", + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

", "smithy.api#required": {} } }, @@ -2986,7 +5804,7 @@ "customModelArn": { "target": "com.amazonaws.bedrock#CustomModelArn", "traits": { - "smithy.api#documentation": "

ARN of the custom model.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the custom model.

" } }, "customModelName": { @@ -3189,88 +6007,88 @@ "provisionedModelName": { "target": "com.amazonaws.bedrock#ProvisionedModelName", "traits": { - "smithy.api#documentation": "

The name of the provisioned throughput.

", + "smithy.api#documentation": "

The name of the Provisioned Throughput.

", "smithy.api#required": {} } }, "provisionedModelArn": { "target": "com.amazonaws.bedrock#ProvisionedModelArn", "traits": { - "smithy.api#documentation": "

The ARN of the provisioned throughput.

", + "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 ARN of the model associated with this provisioned throughput.

", + "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": "

Desired model ARN.

", + "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.

", "smithy.api#required": {} } }, "foundationModelArn": { "target": "com.amazonaws.bedrock#FoundationModelArn", "traits": { - "smithy.api#documentation": "

Foundation model ARN.

", + "smithy.api#documentation": "

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.

", + "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": "

Desired model units.

", + "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": "

Status of the provisioned throughput.

", + "smithy.api#documentation": "

The status of the Provisioned Throughput.

", "smithy.api#required": {} } }, "commitmentDuration": { "target": "com.amazonaws.bedrock#CommitmentDuration", "traits": { - "smithy.api#documentation": "

Commitment duration for the provisioned throughput.

" + "smithy.api#documentation": "

The duration for which the Provisioned Throughput was committed.

" } }, "commitmentExpirationTime": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

Commitment expiration time for the provisioned throughput.

" + "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 this provisioned throughput was created.

", + "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 this provisioned throughput was last modified.

", + "smithy.api#documentation": "

The time that the Provisioned Throughput was last modified.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Set of fields associated with a provisioned throughput.

" + "smithy.api#documentation": "

A summary of information about a Provisioned Throughput.

\n

This data type is used in the following API operations:

\n " } }, "com.amazonaws.bedrock#ProvisionedModelThroughputResource": { @@ -3355,7 +6173,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified resource ARN was not found. Check the ARN and try your request again.

", + "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 } @@ -3400,6 +6218,15 @@ "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" } }, + "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#SecurityGroupId": { "type": "string", "traits": { @@ -3484,6 +6311,66 @@ } } }, + "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 in progress model evaluation job.

", + "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 ARN of the model 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": { @@ -3513,7 +6400,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops an active model customization job. For more information, see Custom models in the Bedrock User Guide.

", + "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", @@ -3654,7 +6541,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associate tags with a resource. For more information, see Tagging resources in the Bedrock User Guide.

", + "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", @@ -3668,7 +6555,7 @@ "resourceARN": { "target": "com.amazonaws.bedrock#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "

The ARN of the resource to tag.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to tag.

", "smithy.api#required": {} } }, @@ -3708,7 +6595,7 @@ "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}|)((:(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})$)|(:provisioned-model/[a-z0-9]{12}$)))" + "smithy.api#pattern": "(^[a-zA-Z0-9][a-zA-Z0-9\\-]*$)|(^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})$)|(:provisioned-model/[a-z0-9]{12}$)|(:guardrail/[a-z0-9]+$)|(:evaluation-job/[a-z0-9]{12}$)))" } }, "com.amazonaws.bedrock#TaggingResource": { @@ -3758,7 +6645,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request contains more tags than can be associated with a resource (50 tags per resource). \n The maximum number of tags includes both existing tags and those included in your current request.

", + "smithy.api#documentation": "

The request contains more tags than can be associated with a resource (50 tags per resource).\n The maximum number of tags includes both existing tags and those included in your current request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3835,7 +6722,7 @@ } ], "traits": { - "smithy.api#documentation": "

Remove one or more tags from a resource. For more information, see Tagging resources in the Bedrock User Guide.

", + "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", @@ -3849,7 +6736,7 @@ "resourceARN": { "target": "com.amazonaws.bedrock#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "

The ARN of the resource to untag.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to untag.

", "smithy.api#required": {} } }, @@ -3872,6 +6759,156 @@ "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.

\n ", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/guardrails/{guardrailIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#UpdateGuardrailRequest": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail

", + "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.

" + } + }, + "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 that was created.

", + "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#UpdateProvisionedModelThroughput": { "type": "operation", "input": { @@ -3898,7 +6935,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.

", + "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", @@ -3913,7 +6950,7 @@ "provisionedModelId": { "target": "com.amazonaws.bedrock#ProvisionedModelId", "traits": { - "smithy.api#documentation": "

The ARN or name of the provisioned throughput to update.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the Provisioned Throughput to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3921,13 +6958,13 @@ "desiredProvisionedModelName": { "target": "com.amazonaws.bedrock#ProvisionedModelName", "traits": { - "smithy.api#documentation": "

The new name for this provisioned throughput.

" + "smithy.api#documentation": "

The new name for this Provisioned Throughput.

" } }, "desiredModelId": { "target": "com.amazonaws.bedrock#ModelIdentifier", "traits": { - "smithy.api#documentation": "

The ARN of the new model to associate with this provisioned throughput.

" + "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.

\n

If this Provisioned Throughput is associated with a custom model, you can specify one of the following options:

\n " } } }, diff --git a/codegen/sdk-codegen/aws-models/cost-explorer.json b/codegen/sdk-codegen/aws-models/cost-explorer.json index 5ca66b2d65f..2800a9bc06c 100644 --- a/codegen/sdk-codegen/aws-models/cost-explorer.json +++ b/codegen/sdk-codegen/aws-models/cost-explorer.json @@ -4067,7 +4067,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves cost and usage metrics with resources for your account. You can specify which\n cost and usage-related metric, such as BlendedCosts or\n UsageQuantity, that you want the request to return. You can also filter and group\n your data by various dimensions, such as SERVICE or AZ, in a\n specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts. This API is currently available for the\n Amazon Elastic Compute Cloud – Compute service only.

\n \n

This is an opt-in only feature. You can enable this feature from the Cost Explorer\n Settings page. For information about how to access the Settings page, see Controlling\n Access for Cost Explorer in the Billing and Cost Management User\n Guide.

\n " + "smithy.api#documentation": "

Retrieves cost and usage metrics with resources for your account. You can specify which\n cost and usage-related metric, such as BlendedCosts or\n UsageQuantity, that you want the request to return. You can also filter and group\n your data by various dimensions, such as SERVICE or AZ, in a\n specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts.

\n

Hourly granularity is only available for EC2-Instances (Elastic Compute Cloud)\n resource-level data. All other resource-level data is available at daily\n granularity.

\n \n

This is an opt-in only feature. You can enable this feature from the Cost Explorer\n Settings page. For information about how to access the Settings page, see Controlling\n Access for Cost Explorer in the Billing and Cost Management User\n Guide.

\n " } }, "com.amazonaws.costexplorer#GetCostAndUsageWithResourcesRequest": { @@ -7372,18 +7372,24 @@ "RecommendationId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The ID for this specific recommendation.

" + "smithy.api#documentation": "

The ID for the recommendation.

" } }, "GenerationTimestamp": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The timestamp for when Amazon Web Services made this recommendation.

" + "smithy.api#documentation": "

The timestamp for when Amazon Web Services made the recommendation.

" + } + }, + "AdditionalMetadata": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

Additional metadata that might be applicable to the recommendation.

" } } }, "traits": { - "smithy.api#documentation": "

Information about this specific recommendation, such as the timestamp for when Amazon Web Services made a specific recommendation.

" + "smithy.api#documentation": "

Information about a recommendation, such as the timestamp for when Amazon Web Services\n made a specific recommendation.

" } }, "com.amazonaws.costexplorer#ReservationPurchaseRecommendationSummary": { @@ -7690,19 +7696,19 @@ "RecommendationId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The ID for this specific recommendation.

" + "smithy.api#documentation": "

The ID for the recommendation.

" } }, "GenerationTimestamp": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The timestamp for when Amazon Web Services made this recommendation.

" + "smithy.api#documentation": "

The timestamp for when Amazon Web Services made the recommendation.

" } }, "LookbackPeriodInDays": { "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", "traits": { - "smithy.api#documentation": "

The number of days of previous usage that Amazon Web Services considers when making\n this recommendation.

" + "smithy.api#documentation": "

The number of days of previous usage that Amazon Web Services considers when making the\n recommendation.

" } }, "AdditionalMetadata": { @@ -7713,7 +7719,7 @@ } }, "traits": { - "smithy.api#documentation": "

Metadata for this recommendation set.

" + "smithy.api#documentation": "

Metadata for a recommendation set.

" } }, "com.amazonaws.costexplorer#RightsizingRecommendationSummary": { diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index b91544f82a8..4c15caa0aa4 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -3284,6 +3284,9 @@ { "target": "com.amazonaws.ec2#DisableImageDeprecation" }, + { + "target": "com.amazonaws.ec2#DisableImageDeregistrationProtection" + }, { "target": "com.amazonaws.ec2#DisableIpamOrganizationAdminAccount" }, @@ -3374,6 +3377,9 @@ { "target": "com.amazonaws.ec2#EnableImageDeprecation" }, + { + "target": "com.amazonaws.ec2#EnableImageDeregistrationProtection" + }, { "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccount" }, @@ -6476,7 +6482,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "CertificateS3ObjectKey", - "smithy.api#documentation": "

The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The \n\t\t\tobject key is formatted as follows: role_arn/certificate_arn.

", + "smithy.api#documentation": "

The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The \n\t\t\tobject key is formatted as follows: role_arn/certificate_arn.

", "smithy.api#xmlName": "certificateS3ObjectKey" } }, @@ -7412,7 +7418,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "CertificateS3ObjectKey", - "smithy.api#documentation": "

The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle \n\t\t\tis stored. The object key is formated as follows: role_arn/certificate_arn.\n\t\t

", + "smithy.api#documentation": "

The key of the Amazon S3 object where the certificate, certificate chain, and encrypted private key bundle \n\t\t\tare stored. The object key is formatted as follows: role_arn/certificate_arn.\n\t\t

", "smithy.api#xmlName": "certificateS3ObjectKey" } }, @@ -7420,7 +7426,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "EncryptionKmsKeyId", - "smithy.api#documentation": "

The ID of the KMS customer master key (CMK) used to encrypt the private key.

", + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the private key.

", "smithy.api#xmlName": "encryptionKmsKeyId" } } @@ -14838,7 +14844,7 @@ "target": "com.amazonaws.ec2#CreateDhcpOptionsResult" }, "traits": { - "smithy.api#documentation": "

Creates a custom set of DHCP options. After you create a DHCP option set, you associate\n\t it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly \n\t launched instances in the VPC use this set of DHCP options.

\n

The following are the individual DHCP options you can specify. For more information, see \n DHCP options sets \n in the Amazon VPC User Guide.

\n ", + "smithy.api#documentation": "

Creates a custom set of DHCP options. After you create a DHCP option set, you associate\n\t it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly \n\t launched instances in the VPC use this set of DHCP options.

\n

The following are the individual DHCP options you can specify. For more information, see \n DHCP options sets \n in the Amazon VPC User Guide.

\n ", "smithy.api#examples": [ { "title": "To create a DHCP options set", @@ -16299,7 +16305,7 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateResult" }, "traits": { - "smithy.api#documentation": "

Creates a launch template.

\n

A launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#documentation": "

Creates a launch template.

\n

A launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.

\n

To clone an existing launch template as the basis for a new launch template, use the \n Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more \n information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.

", "smithy.api#examples": [ { "title": "To create a launch template", @@ -16385,7 +16391,7 @@ "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.

\n \n

To specify the tags for the resources that are created when an instance is\n launched, you must use the TagSpecifications parameter in the launch\n template data structure.

\n ", + "smithy.api#documentation": "

The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.

\n

To specify the tags for the resources that are created when an instance is\n launched, you must use the TagSpecifications parameter in the launch template data structure.

", "smithy.api#xmlName": "TagSpecification" } } @@ -16427,7 +16433,7 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateVersionResult" }, "traits": { - "smithy.api#documentation": "

Creates a new version of a launch template. You can specify an existing version of\n launch template from which to base the new version.

\n

Launch template versions are numbered in the order in which they are created. You\n cannot specify, change, or replace the numbering of launch template versions.

\n

Launch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes any\n changes you require.

\n

For more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#documentation": "

Creates a new version of a launch template. You must specify an existing launch\n template, either by name or ID. You can determine whether the new version inherits \n parameters from a source version, and add or overwrite parameters as needed.

\n

Launch template versions are numbered in the order in which they are created. You\n can't specify, change, or replace the numbering of launch template versions.

\n

Launch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes the\n changes that you require.

\n

For more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.

", "smithy.api#examples": [ { "title": "To create a launch template version", @@ -16489,19 +16495,19 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" } }, "SourceVersion": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The version number of the launch template version on which to base the new version.\n The new version inherits the same launch parameters as the source version, except for\n parameters that you specify in LaunchTemplateData. Snapshots applied to the\n block device mapping are ignored when creating a new version unless they are explicitly\n included.

" + "smithy.api#documentation": "

The version of the launch template on which to base the new version. \n Snapshots applied to the block device mapping are ignored when creating a new version \n unless they are explicitly included.

\n

If you specify this parameter, the new version inherits the launch parameters from the\n source version. If you specify additional launch parameters for the new version, they \n overwrite any corresponding launch parameters inherited from the source version.

\n

If you omit this parameter, the new version contains only the launch parameters\n that you specify for the new version.

" } }, "VersionDescription": { @@ -23356,13 +23362,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" } } }, @@ -23432,13 +23438,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" } }, "Versions": { @@ -30862,7 +30868,7 @@ "target": "com.amazonaws.ec2#DescribeImagesResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

\n

The images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.

\n

Recently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.

\n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#documentation": "

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

\n

The images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.

\n

Recently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n \n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", "smithy.api#examples": [ { "title": "To describe an AMI", @@ -32096,7 +32102,7 @@ "target": "com.amazonaws.ec2#DescribeInstancesResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified instances or all instances.

\n

If you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.

\n

If you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.

\n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#documentation": "

Describes the specified instances or all instances.

\n

If you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.

\n

If you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n \n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", "smithy.api#examples": [ { "title": "To describe an Amazon EC2 instance", @@ -33300,13 +33306,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateId or the LaunchTemplateName, but not\n both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the launch template ID or the launch template name, but not both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateName or the LaunchTemplateId, but not\n both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" + "smithy.api#documentation": "

The name of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the launch template name or the launch template ID, but not both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" } }, "Versions": { @@ -35322,7 +35328,7 @@ "target": "com.amazonaws.ec2#DescribeNetworkInterfacesResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your network interfaces.

\n

If you have a large number of network interfaces, the operation fails unless \n you use pagination or one of the following filters: group-id, \n mac-address, private-dns-name, private-ip-address, \n private-dns-name, subnet-id, or vpc-id.

", + "smithy.api#documentation": "

Describes one or more of your network interfaces.

\n

If you have a large number of network interfaces, the operation fails unless \n you use pagination or one of the following filters: group-id, \n mac-address, private-dns-name, private-ip-address, \n private-dns-name, subnet-id, or vpc-id.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n ", "smithy.api#examples": [ { "title": "To describe a network interface", @@ -35481,7 +35487,7 @@ "target": "com.amazonaws.ec2#NetworkInterfaceList", "traits": { "aws.protocols#ec2QueryName": "NetworkInterfaceSet", - "smithy.api#documentation": "

Information about one or more network interfaces.

", + "smithy.api#documentation": "

Information about the network interfaces.

", "smithy.api#xmlName": "networkInterfaceSet" } }, @@ -37214,7 +37220,7 @@ "target": "com.amazonaws.ec2#DescribeSnapshotsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified EBS snapshots available to you or all of the EBS snapshots\n available to you.

\n

The snapshots available to you include public snapshots, private snapshots that you own,\n and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume\n permissions.

\n

The create volume permissions fall into the following categories:

\n \n

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot\n owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, \n Amazon EC2 returns all snapshots for which you have create volume permissions.

\n

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a\n snapshot ID for which you do not have access, it is not included in the returned\n results.

\n

If you specify one or more snapshot owners using the OwnerIds option, only\n snapshots from the specified owners and for which you have access are returned. The results\n can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots\n owned by Amazon, or self for snapshots that you own.

\n

If you specify a list of restorable users, only snapshots with create snapshot permissions\n for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.

\n

If you are describing a long list of snapshots, we recommend that you paginate the output to make the\n list more manageable. For more information, see Pagination.

\n

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

\n

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.

", + "smithy.api#documentation": "

Describes the specified EBS snapshots available to you or all of the EBS snapshots\n available to you.

\n

The snapshots available to you include public snapshots, private snapshots that you own,\n and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume\n permissions.

\n

The create volume permissions fall into the following categories:

\n \n

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot\n owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, \n Amazon EC2 returns all snapshots for which you have create volume permissions.

\n

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a\n snapshot ID for which you do not have access, it is not included in the returned\n results.

\n

If you specify one or more snapshot owners using the OwnerIds option, only\n snapshots from the specified owners and for which you have access are returned. The results\n can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots\n owned by Amazon, or self for snapshots that you own.

\n

If you specify a list of restorable users, only snapshots with create snapshot permissions\n for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.

\n

If you are describing a long list of snapshots, we recommend that you paginate the output to make the\n list more manageable. For more information, see Pagination.

\n

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

\n

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n ", "smithy.api#examples": [ { "title": "To describe a snapshot", @@ -38620,7 +38626,7 @@ "target": "com.amazonaws.ec2#DescribeTagsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified tags for your EC2 resources.

\n

For more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide.

\n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#documentation": "

Describes the specified tags for your EC2 resources.

\n

For more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n \n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", "smithy.api#examples": [ { "title": "To describe the tags for a single resource", @@ -38675,7 +38681,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -40580,7 +40586,7 @@ "target": "com.amazonaws.ec2#DescribeVolumesResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified EBS volumes or all of your EBS volumes.

\n

If you are describing a long list of volumes, we recommend that you paginate the output to make the list\n more manageable. For more information, see Pagination.

\n

For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.

\n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#documentation": "

Describes the specified EBS volumes or all of your EBS volumes.

\n

If you are describing a long list of volumes, we recommend that you paginate the output to make the list\n more manageable. For more information, see Pagination.

\n

For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n \n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", "smithy.api#examples": [ { "title": "To describe all volumes", @@ -43400,6 +43406,56 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DisableImageDeregistrationProtection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableImageDeregistrationProtectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableImageDeregistrationProtectionResult" + }, + "traits": { + "smithy.api#documentation": "

Disables deregistration protection for an AMI. When deregistration protection is disabled,\n the AMI can be deregistered.

\n

If you chose to include a 24-hour cooldown period when you enabled deregistration\n protection for the AMI, then, when you disable deregistration protection, you won’t\n immediately be able to deregister the AMI.

\n

For more information, see Protect an\n AMI from deregistration in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DisableImageDeregistrationProtectionRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableImageDeregistrationProtectionResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DisableImageRequest": { "type": "structure", "members": { @@ -46793,6 +46849,62 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#EnableImageDeregistrationProtection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableImageDeregistrationProtectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableImageDeregistrationProtectionResult" + }, + "traits": { + "smithy.api#documentation": "

Enables deregistration protection for an AMI. When deregistration protection is enabled,\n the AMI can't be deregistered.

\n

To allow the AMI to be deregistered, you must first disable deregistration protection\n using DisableImageDeregistrationProtection.

\n

For more information, see Protect an\n AMI from deregistration in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#EnableImageDeregistrationProtectionRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "WithCooldown": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If true, enforces deregistration protection for 24 hours after deregistration\n protection is disabled.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableImageDeregistrationProtectionResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#EnableImageRequest": { "type": "structure", "members": { @@ -55850,6 +55962,22 @@ "smithy.api#documentation": "

The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using\n CreateImage.

", "smithy.api#xmlName": "sourceInstanceId" } + }, + "DeregistrationProtection": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeregistrationProtection", + "smithy.api#documentation": "

Indicates whether deregistration protection is enabled for the AMI.

", + "smithy.api#xmlName": "deregistrationProtection" + } + }, + "LastLaunchedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastLaunchedTime", + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the AMI was last used to launch an EC2 instance. When the AMI is used\n to launch an instance, there is a 24-hour delay before that usage is reported.

\n \n

\n lastLaunchedTime data is available starting April 2017.

\n ", + "smithy.api#xmlName": "lastLaunchedTime" + } } }, "traits": { @@ -55962,6 +56090,14 @@ "smithy.api#documentation": "

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.

", "smithy.api#xmlName": "imdsSupport" } + }, + "DeregistrationProtection": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "DeregistrationProtection", + "smithy.api#documentation": "

Indicates whether deregistration protection is enabled for the AMI.

", + "smithy.api#xmlName": "deregistrationProtection" + } } }, "traits": { @@ -56042,6 +56178,12 @@ "traits": { "smithy.api#enumValue": "imdsSupport" } + }, + "deregistrationProtection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deregistrationProtection" + } } } }, @@ -71450,24 +71592,24 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" } }, "Version": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The launch template version number, $Latest, or\n $Default.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.

\n

If the value is $Default, Amazon EC2 uses the default version of the\n launch template.

\n

Default: The default version of the launch template.

" + "smithy.api#documentation": "

The launch template version number, $Latest, or\n $Default.

\n

A value of $Latest uses the latest version of the launch template.

\n

A value of $Default uses the default version of the launch template.

\n

Default: The default version of the launch template.

" } } }, "traits": { - "smithy.api#documentation": "

The launch template to use. You must specify either the launch template ID or launch\n template name in the request, but not both.

" + "smithy.api#documentation": "

Describes the launch template to use.

" } }, "com.amazonaws.ec2#LaunchTemplateSpotMarketOptions": { @@ -75917,13 +76059,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template ID or the\n launch template name, but not both.

" } }, "DefaultVersion": { @@ -91960,7 +92102,7 @@ "LaunchTemplate": { "target": "com.amazonaws.ec2#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

The launch template to use to launch the instances. Any parameters that you specify in\n RunInstances override the same parameters in the launch template.\n You can specify either the name or ID of a launch template, but not both.

" + "smithy.api#documentation": "

The launch template. Any additional parameters that you specify for the new instance \n overwrite the corresponding parameters included in the launch template.

" } }, "InstanceMarketOptions": { diff --git a/codegen/sdk-codegen/aws-models/pi.json b/codegen/sdk-codegen/aws-models/pi.json index db344905939..ea55a498dd5 100644 --- a/codegen/sdk-codegen/aws-models/pi.json +++ b/codegen/sdk-codegen/aws-models/pi.json @@ -1096,7 +1096,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide\n specific dimension groups and dimensions, and provide aggregation and filtering criteria for\n each group.

\n \n

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, \n only the first 500 bytes are returned.

\n ", + "smithy.api#documentation": "

Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide\n specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for\n each metric.

\n \n

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, \n only the first 500 bytes are returned.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1124,7 +1124,7 @@ "MetricQueries": { "target": "com.amazonaws.pi#MetricQueryList", "traits": { - "smithy.api#documentation": "

An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering\n criteria.

", + "smithy.api#documentation": "

An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering\n criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load \n you must use db.load.avg. Valid values for aggregate functions include .avg, .min, \n .max, and .sum.

", "smithy.api#required": {} } }, @@ -1742,7 +1742,7 @@ "Metric": { "target": "com.amazonaws.pi#RequestString", "traits": { - "smithy.api#documentation": "

The name of a Performance Insights metric to be measured.

\n

Valid values for Metric are:

\n \n

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same\n value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the\n scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than\n db.load.avg. For most use cases, you can query db.load.avg only.

", + "smithy.api#documentation": "

The name of a Performance Insights metric to be measured.

\n

Valid values for Metric are:

\n \n

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same\n value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the\n scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than\n db.load.avg. For most use cases, you can query db.load.avg only.

", "smithy.api#required": {} } }, @@ -1760,7 +1760,7 @@ } }, "traits": { - "smithy.api#documentation": "

A single query to be processed. You must provide the metric to query. If no other\n parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can\n request that the data points be aggregated by dimension group (GroupBy), and return only \n those data points that match your criteria (Filter).

" + "smithy.api#documentation": "

A single query to be processed. You must provide the metric to query and append an aggregate function to the metric.\n For example, to find the average for the metric db.load \n you must use db.load.avg. Valid values for aggregate functions include .avg, .min, \n .max, and .sum.\n If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can\n request that the data points be aggregated by dimension group (GroupBy), and return only \n those data points that match your criteria (Filter).

" } }, "com.amazonaws.pi#MetricQueryFilterMap": { @@ -1953,7 +1953,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1996,7 +1995,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2009,7 +2009,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2023,7 +2022,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2046,7 +2044,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2081,7 +2078,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -2092,14 +2088,16 @@ }, "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": [ @@ -2113,14 +2111,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -2129,11 +2125,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -2144,14 +2140,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2165,7 +2163,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2185,7 +2182,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -2196,14 +2192,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -2214,9 +2212,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -2944,7 +2944,7 @@ "Metric": { "target": "com.amazonaws.pi#String", "traits": { - "smithy.api#documentation": "

The name of a Performance Insights metric to be measured.

\n

Valid values for Metric are:

\n \n

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and \n db.sampledload.avg are the same value. If the number of active sessions is greater than the \n internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, \n db.sampledload.avg showing the raw values, and db.sampledload.avg less \n than db.load.avg. For most use cases, you can query db.load.avg only.\n

", + "smithy.api#documentation": "

The name of a Performance Insights metric to be measured.

\n

Valid values for Metric are:

\n \n

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and \n db.sampledload.avg are the same value. If the number of active sessions is greater than the \n internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, \n db.sampledload.avg showing the raw values, and db.sampledload.avg less \n than db.load.avg. For most use cases, you can query db.load.avg only.\n

", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 97f337ed4c5..589480531c8 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -20988,7 +20988,7 @@ "ResourceArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance.\n For example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance.\n For example, arn:aws:rds:us-east-1:12345667890:db:my-orcl-db.

" } }, "AuditPolicyState": { diff --git a/codegen/sdk-codegen/aws-models/workspaces-web.json b/codegen/sdk-codegen/aws-models/workspaces-web.json index be9e68daed8..15865eb8b10 100644 --- a/codegen/sdk-codegen/aws-models/workspaces-web.json +++ b/codegen/sdk-codegen/aws-models/workspaces-web.json @@ -108,7 +108,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -151,7 +150,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -164,7 +164,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -178,7 +177,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -201,7 +199,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -236,7 +233,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -247,14 +243,16 @@ }, "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": [ @@ -268,14 +266,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -284,11 +280,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -299,14 +295,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -320,7 +318,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -340,7 +337,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -351,14 +347,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -369,9 +367,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1296,6 +1296,18 @@ "traits": { "smithy.api#documentation": "

A JSON string containing Chrome Enterprise policies that will be applied to all\n streaming sessions.

" } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "

The customer managed key used to encrypt sensitive information in the browser settings.

" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "

The additional encryption context of the browser settings.

" + } } }, "traits": { @@ -1551,7 +1563,8 @@ "min": 0, "max": 253 }, - "smithy.api#pattern": "^(\\.?)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$" + "smithy.api#pattern": "^(\\.?)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$", + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#CookieName": { @@ -1560,7 +1573,8 @@ "smithy.api#length": { "min": 0, "max": 4096 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#CookiePath": { @@ -1570,7 +1584,8 @@ "min": 0, "max": 2000 }, - "smithy.api#pattern": "^/(\\S)*$" + "smithy.api#pattern": "^/(\\S)*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#CookieSpecification": { @@ -1706,7 +1721,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

", "smithy.api#idempotencyToken": {} } } @@ -1797,14 +1812,14 @@ "identityProviderDetails": { "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "

The identity provider details. The following list describes the provider detail keys for\n each identity provider type.

\n ", + "smithy.api#documentation": "

The identity provider details. The following list describes the provider detail keys for\n each identity provider type.

\n ", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } } @@ -1909,7 +1924,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } } @@ -2004,7 +2019,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } } @@ -2099,14 +2114,26 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } }, "authenticationType": { "target": "com.amazonaws.workspacesweb#AuthenticationType", "traits": { - "smithy.api#documentation": "

The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.

\n

\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.

\n

\n IAM_Identity_Center web portals are authenticated through AWS IAM Identity\n Center (successor to AWS Single Sign-On). They provide additional features, such as\n IdP-initiated authentication. Identity sources (including external identity provider\n integration), plus user and group access to your web portal, can be configured in the IAM\n Identity Center.

" + "smithy.api#documentation": "

The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.

\n

\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.

\n

\n IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including\n external identity provider integration), plus user and group access to your web portal,\n can be configured in the IAM Identity Center.

" + } + }, + "instanceType": { + "target": "com.amazonaws.workspacesweb#InstanceType", + "traits": { + "smithy.api#documentation": "

The type and resources of the underlying instance.

" + } + }, + "maxConcurrentSessions": { + "target": "com.amazonaws.workspacesweb#MaxConcurrentSessions", + "traits": { + "smithy.api#documentation": "

The maximum number of concurrent sessions for the portal.

" } } }, @@ -2193,7 +2220,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } } @@ -2274,7 +2301,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } } @@ -2397,7 +2424,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } }, @@ -4023,7 +4050,7 @@ "identityProviderDetails": { "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "

The identity provider details. The following list describes the provider detail keys for\n each identity provider type.

\n " + "smithy.api#documentation": "

The identity provider details. The following list describes the provider detail keys for\n each identity provider type.

\n " } } }, @@ -4174,6 +4201,25 @@ } } }, + "com.amazonaws.workspacesweb#InstanceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "standard.regular", + "name": "STANDARD_REGULAR" + }, + { + "value": "standard.large", + "name": "STANDARD_LARGE" + }, + { + "value": "standard.xlarge", + "name": "STANDARD_XLARGE" + } + ] + } + }, "com.amazonaws.workspacesweb#InternalServerException": { "type": "structure", "members": { @@ -4235,6 +4281,18 @@ "traits": { "smithy.api#documentation": "

The creation date timestamp of the IP access settings.

" } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "

The customer managed key used to encrypt sensitive information in the IP access settings.

" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "

The additional encryption context of the IP access settings.

" + } } }, "traits": { @@ -5205,6 +5263,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspacesweb#MaxConcurrentSessions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5000 + } + } + }, "com.amazonaws.workspacesweb#MaxResults": { "type": "integer", "traits": { @@ -5429,7 +5496,7 @@ "authenticationType": { "target": "com.amazonaws.workspacesweb#AuthenticationType", "traits": { - "smithy.api#documentation": "

The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.

\n

\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.

\n

\n IAM_Identity_Center web portals are authenticated through AWS IAM Identity\n Center (successor to AWS Single Sign-On). They provide additional features, such as\n IdP-initiated authentication. Identity sources (including external identity provider\n integration), plus user and group access to your web portal, can be configured in the IAM\n Identity Center.

" + "smithy.api#documentation": "

The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.

\n

\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.

\n

\n IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including\n external identity provider integration), plus user and group access to your web portal,\n can be configured in the IAM Identity Center.

" } }, "ipAccessSettingsArn": { @@ -5437,6 +5504,30 @@ "traits": { "smithy.api#documentation": "

The ARN of the IP access settings.

" } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "

The customer managed key used to encrypt sensitive information in the portal.

" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "

The additional encryption context of the portal.

" + } + }, + "instanceType": { + "target": "com.amazonaws.workspacesweb#InstanceType", + "traits": { + "smithy.api#documentation": "

The type and resources of the underlying instance.

" + } + }, + "maxConcurrentSessions": { + "target": "com.amazonaws.workspacesweb#MaxConcurrentSessions", + "traits": { + "smithy.api#documentation": "

The maximum number of concurrent sessions for the portal.

" + } } }, "traits": { @@ -5520,6 +5611,12 @@ }, "additionalEncryptionContext": { "target": "com.amazonaws.workspacesweb#EncryptionContextMap" + }, + "instanceType": { + "target": "com.amazonaws.workspacesweb#InstanceType" + }, + "maxConcurrentSessions": { + "target": "com.amazonaws.workspacesweb#MaxConcurrentSessions" } }, "create": { @@ -5700,7 +5797,7 @@ "authenticationType": { "target": "com.amazonaws.workspacesweb#AuthenticationType", "traits": { - "smithy.api#documentation": "

The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.

\n

\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.

\n

\n IAM_Identity_Center web portals are authenticated through AWS IAM Identity\n Center (successor to AWS Single Sign-On). They provide additional features, such as\n IdP-initiated authentication. Identity sources (including external identity provider\n integration), plus user and group access to your web portal, can be configured in the IAM\n Identity Center.

" + "smithy.api#documentation": "

The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.

\n

\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.

\n

\n IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including\n external identity provider integration), plus user and group access to your web portal,\n can be configured in the IAM Identity Center.

" } }, "ipAccessSettingsArn": { @@ -5708,6 +5805,18 @@ "traits": { "smithy.api#documentation": "

The ARN of the IP access settings.

" } + }, + "instanceType": { + "target": "com.amazonaws.workspacesweb#InstanceType", + "traits": { + "smithy.api#documentation": "

The type and resources of the underlying instance.

" + } + }, + "maxConcurrentSessions": { + "target": "com.amazonaws.workspacesweb#MaxConcurrentSessions", + "traits": { + "smithy.api#documentation": "

The maximum number of concurrent sessions for the portal.

" + } } }, "traits": { @@ -6008,7 +6117,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } } @@ -6309,7 +6418,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } } @@ -6394,13 +6503,13 @@ "identityProviderDetails": { "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "

The details of the identity provider. The following list describes the provider detail keys for\n each identity provider type.

\n " + "smithy.api#documentation": "

The details of the identity provider. The following list describes the provider detail keys for\n each identity provider type.

\n " } }, "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } } @@ -6491,7 +6600,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } } @@ -6582,7 +6691,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } } @@ -6628,6 +6737,9 @@ { "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" }, + { + "target": "com.amazonaws.workspacesweb#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.workspacesweb#ThrottlingException" }, @@ -6665,7 +6777,19 @@ "authenticationType": { "target": "com.amazonaws.workspacesweb#AuthenticationType", "traits": { - "smithy.api#documentation": "

The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.

\n

\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.

\n

\n IAM_Identity_Center web portals are authenticated through AWS IAM Identity\n Center (successor to AWS Single Sign-On). They provide additional features, such as\n IdP-initiated authentication. Identity sources (including external identity provider\n integration), plus user and group access to your web portal, can be configured in the IAM\n Identity Center.

" + "smithy.api#documentation": "

The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.

\n

\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.

\n

\n IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including\n external identity provider integration), plus user and group access to your web portal,\n can be configured in the IAM Identity Center.

" + } + }, + "instanceType": { + "target": "com.amazonaws.workspacesweb#InstanceType", + "traits": { + "smithy.api#documentation": "

The type and resources of the underlying instance.

" + } + }, + "maxConcurrentSessions": { + "target": "com.amazonaws.workspacesweb#MaxConcurrentSessions", + "traits": { + "smithy.api#documentation": "

The maximum number of concurrent sessions for the portal.

" } } }, @@ -6753,7 +6877,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } } @@ -6831,7 +6955,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } } @@ -6948,7 +7072,7 @@ "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the AWS\n SDK.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services\n SDK.

", "smithy.api#idempotencyToken": {} } }, @@ -7147,6 +7271,18 @@ "traits": { "smithy.api#documentation": "

The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

" } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "

The customer managed key used to encrypt sensitive information in the user settings.

" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "

The additional encryption context of the user settings.

" + } } }, "traits": {