The model must request at least one tool (no text is generated).
" + "smithy.api#documentation": "The model must request at least one tool (no text is generated). For example, {\"any\" : {}}.
The Model automatically decides if a tool should be called or to whether to generate text instead.
" + "smithy.api#documentation": "The Model automatically decides if a tool should be called or whether to generate text instead.\n For example, {\"auto\" : {}}.
The result for a tool request that a model makes.
" } + }, + "guardContent": { + "target": "com.amazonaws.bedrockruntime#GuardrailConverseContentBlock", + "traits": { + "smithy.api#documentation": "Contains the content to assess with the guardrail. If you don't specify\n guardContent in a call to the Converse API, the guardrail (if passed in the\n Converse API) assesses the entire message.
For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.\n\n
" + } } }, "traits": { - "smithy.api#documentation": "A block of content for a message.
" + "smithy.api#documentation": "A block of content for a message that you pass to, or receive from, a model with the Converse API (Converse and ConverseStream).
" } }, "com.amazonaws.bedrockruntime#ContentBlockDelta": { @@ -933,7 +939,7 @@ } ], "traits": { - "smithy.api#documentation": "Sends messages to the specified Amazon Bedrock model. Converse provides\n a consistent interface that works with all models that\n support messages. This allows you to write code once and use it with different models.\n Should a model have unique inference parameters, you can also pass those unique parameters\n to the model. For more information, see Run inference in the Bedrock User Guide.
This operation requires permission for the bedrock:InvokeModel action.
Sends messages to the specified Amazon Bedrock model. Converse provides\n a consistent interface that works with all models that\n support messages. This allows you to write code once and use it with different models.\n Should a model have unique inference parameters, you can also pass those unique parameters\n to the model.
For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide.\n To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.\n To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide\n
\nFor example code, see Converse API examples in the Amazon Bedrock User Guide.\n
\nThis operation requires permission for the bedrock:InvokeModel action.
Configuration information for the tools that the model can use when generating a response.
\nThis field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.
\nConfiguration information for a guardrail that you want to use in the request.
" + } + }, "additionalModelRequestFields": { "target": "smithy.api#Document", "traits": { @@ -1015,7 +1027,7 @@ "additionalModelResponseFieldPaths": { "target": "com.amazonaws.bedrockruntime#AdditionalModelResponseFieldPaths", "traits": { - "smithy.api#documentation": "Additional model parameters field paths to return in the\n response. Converse returns the requested fields as a JSON Pointer object in the\n additionalModelResultFields field. The following is example JSON for additionalModelResponseFieldPaths.
\n [\n \"/stop_sequence\"\n ]\n
For information about the JSON Pointer syntax, see the\n Internet Engineering Task Force (IETF) documentation.
\n\n Converse rejects an empty JSON Pointer or incorrectly structured\n JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested\n field is not in the model response, it is ignored by Converse.
Additional model parameters field paths to return in the\n response. Converse returns the requested fields as a JSON Pointer object in the\n additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.
\n [\n \"/stop_sequence\"\n ]\n
For information about the JSON Pointer syntax, see the\n Internet Engineering Task Force (IETF) documentation.
\n\n Converse rejects an empty JSON Pointer or incorrectly structured\n JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested\n field is not in the model response, it is ignored by Converse.
Metrics for the call to Converse.
Additional fields in the response that are unique to the model.
" + } + }, + "trace": { + "target": "com.amazonaws.bedrockruntime#ConverseTrace", + "traits": { + "smithy.api#documentation": "A trace object that contains information about the Guardrail behavior.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockruntime#ConverseStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockruntime#ConverseStreamRequest" + }, + "output": { + "target": "com.amazonaws.bedrockruntime#ConverseStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelErrorException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelNotReadyException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelTimeoutException" + }, + { + "target": "com.amazonaws.bedrockruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sends messages to the specified Amazon Bedrock model and returns\n the response in a stream. ConverseStream provides a consistent API\n that works with all Amazon Bedrock models that support messages.\n This allows you to write code once and use it with different models. Should a\n model have unique inference parameters, you can also pass those unique parameters to the\n model.
To find out if a model supports streaming, call GetFoundationModel\n and check the responseStreamingSupported field in the response.
For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide.\n To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.\n To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide\n
\nFor example code, see Conversation streaming example in the Amazon Bedrock User Guide.\n
\nThis operation requires permission for the bedrock:InvokeModelWithResponseStream action.
Usage information for the conversation stream event.
", + "smithy.api#required": {} + } + }, + "metrics": { + "target": "com.amazonaws.bedrockruntime#ConverseStreamMetrics", + "traits": { + "smithy.api#documentation": "The metrics for the conversation stream metadata event.
", + "smithy.api#required": {} + } + }, + "trace": { + "target": "com.amazonaws.bedrockruntime#ConverseStreamTrace", + "traits": { + "smithy.api#documentation": "The trace object in the response from ConverseStream that contains information about the guardrail behavior.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A conversation stream metadata event.
" + } + }, + "com.amazonaws.bedrockruntime#ConverseStreamMetrics": { + "type": "structure", + "members": { + "latencyMs": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The latency for the streaming request, in milliseconds.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Metrics for the stream.
" + } + }, + "com.amazonaws.bedrockruntime#ConverseStreamOutput": { + "type": "union", + "members": { + "messageStart": { + "target": "com.amazonaws.bedrockruntime#MessageStartEvent", + "traits": { + "smithy.api#documentation": "Message start information.
" + } + }, + "contentBlockStart": { + "target": "com.amazonaws.bedrockruntime#ContentBlockStartEvent", + "traits": { + "smithy.api#documentation": "Start information for a content block.
" + } + }, + "contentBlockDelta": { + "target": "com.amazonaws.bedrockruntime#ContentBlockDeltaEvent", + "traits": { + "smithy.api#documentation": "The messages output content block delta.
" + } + }, + "contentBlockStop": { + "target": "com.amazonaws.bedrockruntime#ContentBlockStopEvent", + "traits": { + "smithy.api#documentation": "Stop information for a content block.
" + } + }, + "messageStop": { + "target": "com.amazonaws.bedrockruntime#MessageStopEvent", + "traits": { + "smithy.api#documentation": "Message stop information.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockruntime#ConverseStreamMetadataEvent", + "traits": { + "smithy.api#documentation": "Metadata for the converse output stream.
" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "An internal server error occurred. Retry your request.
" + } + }, + "modelStreamErrorException": { + "target": "com.amazonaws.bedrockruntime#ModelStreamErrorException", + "traits": { + "smithy.api#documentation": "A streaming error occurred. Retry your request.
" + } + }, + "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", + "traits": { + "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The messages output stream
", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockruntime#ConverseStreamRequest": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockruntime#ConversationalModelId", + "traits": { + "smithy.api#documentation": "The ID for the model.
\nThe modelId to provide depends on the type of model that you use:
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
\nIf you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
\nIf you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
\nThe messages that you want to send to the model.
", + "smithy.api#required": {} + } + }, + "system": { + "target": "com.amazonaws.bedrockruntime#SystemContentBlocks", + "traits": { + "smithy.api#documentation": "A system prompt to send to the model.
" + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrockruntime#InferenceConfiguration", + "traits": { + "smithy.api#documentation": "Inference parameters to pass to the model. ConverseStream supports a base\n set of inference parameters. If you need to pass additional parameters that the model\n supports, use the additionalModelRequestFields request field.
Configuration information for the tools that the model can use when generating a response.
\nThis field is only supported by Anthropic Claude 3 models.
\nConfiguration information for a guardrail that you want to use in the request.
" + } + }, + "additionalModelRequestFields": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Additional inference parameters that the model supports, beyond the\n base set of inference parameters that ConverseStream supports in the inferenceConfig\n field.
Additional model parameters field paths to return in the\n response. ConverseStream returns the requested fields as a JSON Pointer object in the\n additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.
\n [\n \"/stop_sequence\"\n ]\n
For information about the JSON Pointer syntax, see the\n Internet Engineering Task Force (IETF) documentation.
\n\n ConverseStream rejects an empty JSON Pointer or incorrectly structured\n JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested\n field is not in the model response, it is ignored by ConverseStream.
The output stream that the model generated.
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockruntime#ConverseStreamTrace": { + "type": "structure", + "members": { + "guardrail": { + "target": "com.amazonaws.bedrockruntime#GuardrailTraceAssessment", + "traits": { + "smithy.api#documentation": "The guardrail trace object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The trace object in a response from ConverseStream. Currently, you can only trace guardrails.
" + } + }, + "com.amazonaws.bedrockruntime#ConverseTrace": { + "type": "structure", + "members": { + "guardrail": { + "target": "com.amazonaws.bedrockruntime#GuardrailTraceAssessment", + "traits": { + "smithy.api#documentation": "The guardrail trace object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The trace object in a response from Converse. Currently, you can only trace guardrails.
" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAssessment": { + "type": "structure", + "members": { + "topicPolicy": { + "target": "com.amazonaws.bedrockruntime#GuardrailTopicPolicyAssessment", + "traits": { + "smithy.api#documentation": "The topic policy.
" + } + }, + "contentPolicy": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentPolicyAssessment", + "traits": { + "smithy.api#documentation": "The content policy.
" + } + }, + "wordPolicy": { + "target": "com.amazonaws.bedrockruntime#GuardrailWordPolicyAssessment", + "traits": { + "smithy.api#documentation": "The word policy.
" + } + }, + "sensitiveInformationPolicy": { + "target": "com.amazonaws.bedrockruntime#GuardrailSensitiveInformationPolicyAssessment", + "traits": { + "smithy.api#documentation": "The sensitive information policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A behavior assessment of the guardrail policies used in a call to the Converse API.
" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAssessmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailAssessment" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAssessmentListMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.bedrockruntime#GuardrailAssessmentList" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAssessmentMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.bedrockruntime#GuardrailAssessment" + } + }, + "com.amazonaws.bedrockruntime#GuardrailConfiguration": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockruntime#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for the guardrail.
", + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrockruntime#GuardrailVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#required": {} + } + }, + "trace": { + "target": "com.amazonaws.bedrockruntime#GuardrailTrace", + "traits": { + "smithy.api#default": "disabled", + "smithy.api#documentation": "The trace behavior for the guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information for a guardrail that you use with the Converse action.
" + } + }, + "com.amazonaws.bedrockruntime#GuardrailContentFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentFilterType", + "traits": { + "smithy.api#documentation": "The guardrail type.
", + "smithy.api#required": {} + } + }, + "confidence": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentFilterConfidence", + "traits": { + "smithy.api#documentation": "The guardrail confidence.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentPolicyAction", + "traits": { + "smithy.api#documentation": "The guardrail action.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The content filter for a guardrail.
" + } + }, + "com.amazonaws.bedrockruntime#GuardrailContentFilterConfidence": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailContentFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentFilter" + } + }, + "com.amazonaws.bedrockruntime#GuardrailContentFilterType": { + "type": "enum", + "members": { + "INSULTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSULTS" + } + }, + "HATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HATE" + } + }, + "SEXUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEXUAL" + } + }, + "VIOLENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIOLENCE" + } + }, + "MISCONDUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISCONDUCT" + } + }, + "PROMPT_ATTACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROMPT_ATTACK" + } + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailContentPolicyAction": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailContentPolicyAssessment": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentFilterList", + "traits": { + "smithy.api#documentation": "The content policy filters.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An assessment of a content policy for a guardrail.
" + } + }, + "com.amazonaws.bedrockruntime#GuardrailConverseContentBlock": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockruntime#GuardrailConverseTextBlock", + "traits": { + "smithy.api#documentation": "The text to guard.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nA content block for selective guarding with the Converse API (Converse and ConverseStream).\n
" + } + }, + "com.amazonaws.bedrockruntime#GuardrailConverseTextBlock": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The text that you want to guard.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A text block that contains text that you want to assess with a guardrail. For more information, see GuardrailConverseContentBlock.
" + } + }, + "com.amazonaws.bedrockruntime#GuardrailCustomWord": { + "type": "structure", + "members": { + "match": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The match for the custom word.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrockruntime#GuardrailWordPolicyAction", + "traits": { + "smithy.api#documentation": "The action for the custom word.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A custom word configured in a guardrail.
" + } + }, + "com.amazonaws.bedrockruntime#GuardrailCustomWordList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailCustomWord" + } + }, + "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#GuardrailManagedWord": { + "type": "structure", + "members": { + "match": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The match for the managed word.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockruntime#GuardrailManagedWordType", + "traits": { + "smithy.api#documentation": "The type for the managed word.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrockruntime#GuardrailWordPolicyAction", + "traits": { + "smithy.api#documentation": "The action for the managed word.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A managed word configured in a guardrail.
" + } + }, + "com.amazonaws.bedrockruntime#GuardrailManagedWordList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailManagedWord" + } + }, + "com.amazonaws.bedrockruntime#GuardrailManagedWordType": { + "type": "enum", + "members": { + "PROFANITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFANITY" + } + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailOutputText": { + "type": "string" + }, + "com.amazonaws.bedrockruntime#GuardrailPiiEntityFilter": { + "type": "structure", + "members": { + "match": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PII entity filter match.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockruntime#GuardrailPiiEntityType", + "traits": { + "smithy.api#documentation": "The PII entity filter type.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrockruntime#GuardrailSensitiveInformationPolicyAction", + "traits": { + "smithy.api#documentation": "The PII entity filter action.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A Personally Identifiable Information (PII) entity configured in a guardrail.
" + } + }, + "com.amazonaws.bedrockruntime#GuardrailPiiEntityFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailPiiEntityFilter" + } + }, + "com.amazonaws.bedrockruntime#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.bedrockruntime#GuardrailRegexFilter": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The regex filter name.
" + } + }, + "match": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The regesx filter match.
" + } + }, + "regex": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Metrics for the call to Converse.
The regex query.
" } }, - "additionalModelResponseFields": { - "target": "smithy.api#Document", + "action": { + "target": "com.amazonaws.bedrockruntime#GuardrailSensitiveInformationPolicyAction", "traits": { - "smithy.api#documentation": "Additional fields in the response that are unique to the model.
" + "smithy.api#documentation": "The region filter action.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "A Regex filter configured in a guardrail.
" } }, - "com.amazonaws.bedrockruntime#ConverseStream": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockruntime#ConverseStreamRequest" - }, - "output": { - "target": "com.amazonaws.bedrockruntime#ConverseStreamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockruntime#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockruntime#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockruntime#ModelErrorException" - }, - { - "target": "com.amazonaws.bedrockruntime#ModelNotReadyException" - }, - { - "target": "com.amazonaws.bedrockruntime#ModelTimeoutException" - }, - { - "target": "com.amazonaws.bedrockruntime#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockruntime#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockruntime#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Sends messages to the specified Amazon Bedrock model and returns\n the response in a stream. ConverseStream provides a consistent API\n that works with all Amazon Bedrock models that support messages.\n This allows you to write code once and use it with different models. Should a\n model have unique inference parameters, you can also pass those unique parameters to the\n model. For more information, see Run inference in the Bedrock User Guide.
To find out if a model supports streaming, call GetFoundationModel\n and check the responseStreamingSupported field in the response.
For example code, see Invoke model with streaming code\n example in the Amazon Bedrock User Guide.\n
\nThis operation requires permission for the bedrock:InvokeModelWithResponseStream action.
Usage information for the conversation stream event.
", - "smithy.api#required": {} + "smithy.api#enumValue": "ANONYMIZED" } }, - "metrics": { - "target": "com.amazonaws.bedrockruntime#ConverseStreamMetrics", + "BLOCKED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The metrics for the conversation stream metadata event.
", - "smithy.api#required": {} + "smithy.api#enumValue": "BLOCKED" } } - }, - "traits": { - "smithy.api#documentation": "A conversation stream metadata event.
" } }, - "com.amazonaws.bedrockruntime#ConverseStreamMetrics": { + "com.amazonaws.bedrockruntime#GuardrailSensitiveInformationPolicyAssessment": { "type": "structure", "members": { - "latencyMs": { - "target": "smithy.api#Long", + "piiEntities": { + "target": "com.amazonaws.bedrockruntime#GuardrailPiiEntityFilterList", "traits": { - "smithy.api#documentation": "The latency for the streaming request, in milliseconds.
", + "smithy.api#documentation": "The PII entities in the assessment.
", + "smithy.api#required": {} + } + }, + "regexes": { + "target": "com.amazonaws.bedrockruntime#GuardrailRegexFilterList", + "traits": { + "smithy.api#documentation": "The regex queries in the assessment.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Metrics for the stream.
" + "smithy.api#documentation": "The assessment for aPersonally Identifiable Information (PII) policy.
" } }, - "com.amazonaws.bedrockruntime#ConverseStreamOutput": { - "type": "union", + "com.amazonaws.bedrockruntime#GuardrailStreamConfiguration": { + "type": "structure", "members": { - "messageStart": { - "target": "com.amazonaws.bedrockruntime#MessageStartEvent", - "traits": { - "smithy.api#documentation": "Message start information.
" - } - }, - "contentBlockStart": { - "target": "com.amazonaws.bedrockruntime#ContentBlockStartEvent", + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockruntime#GuardrailIdentifier", "traits": { - "smithy.api#documentation": "Start information for a content block.
" + "smithy.api#documentation": "The identifier for the guardrail.
", + "smithy.api#required": {} } }, - "contentBlockDelta": { - "target": "com.amazonaws.bedrockruntime#ContentBlockDeltaEvent", + "guardrailVersion": { + "target": "com.amazonaws.bedrockruntime#GuardrailVersion", "traits": { - "smithy.api#documentation": "The messages output content block delta.
" + "smithy.api#documentation": "The version of the guardrail.
", + "smithy.api#required": {} } }, - "contentBlockStop": { - "target": "com.amazonaws.bedrockruntime#ContentBlockStopEvent", + "trace": { + "target": "com.amazonaws.bedrockruntime#GuardrailTrace", "traits": { - "smithy.api#documentation": "Stop information for a content block.
" + "smithy.api#default": "disabled", + "smithy.api#documentation": "The trace behavior for the guardrail.
" } }, - "messageStop": { - "target": "com.amazonaws.bedrockruntime#MessageStopEvent", + "streamProcessingMode": { + "target": "com.amazonaws.bedrockruntime#GuardrailStreamProcessingMode", "traits": { - "smithy.api#documentation": "Message stop information.
" + "smithy.api#default": "sync", + "smithy.api#documentation": "The processing mode.
\nThe processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.\n
" } - }, - "metadata": { - "target": "com.amazonaws.bedrockruntime#ConverseStreamMetadataEvent", + } + }, + "traits": { + "smithy.api#documentation": "Configuration information for a guardrail that you use with the ConverseStream action.\n
" + } + }, + "com.amazonaws.bedrockruntime#GuardrailStreamProcessingMode": { + "type": "enum", + "members": { + "SYNC": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Metadata for the converse output stream.
" + "smithy.api#enumValue": "sync" } }, - "internalServerException": { - "target": "com.amazonaws.bedrockruntime#InternalServerException", + "ASYNC": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "An internal server error occurred. Retry your request.
" + "smithy.api#enumValue": "async" } - }, - "modelStreamErrorException": { - "target": "com.amazonaws.bedrockruntime#ModelStreamErrorException", + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailTopic": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "A streaming error occurred. Retry your request.
" + "smithy.api#documentation": "The name for the guardrail.
", + "smithy.api#required": {} } }, - "validationException": { - "target": "com.amazonaws.bedrockruntime#ValidationException", + "type": { + "target": "com.amazonaws.bedrockruntime#GuardrailTopicType", "traits": { - "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
" + "smithy.api#documentation": "The type behavior that the guardrail should perform when the model detects the topic.
", + "smithy.api#required": {} } }, - "throttlingException": { - "target": "com.amazonaws.bedrockruntime#ThrottlingException", + "action": { + "target": "com.amazonaws.bedrockruntime#GuardrailTopicPolicyAction", "traits": { - "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
" + "smithy.api#documentation": "The action the guardrail should take when it intervenes on a topic.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The messages output stream
", - "smithy.api#streaming": {} + "smithy.api#documentation": "Information about a topic guardrail.
" } }, - "com.amazonaws.bedrockruntime#ConverseStreamRequest": { + "com.amazonaws.bedrockruntime#GuardrailTopicList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailTopic" + } + }, + "com.amazonaws.bedrockruntime#GuardrailTopicPolicyAction": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailTopicPolicyAssessment": { "type": "structure", "members": { - "modelId": { - "target": "com.amazonaws.bedrockruntime#ConversationalModelId", + "topics": { + "target": "com.amazonaws.bedrockruntime#GuardrailTopicList", "traits": { - "smithy.api#documentation": "The ID for the model.
\nThe modelId to provide depends on the type of model that you use:
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
\nIf you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
\nIf you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
\nThe topics in the assessment.
", "smithy.api#required": {} } - }, - "messages": { - "target": "com.amazonaws.bedrockruntime#Messages", + } + }, + "traits": { + "smithy.api#documentation": "A behavior assessment of a topic policy.
" + } + }, + "com.amazonaws.bedrockruntime#GuardrailTopicType": { + "type": "enum", + "members": { + "DENY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The messages that you want to send to the model.
", - "smithy.api#required": {} + "smithy.api#enumValue": "DENY" } - }, - "system": { - "target": "com.amazonaws.bedrockruntime#SystemContentBlocks", + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailTrace": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A system prompt to send to the model.
" + "smithy.api#enumValue": "enabled" } }, - "inferenceConfig": { - "target": "com.amazonaws.bedrockruntime#InferenceConfiguration", + "DISABLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Inference parameters to pass to the model. ConverseStream supports a base\n set of inference parameters. If you need to pass additional parameters that the model\n supports, use the additionalModelRequestFields request field.
Configuration information for the tools that the model can use when generating a response.
\nThis field is only supported by Anthropic Claude 3 models.
\nThe output from the model.
" } }, - "additionalModelRequestFields": { - "target": "smithy.api#Document", + "inputAssessment": { + "target": "com.amazonaws.bedrockruntime#GuardrailAssessmentMap", "traits": { - "smithy.api#documentation": "Additional inference parameters that the model supports, beyond the\n base set of inference parameters that ConverseStream supports in the inferenceConfig\n field.
The input assessment.
" } }, - "additionalModelResponseFieldPaths": { - "target": "com.amazonaws.bedrockruntime#AdditionalModelResponseFieldPaths", + "outputAssessments": { + "target": "com.amazonaws.bedrockruntime#GuardrailAssessmentListMap", "traits": { - "smithy.api#documentation": "Additional model parameters field paths to return in the\n response. ConverseStream returns the requested fields as a JSON Pointer object in the\n additionalModelResultFields field. The following is example JSON for additionalModelResponseFieldPaths.
\n [\n \"/stop_sequence\"\n ]\n
For information about the JSON Pointer syntax, see the\n Internet Engineering Task Force (IETF) documentation.
\n\n ConverseStream rejects an empty JSON Pointer or incorrectly structured\n JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested\n field is not in the model response, it is ignored by ConverseStream.
the output assessments.
" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "A Top level guardrail trace object. For more information, see ConverseTrace.
" } }, - "com.amazonaws.bedrockruntime#ConverseStreamResponse": { - "type": "structure", + "com.amazonaws.bedrockruntime#GuardrailVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" + } + }, + "com.amazonaws.bedrockruntime#GuardrailWordPolicyAction": { + "type": "enum", "members": { - "stream": { - "target": "com.amazonaws.bedrockruntime#ConverseStreamOutput", + "BLOCKED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The output stream that the model generated.
", - "smithy.api#httpPayload": {} + "smithy.api#enumValue": "BLOCKED" } } - }, - "traits": { - "smithy.api#output": {} } }, - "com.amazonaws.bedrockruntime#GuardrailIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 + "com.amazonaws.bedrockruntime#GuardrailWordPolicyAssessment": { + "type": "structure", + "members": { + "customWords": { + "target": "com.amazonaws.bedrockruntime#GuardrailCustomWordList", + "traits": { + "smithy.api#documentation": "Custom words in the assessment.
", + "smithy.api#required": {} + } }, - "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", + "managedWordLists": { + "target": "com.amazonaws.bedrockruntime#GuardrailManagedWordList", + "traits": { + "smithy.api#documentation": "Managed word lists in the assessment.
", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" + "smithy.api#documentation": "The word policy assessment.
" } }, "com.amazonaws.bedrockruntime#ImageBlock": { @@ -1377,7 +2262,7 @@ "maxTokens": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The maximum number of tokens to allow in the generated response. The default value is\n the maximum allowed value for the model that you are using. For more information, see\n Inference parameters for foundatio{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": [\n {\n \"text\": \"what's the weather in Queens, NY and Austin, TX?\"\n }\n ]\n },\n {\n \"role\": \"assistant\",\n \"content\": [\n {\n \"toolUse\": {\n \"toolUseId\": \"1\",\n \"name\": \"get_weather\",\n \"input\": {\n \"city\": \"Queens\",\n \"state\": \"NY\"\n }\n }\n },\n {\n \"toolUse\": {\n \"toolUseId\": \"2\",\n \"name\": \"get_weather\",\n \"input\": {\n \"city\": \"Austin\",\n \"state\": \"TX\"\n }\n }\n }\n ]\n },\n {\n \"role\": \"user\",\n \"content\": [\n {\n \"toolResult\": {\n \"toolUseId\": \"2\",\n \"content\": [\n {\n \"json\": {\n \"weather\": \"40\"\n }\n }\n ]\n }\n },\n {\n \"text\": \"...\"\n },\n {\n \"toolResult\": {\n \"toolUseId\": \"1\",\n \"content\": [\n {\n \"text\": \"result text\"\n }\n ]\n }\n }\n ]\n }\n ],\n \"toolConfig\": {\n \"tools\": [\n {\n \"name\": \"get_weather\",\n \"description\": \"Get weather\",\n \"inputSchema\": {\n \"type\": \"object\",\n \"properties\": {\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City of location\"\n },\n \"state\": {\n \"type\": \"string\",\n \"description\": \"State of location\"\n }\n },\n \"required\": [\"city\", \"state\"]\n }\n }\n ]\n }\n }\n n models.
", + "smithy.api#documentation": "The maximum number of tokens to allow in the generated response. The default value is\n the maximum allowed value for the model that you are using. For more information, see\n Inference parameters for foundation models.
", "smithy.api#range": { "min": 1 } @@ -1509,7 +2394,7 @@ "body": { "target": "com.amazonaws.bedrockruntime#Body", "traits": { - "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.
The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. 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.
The MIME type of the input data in the request. The default value is\n application/json.
The MIME type of the input data in the request. You must specify\n application/json.
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.
The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. 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.
The MIME type of the input data in the request. The default value is\n application/json.
The MIME type of the input data in the request. You must specify\n application/json.
A message in the Message field. Use to send a message in a call to \n Converse.
" + "smithy.api#documentation": "A message input, or returned from, a call to Converse or ConverseStream.
" } }, "com.amazonaws.bedrockruntime#MessageStartEvent": { @@ -1823,6 +2708,12 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.bedrockruntime#ModelOutputs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailOutputText" + } + }, "com.amazonaws.bedrockruntime#ModelStreamErrorException": { "type": "structure", "members": { @@ -1996,7 +2887,7 @@ } }, "traits": { - "smithy.api#documentation": "The model must request a specific tool.
\nThis field is only supported by Anthropic Claude 3 models.
\nThe model must request a specific tool. For example, {\"tool\" : {\"name\" : \"Your tool name\"}}.
This field is only supported by Anthropic Claude 3 models.
\nA system prompt for the model.
" } + }, + "guardContent": { + "target": "com.amazonaws.bedrockruntime#GuardrailConverseContentBlock", + "traits": { + "smithy.api#documentation": "A content block to assess with the guardrail. Use with the Converse API (Converse and ConverseStream).
\nFor more information, see Use a guardrail with the Converse\n API in the Amazon Bedrock User Guide.
" + } } }, "traits": { - "smithy.api#documentation": "A system content block
" + "smithy.api#documentation": "A system content block.
" } }, "com.amazonaws.bedrockruntime#SystemContentBlocks": { @@ -2134,7 +3037,7 @@ "auto": { "target": "com.amazonaws.bedrockruntime#AutoToolChoice", "traits": { - "smithy.api#documentation": "The Model automatically decides if a tool should be called or to whether to generate text instead.
" + "smithy.api#documentation": "(Default). The Model automatically decides if a tool should be called or whether to generate text instead.
" } }, "any": { @@ -2146,12 +3049,12 @@ "tool": { "target": "com.amazonaws.bedrockruntime#SpecificToolChoice", "traits": { - "smithy.api#documentation": "The Model must request the specified tool.
" + "smithy.api#documentation": "The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
" } } }, "traits": { - "smithy.api#documentation": "Forces a model to use a tool.
" + "smithy.api#documentation": "Determines which tools the model should request in a call to Converse or ConverseStream.\n ToolChoice is only supported by\n Anthropic Claude 3 models and by Mistral AI Mistral Large.
Retrieves settings for one or more trails associated with the current Region for your\n account.
", - "smithy.api#idempotent": {} + "smithy.api#idempotent": {}, + "smithy.test#smokeTests": [ + { + "id": "DescribeTrailsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] } }, "com.amazonaws.cloudtrail#DescribeTrailsRequest": { diff --git a/codegen/sdk-codegen/aws-models/config-service.json b/codegen/sdk-codegen/aws-models/config-service.json index 6441b07c465..9e4f4565fdc 100644 --- a/codegen/sdk-codegen/aws-models/config-service.json +++ b/codegen/sdk-codegen/aws-models/config-service.json @@ -4135,7 +4135,20 @@ } ], "traits": { - "smithy.api#documentation": "Returns the details for the specified configuration recorders.\n\t\t\tIf the configuration recorder is not specified, this action returns\n\t\t\tthe details for all configuration recorders associated with the\n\t\t\taccount.
\nYou can specify only one configuration recorder for each Amazon Web Services Region for each account.
\nReturns the details for the specified configuration recorders.\n\t\t\tIf the configuration recorder is not specified, this action returns\n\t\t\tthe details for all configuration recorders associated with the\n\t\t\taccount.
\nYou can specify only one configuration recorder for each Amazon Web Services Region for each account.
\nMetadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" } + }, + "health": { + "target": "com.amazonaws.eks#FargateProfileHealth", + "traits": { + "smithy.api#documentation": "The health status of the Fargate profile. If there are issues with\n your Fargate profile's health, they are listed here.
" + } } }, "traits": { "smithy.api#documentation": "An object representing an Fargate profile.
" } }, + "com.amazonaws.eks#FargateProfileHealth": { + "type": "structure", + "members": { + "issues": { + "target": "com.amazonaws.eks#FargateProfileIssueList", + "traits": { + "smithy.api#documentation": "Any issues that are associated with the Fargate profile.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The health status of the Fargate profile. If there are issues with\n your Fargate profile's health, they are listed here.
" + } + }, + "com.amazonaws.eks#FargateProfileIssue": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.eks#FargateProfileIssueCode", + "traits": { + "smithy.api#documentation": "A brief description of the error.
" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The error message associated with the issue.
" + } + }, + "resourceIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The Amazon Web Services resources that are affected by this issue.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An issue that is associated with the Fargate profile.
" + } + }, + "com.amazonaws.eks#FargateProfileIssueCode": { + "type": "enum", + "members": { + "POD_EXECUTION_ROLE_ALREADY_IN_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PodExecutionRoleAlreadyInUse" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "CLUSTER_UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterUnreachable" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalFailure" + } + } + } + }, + "com.amazonaws.eks#FargateProfileIssueList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#FargateProfileIssue" + } + }, "com.amazonaws.eks#FargateProfileLabel": { "type": "map", "key": { diff --git a/codegen/sdk-codegen/aws-models/lightsail.json b/codegen/sdk-codegen/aws-models/lightsail.json index 48786397a34..1b3ca119a52 100644 --- a/codegen/sdk-codegen/aws-models/lightsail.json +++ b/codegen/sdk-codegen/aws-models/lightsail.json @@ -8637,7 +8637,20 @@ "method": "POST", "uri": "/ls/api/2016-11-28/GetActiveNames", "code": 200 - } + }, + "smithy.test#smokeTests": [ + { + "id": "GetActiveNamesSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] } }, "com.amazonaws.lightsail#GetActiveNamesRequest": { diff --git a/codegen/sdk-codegen/aws-models/polly.json b/codegen/sdk-codegen/aws-models/polly.json index 5bac0ca4229..5b9a83199e0 100644 --- a/codegen/sdk-codegen/aws-models/polly.json +++ b/codegen/sdk-codegen/aws-models/polly.json @@ -158,7 +158,20 @@ "method": "GET", "uri": "/v1/voices", "code": 200 - } + }, + "smithy.test#smokeTests": [ + { + "id": "DescribeVoicesSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] } }, "com.amazonaws.polly#DescribeVoicesInput": { diff --git a/codegen/sdk-codegen/aws-models/rekognition.json b/codegen/sdk-codegen/aws-models/rekognition.json index 13101444568..dcc61af9ec9 100644 --- a/codegen/sdk-codegen/aws-models/rekognition.json +++ b/codegen/sdk-codegen/aws-models/rekognition.json @@ -8310,7 +8310,20 @@ "outputToken": "NextToken", "items": "CollectionIds", "pageSize": "MaxResults" - } + }, + "smithy.test#smokeTests": [ + { + "id": "ListCollectionsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] } }, "com.amazonaws.rekognition#ListCollectionsRequest": { diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index af6034e16cd..1befb6d17f1 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -6490,6 +6490,31 @@ "smithy.api#pattern": "^[a-z]{3}\\d-az\\d$" } }, + "com.amazonaws.sagemaker#ClusterEbsVolumeConfig": { + "type": "structure", + "members": { + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The size in gigabytes (GB) of the additional EBS volume to be attached to the instances\n in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each\n instance within the SageMaker HyperPod cluster instance group and mounted to\n /opt/sagemaker.
Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS)\n volume to each instance of the SageMaker HyperPod cluster instance group.
" + } + }, + "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 16384 + } + } + }, "com.amazonaws.sagemaker#ClusterInstanceCount": { "type": "integer", "traits": { @@ -6504,13 +6529,13 @@ "CurrentCount": { "target": "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount", "traits": { - "smithy.api#documentation": "The number of instances that are currently in the instance group of a\n SageMaker HyperPod cluster.
" + "smithy.api#documentation": "The number of instances that are currently in the instance group of a SageMaker HyperPod\n cluster.
" } }, "TargetCount": { "target": "com.amazonaws.sagemaker#ClusterInstanceCount", "traits": { - "smithy.api#documentation": "The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
" + "smithy.api#documentation": "The number of instances you specified to add to the instance group of a SageMaker HyperPod\n cluster.
" } }, "InstanceGroupName": { @@ -6540,7 +6565,13 @@ "ThreadsPerCore": { "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", "traits": { - "smithy.api#documentation": "The number you specified to TreadsPerCore in CreateCluster for\n enabling or disabling multithreading. For instance types that support multithreading, you\n can specify 1 for disabling multithreading and 2 for enabling multithreading. For more\n information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud\n User Guide.
The number you specified to TreadsPerCore in CreateCluster for\n enabling or disabling multithreading. For instance types that support multithreading, you\n can specify 1 for disabling multithreading and 2 for enabling multithreading. For more\n information, see the reference table of CPU cores and\n threads per CPU core per instance type in the Amazon Elastic Compute Cloud User\n Guide.
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance\n group.
" } } }, @@ -6571,7 +6602,7 @@ "target": "com.amazonaws.sagemaker#ClusterInstanceCount", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
", + "smithy.api#documentation": "Specifies the number of instances to add to the instance group of a SageMaker HyperPod\n cluster.
", "smithy.api#required": {} } }, @@ -6610,7 +6641,13 @@ "ThreadsPerCore": { "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", "traits": { - "smithy.api#documentation": "Specifies the value for Threads per core. For instance types that\n support multithreading, you can specify 1 for disabling multithreading and\n 2 for enabling multithreading. For instance types that doesn't support\n multithreading, specify 1. For more information, see the reference table of\n CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud\n User Guide.
Specifies the value for Threads per core. For instance\n types that support multithreading, you can specify 1 for disabling\n multithreading and 2 for enabling multithreading. For instance types that\n doesn't support multithreading, specify 1. For more information, see the\n reference table of CPU cores and\n threads per CPU core per instance type in the Amazon Elastic Compute Cloud User\n Guide.
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster\n instance group.
" } } }, @@ -6707,6 +6744,32 @@ "smithy.api#documentation": "Details of an instance in a SageMaker HyperPod cluster.
" } }, + "com.amazonaws.sagemaker#ClusterInstanceStorageConfig": { + "type": "union", + "members": { + "EbsVolumeConfig": { + "target": "com.amazonaws.sagemaker#ClusterEbsVolumeConfig", + "traits": { + "smithy.api#documentation": "Defines the configuration for attaching additional Amazon Elastic Block Store (EBS)\n volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is\n attached to each instance within the SageMaker HyperPod cluster instance group and mounted to\n /opt/sagemaker.
Defines the configuration for attaching additional storage to the instances in the\n SageMaker HyperPod cluster instance group.
" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStorageConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStorageConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.sagemaker#ClusterInstanceType": { "type": "enum", "members": { @@ -7039,6 +7102,12 @@ "smithy.api#documentation": "The number of threads per CPU core you specified under\n CreateCluster.
The configurations of additional storage specified to the instance group where the\n instance (node) is launched.
" + } + }, "PrivatePrimaryIp": { "target": "com.amazonaws.sagemaker#ClusterPrivatePrimaryIp", "traits": { @@ -7069,7 +7138,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$" + "smithy.api#pattern": "^i-[a-f0-9]{8}(?:[a-f0-9]{9})?$" } }, "com.amazonaws.sagemaker#ClusterNodeSummaries": { @@ -8993,7 +9062,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing\n persistent clusters for developing large machine learning models, such as large language\n models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.
" + "smithy.api#documentation": "Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing\n persistent clusters for developing large machine learning models, such as large language\n models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the\n Amazon SageMaker Developer Guide.
" } }, "com.amazonaws.sagemaker#CreateClusterRequest": { @@ -9021,7 +9090,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can\n add tags to your cluster in the same way you add them in other Amazon Web Services services\n that support tagging. To learn more about tagging Amazon Web Services resources in general,\n see Tagging Amazon Web Services Resources User Guide.
" + "smithy.api#documentation": "Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can\n add tags to your cluster in the same way you add them in other Amazon Web Services services\n that support tagging. To learn more about tagging Amazon Web Services resources in general,\n see Tagging\n Amazon Web Services Resources User Guide.
" } } }, @@ -11094,6 +11163,99 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#CreateMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact\n store. For more information, see Create an MLflow Tracking\n Server.
" + } + }, + "com.amazonaws.sagemaker#CreateMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique string identifying the tracking server name. This string is part of the tracking server\n ARN.
", + "smithy.api#required": {} + } + }, + "ArtifactStoreUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact\n store.
", + "smithy.api#required": {} + } + }, + "TrackingServerSize": { + "target": "com.amazonaws.sagemaker#TrackingServerSize", + "traits": { + "smithy.api#documentation": "The size of the tracking server you want to create. You can choose between\n \"Small\", \"Medium\", and \"Large\". The default MLflow\n Tracking Server configuration size is \"Small\". You can choose a size depending on\n the projected use of the tracking server such as the volume of data logged, number of users,\n and frequency of use.
We recommend using a small tracking server for teams of up to 25 users, a medium tracking\n server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "The version of MLflow that the tracking server uses. To see which MLflow versions are\n available to use, see How it works.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to\n access the artifact store in Amazon S3. The role should have AmazonS3FullAccess\n permissions. For more information on IAM permissions for tracking server creation, see\n Set up IAM permissions for MLflow.
Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. \n To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "Tags consisting of key-value pairs used to manage metadata for the tracking server.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the tracking server.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreateModel": { "type": "operation", "input": { @@ -12361,6 +12523,65 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns a presigned URL that you can use to connect to the MLflow UI attached to your\n tracking server. For more information, see Launch the MLflow UI using a presigned URL.
" + } + }, + "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the tracking server to connect to your MLflow UI.
", + "smithy.api#required": {} + } + }, + "ExpiresInSeconds": { + "target": "com.amazonaws.sagemaker#ExpiresInSeconds", + "traits": { + "smithy.api#documentation": "The duration in seconds that your presigned URL is valid. The presigned URL can be used\n only once.
" + } + }, + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "The duration in seconds that your MLflow UI session is valid.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlResponse": { + "type": "structure", + "members": { + "AuthorizedUrl": { + "target": "com.amazonaws.sagemaker#TrackingServerUrl", + "traits": { + "smithy.api#documentation": "A presigned URL with an authorization token.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrl": { "type": "operation", "input": { @@ -15528,6 +15749,53 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DeleteMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.
" + } + }, + "com.amazonaws.sagemaker#DeleteMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the the tracking server to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "A TrackingServerArn object, the ARN of the tracking server that is deleted if\n successfully found.
Use this operation to delete a workforce.
\nIf you want to create a new workforce in an Amazon Web Services Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use CreateWorkforce\n to create a new workforce.
\nIf a private workforce contains one or more work teams, you must use \n the DeleteWorkteam\n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will recieve a ResourceInUse error.
Use this operation to delete a workforce.
\nIf you want to create a new workforce in an Amazon Web Services Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use CreateWorkforce\n to create a new workforce.
\nIf a private workforce contains one or more work teams, you must use \n the DeleteWorkteam\n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will receive a ResourceInUse error.
Returns information about an MLflow Tracking Server.
" + } + }, + "com.amazonaws.sagemaker#DescribeMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the MLflow Tracking Server to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the described tracking server.
" + } + }, + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#documentation": "The name of the described tracking server.
" + } + }, + "ArtifactStoreUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI of the general purpose bucket used as the MLflow Tracking Server\n artifact store.
" + } + }, + "TrackingServerSize": { + "target": "com.amazonaws.sagemaker#TrackingServerSize", + "traits": { + "smithy.api#documentation": "The size of the described tracking server.
" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "The MLflow version used for the described tracking server.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server\n uses to access the artifact store in Amazon S3.
" + } + }, + "TrackingServerStatus": { + "target": "com.amazonaws.sagemaker#TrackingServerStatus", + "traits": { + "smithy.api#documentation": "The current creation status of the described MLflow Tracking Server.
" + } + }, + "IsActive": { + "target": "com.amazonaws.sagemaker#IsTrackingServerActive", + "traits": { + "smithy.api#documentation": "Whether the described MLflow Tracking Server is currently active.
" + } + }, + "TrackingServerUrl": { + "target": "com.amazonaws.sagemaker#TrackingServerUrl", + "traits": { + "smithy.api#documentation": "The URL to connect to the MLflow user interface for the described tracking server.
" + } + }, + "WeeklyMaintenanceWindowStart": { + "target": "com.amazonaws.sagemaker#WeeklyMaintenanceWindowStart", + "traits": { + "smithy.api#documentation": "The day and time of the week when weekly maintenance occurs on the described tracking server.
" + } + }, + "AutomaticModelRegistration": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the described MLflow Tracking Server was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the described MLflow Tracking Server was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribeModel": { "type": "operation", "input": { @@ -24367,7 +24760,7 @@ "target": "com.amazonaws.sagemaker#DescribeWorkteamResponse" }, "traits": { - "smithy.api#documentation": "Gets information about a specific work team. You can see information such as the\n create date, the last updated date, membership information, and the work team's Amazon\n Resource Name (ARN).
" + "smithy.api#documentation": "Gets information about a specific work team. You can see information such as the\n creation date, the last updated date, membership information, and the work team's Amazon\n Resource Name (ARN).
" } }, "com.amazonaws.sagemaker#DescribeWorkteamRequest": { @@ -33916,6 +34309,23 @@ "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$" } }, + "com.amazonaws.sagemaker#IsTrackingServerActive": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + } + } + }, "com.amazonaws.sagemaker#ItemIdentifierAttributeName": { "type": "string", "traits": { @@ -35856,14 +36266,14 @@ "target": "com.amazonaws.sagemaker#ClusterNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.
", + "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the\n list of nodes.
", "smithy.api#required": {} } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are\n formatted according to the ISO 8601 standard.
\nAcceptable formats include:
\n\n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n
\n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n
\n YYYY-MM-DD, for example, 2014-10-01\n
Unix time in seconds, for example, 1412195400. This is also referred to as Unix\n Epoch time and represents the number of seconds since midnight, January 1, 1970\n UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
" + "smithy.api#documentation": "A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time.\n Timestamps are formatted according to the ISO 8601 standard.
\nAcceptable formats include:
\n\n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n
\n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n
\n YYYY-MM-DD, for example, 2014-10-01\n
Unix time in seconds, for example, 1412195400. This is also referred\n to as Unix Epoch time and represents the number of seconds since midnight, January 1,\n 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
" } }, "CreationTimeBefore": { @@ -35955,7 +36365,7 @@ "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A\n filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable\n formats are the same as the timestamp formats for CreationTimeAfter. For more\n information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A\n filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The\n acceptable formats are the same as the timestamp formats for\n CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
Lists all MLflow Tracking Servers.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrackingServerSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListMlflowTrackingServersRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "Use the CreatedAfter filter to only list tracking servers created after a\n specific date and time. Listed tracking servers are shown with a date and time such as\n \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a\n Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Use the CreatedBefore filter to only list tracking servers created before a\n specific date and time. Listed tracking servers are shown with a date and time such as\n \"2024-03-16T01:46:56+00:00\". The CreatedBefore parameter takes in\n a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Filter for tracking servers with a specified creation status.
" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "Filter for tracking servers using the specified MLflow version.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortTrackingServerBy", + "traits": { + "smithy.api#documentation": "Filter for trackings servers sorting by name, creation time, or creation status.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time. \n To change the list order, you can specify SortOrder to be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of tracking servers to list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListMlflowTrackingServersResponse": { + "type": "structure", + "members": { + "TrackingServerSummaries": { + "target": "com.amazonaws.sagemaker#TrackingServerSummaryList", + "traits": { + "smithy.api#documentation": "A list of tracking servers according to chosen filters.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#ListModelBiasJobDefinitions": { "type": "operation", "input": { @@ -42917,6 +43421,16 @@ "smithy.api#pattern": "^1|2$" } }, + "com.amazonaws.sagemaker#MlflowVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + }, + "smithy.api#pattern": "^[0-9]*.[0-9]*.[0-9]*$" + } + }, "com.amazonaws.sagemaker#Model": { "type": "structure", "members": { @@ -55017,6 +55531,9 @@ { "target": "com.amazonaws.sagemaker#CreateLabelingJob" }, + { + "target": "com.amazonaws.sagemaker#CreateMlflowTrackingServer" + }, { "target": "com.amazonaws.sagemaker#CreateModel" }, @@ -55056,6 +55573,9 @@ { "target": "com.amazonaws.sagemaker#CreatePresignedDomainUrl" }, + { + "target": "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrl" + }, { "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrl" }, @@ -55176,6 +55696,9 @@ { "target": "com.amazonaws.sagemaker#DeleteInferenceExperiment" }, + { + "target": "com.amazonaws.sagemaker#DeleteMlflowTrackingServer" + }, { "target": "com.amazonaws.sagemaker#DeleteModel" }, @@ -55347,6 +55870,9 @@ { "target": "com.amazonaws.sagemaker#DescribeLineageGroup" }, + { + "target": "com.amazonaws.sagemaker#DescribeMlflowTrackingServer" + }, { "target": "com.amazonaws.sagemaker#DescribeModel" }, @@ -55572,6 +56098,9 @@ { "target": "com.amazonaws.sagemaker#ListLineageGroups" }, + { + "target": "com.amazonaws.sagemaker#ListMlflowTrackingServers" + }, { "target": "com.amazonaws.sagemaker#ListModelBiasJobDefinitions" }, @@ -55710,6 +56239,9 @@ { "target": "com.amazonaws.sagemaker#StartInferenceExperiment" }, + { + "target": "com.amazonaws.sagemaker#StartMlflowTrackingServer" + }, { "target": "com.amazonaws.sagemaker#StartMonitoringSchedule" }, @@ -55743,6 +56275,9 @@ { "target": "com.amazonaws.sagemaker#StopLabelingJob" }, + { + "target": "com.amazonaws.sagemaker#StopMlflowTrackingServer" + }, { "target": "com.amazonaws.sagemaker#StopMonitoringSchedule" }, @@ -55824,6 +56359,9 @@ { "target": "com.amazonaws.sagemaker#UpdateInferenceExperiment" }, + { + "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServer" + }, { "target": "com.amazonaws.sagemaker#UpdateModelCard" }, @@ -58219,6 +58757,29 @@ } } }, + "com.amazonaws.sagemaker#SortTrackingServerBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, "com.amazonaws.sagemaker#SortTrialComponentsBy": { "type": "enum", "members": { @@ -58322,7 +58883,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of IP address ranges (CIDRs). Used to create an allow\n list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an \n IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
" + "smithy.api#documentation": "A list of IP address ranges (CIDRs). Used to create an allow\n list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an\n IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
" } }, "com.amazonaws.sagemaker#SourceType": { @@ -58845,6 +59406,56 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#StartMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StartMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StartMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Programmatically start an MLflow Tracking Server.
" + } + }, + "com.amazonaws.sagemaker#StartMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the tracking server to start.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StartMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the started tracking server.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#StartMonitoringSchedule": { "type": "operation", "input": { @@ -59429,6 +60040,56 @@ "smithy.api#input": {} } }, + "com.amazonaws.sagemaker#StopMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#StopMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Programmatically stop an MLflow Tracking Server.
" + } + }, + "com.amazonaws.sagemaker#StopMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the tracking server to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#StopMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the stopped tracking server.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#StopMonitoringSchedule": { "type": "operation", "input": { @@ -59979,7 +60640,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a work team of a vendor that does the a labelling job.
" + "smithy.api#documentation": "Describes a work team of a vendor that does the labelling job.
" } }, "com.amazonaws.sagemaker#SubscribedWorkteams": { @@ -61090,6 +61751,227 @@ } } }, + "com.amazonaws.sagemaker#TrackingServerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:mlflow-tracking-server/" + } + }, + "com.amazonaws.sagemaker#TrackingServerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$" + } + }, + "com.amazonaws.sagemaker#TrackingServerSize": { + "type": "enum", + "members": { + "S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Small" + } + }, + "M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Medium" + } + }, + "L": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Large" + } + } + } + }, + "com.amazonaws.sagemaker#TrackingServerStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updated" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateFailed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "STOP_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StopFailed" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Starting" + } + }, + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Started" + } + }, + "START_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartFailed" + } + }, + "MAINTENANCE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaintenanceInProgress" + } + }, + "MAINTENANCE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaintenanceComplete" + } + }, + "MAINTENANCE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaintenanceFailed" + } + } + } + }, + "com.amazonaws.sagemaker#TrackingServerSummary": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of a listed tracking server.
" + } + }, + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#documentation": "The name of a listed tracking server.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of a listed tracking server.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last modified time of a listed tracking server.
" + } + }, + "TrackingServerStatus": { + "target": "com.amazonaws.sagemaker#TrackingServerStatus", + "traits": { + "smithy.api#documentation": "The creation status of a listed tracking server.
" + } + }, + "IsActive": { + "target": "com.amazonaws.sagemaker#IsTrackingServerActive", + "traits": { + "smithy.api#documentation": "The activity status of a listed tracking server.
" + } + }, + "MlflowVersion": { + "target": "com.amazonaws.sagemaker#MlflowVersion", + "traits": { + "smithy.api#documentation": "The MLflow version used for a listed tracking server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the tracking server to list.
" + } + }, + "com.amazonaws.sagemaker#TrackingServerSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#TrackingServerSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#TrackingServerUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, "com.amazonaws.sagemaker#TrafficDurationInSeconds": { "type": "integer", "traits": { @@ -65787,6 +66669,83 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#UpdateMlflowTrackingServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServerRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateMlflowTrackingServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates properties of an existing MLflow Tracking Server.
" + } + }, + "com.amazonaws.sagemaker#UpdateMlflowTrackingServerRequest": { + "type": "structure", + "members": { + "TrackingServerName": { + "target": "com.amazonaws.sagemaker#TrackingServerName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the MLflow Tracking Server to update.
", + "smithy.api#required": {} + } + }, + "ArtifactStoreUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow\n Tracking Server.
" + } + }, + "TrackingServerSize": { + "target": "com.amazonaws.sagemaker#TrackingServerSize", + "traits": { + "smithy.api#documentation": "The new size for the MLflow Tracking Server.
" + } + }, + "AutomaticModelRegistration": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. \n To enable automatic model registration, set this value to True. \n To disable automatic model registration, set this value to False. \n If not specified, AutomaticModelRegistration defaults to False\n
The new weekly maintenance window start day and time to update. The maintenance window day and time should be \n in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateMlflowTrackingServerResponse": { + "type": "structure", + "members": { + "TrackingServerArn": { + "target": "com.amazonaws.sagemaker#TrackingServerArn", + "traits": { + "smithy.api#documentation": "The ARN of the updated MLflow Tracking Server.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#UpdateModelCard": { "type": "operation", "input": { @@ -67709,6 +68668,16 @@ "smithy.api#documentation": "Status and billing information about the warm pool.
" } }, + "com.amazonaws.sagemaker#WeeklyMaintenanceWindowStart": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 9 + }, + "smithy.api#pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)$" + } + }, "com.amazonaws.sagemaker#WorkerAccessConfiguration": { "type": "structure", "members": { @@ -67922,7 +68891,7 @@ "SecurityGroupIds": { "target": "com.amazonaws.sagemaker#WorkforceSecurityGroupIds", "traits": { - "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
" + "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.