From 65a2b3bbd7ce5de1ce0f249e48743bf5f9a835a6 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Fri, 8 Mar 2024 19:05:33 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/batch.json | 92 ++- .../aws-models/bedrock-agent-runtime.json | 729 ++++++++++++------ .../sdk-codegen/aws-models/cloudtrail.json | 15 +- codegen/sdk-codegen/aws-models/codebuild.json | 6 +- .../aws-models/cognito-identity-provider.json | 65 +- codegen/sdk-codegen/aws-models/guardduty.json | 32 +- codegen/sdk-codegen/aws-models/transfer.json | 18 +- 7 files changed, 644 insertions(+), 313 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/batch.json b/codegen/sdk-codegen/aws-models/batch.json index 5e478412b07..5999b8db29f 100644 --- a/codegen/sdk-codegen/aws-models/batch.json +++ b/codegen/sdk-codegen/aws-models/batch.json @@ -2649,6 +2649,12 @@ "traits": { "smithy.api#documentation": "

The tags that you apply to the job queue to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources\n in Batch User Guide.

" } + }, + "jobStateTimeLimitActions": { + "target": "com.amazonaws.batch#JobStateTimeLimitActions", + "traits": { + "smithy.api#documentation": "

The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state\n longer than specified times. Batch will perform each action after maxTimeSeconds has passed.

" + } } }, "traits": { @@ -5065,7 +5071,7 @@ "statusReason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

A short, human-readable string to provide more details for the current status of the\n job.

" + "smithy.api#documentation": "

A short, human-readable string to provide more details for the current status of the job.

\n " } }, "createdAt": { @@ -5278,6 +5284,12 @@ "traits": { "smithy.api#documentation": "

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in\n Batch User Guide.

" } + }, + "jobStateTimeLimitActions": { + "target": "com.amazonaws.batch#JobStateTimeLimitActions", + "traits": { + "smithy.api#documentation": "

The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state\n longer than specified times. Batch will perform each action after maxTimeSeconds has passed.

" + } } }, "traits": { @@ -5290,6 +5302,74 @@ "target": "com.amazonaws.batch#JobQueueDetail" } }, + "com.amazonaws.batch#JobStateTimeLimitAction": { + "type": "structure", + "members": { + "reason": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The reason to log for the action being taken.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.batch#JobStateTimeLimitActionsState", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The state of the job needed to trigger the action. The only supported value is \"RUNNABLE\".

", + "smithy.api#required": {} + } + }, + "maxTimeSeconds": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The approximate amount of time, in seconds, that must pass with the job in the specified state before the action\n is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).

", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.batch#JobStateTimeLimitActionsAction", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The action to take when a job is at the head of the job queue in the specified state for the specified period of\n time. The only supported value is \"CANCEL\", which will cancel the job.

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

Specifies an action that Batch will take after the job has remained at the head of the queue in the specified\n state for longer than the specified time.

" + } + }, + "com.amazonaws.batch#JobStateTimeLimitActions": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#JobStateTimeLimitAction" + } + }, + "com.amazonaws.batch#JobStateTimeLimitActionsAction": { + "type": "enum", + "members": { + "CANCEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL" + } + } + } + }, + "com.amazonaws.batch#JobStateTimeLimitActionsState": { + "type": "enum", + "members": { + "RUNNABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNABLE" + } + } + } + }, "com.amazonaws.batch#JobStatus": { "type": "enum", "members": { @@ -7123,7 +7203,7 @@ "essential": { "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "

If the essential parameter of a container is marked as true, and that container\n fails or stops for any reason, all other containers that are part of the task are stopped. If the\n essential parameter of a container is marked as false, its failure doesn't affect\n the rest of the containers in a task. If this parameter is omitted, a container is assumed to be\n essential.

\n

All tasks must have at least one essential container. If you have an application that's\n composed of multiple containers, group containers that are used for a common purpose into\n components, and separate the different components into multiple task definitions. For more\n information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

If the essential parameter of a container is marked as true, and that container\n fails or stops for any reason, all other containers that are part of the task are stopped. If the\n essential parameter of a container is marked as false, its failure doesn't affect\n the rest of the containers in a task. If this parameter is omitted, a container is assumed to be\n essential.

\n

All jobs must have at least one essential container. If you have an application that's\n composed of multiple containers, group containers that are used for a common purpose into\n components, and separate the different components into multiple task definitions. For more\n information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.

" } }, "image": { @@ -7283,7 +7363,7 @@ "essential": { "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "

If the essential parameter of a container is marked as true, and that container\n fails or stops for any reason, all other containers that are part of the task are stopped. If the\n essential parameter of a container is marked as false, its failure doesn't affect\n the rest of the containers in a task. If this parameter is omitted, a container is assumed to be\n essential.

\n

All tasks must have at least one essential container. If you have an application that's\n composed of multiple containers, group containers that are used for a common purpose into\n components, and separate the different components into multiple task definitions. For more\n information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

If the essential parameter of a container is marked as true, and that container\n fails or stops for any reason, all other containers that are part of the task are stopped. If the\n essential parameter of a container is marked as false, its failure doesn't affect\n the rest of the containers in a task. If this parameter is omitted, a container is assumed to be\n essential.

\n

All jobs must have at least one essential container. If you have an application that's\n composed of multiple containers, group containers that are used for a common purpose into\n components, and separate the different components into multiple task definitions. For more\n information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.

" } }, "image": { @@ -7771,6 +7851,12 @@ "traits": { "smithy.api#documentation": "

Details the set of compute environments mapped to a job queue and their order relative to\n each other. This is one of the parameters used by the job scheduler to determine which compute\n environment runs a given job. Compute environments must be in the VALID state\n before you can associate them with a job queue. All of the compute environments must be either\n EC2 (EC2 or SPOT) or Fargate (FARGATE or\n FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same\n architecture. Batch doesn't support mixing compute environment architecture types in a\n single job queue.

\n " } + }, + "jobStateTimeLimitActions": { + "target": "com.amazonaws.batch#JobStateTimeLimitActions", + "traits": { + "smithy.api#documentation": "

The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state\n longer than specified times. Batch will perform each action after maxTimeSeconds has passed.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json index 98b82011670..bf445a8a668 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json @@ -9,7 +9,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a request is denied per access permissions", + "smithy.api#documentation": "

The request is denied because of missing access permissions. Check your permissions and retry your request.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -18,54 +18,69 @@ "type": "structure", "members": { "actionGroupName": { - "target": "com.amazonaws.bedrockagentruntime#ActionGroupName" + "target": "com.amazonaws.bedrockagentruntime#ActionGroupName", + "traits": { + "smithy.api#documentation": "

The name of the action group.

" + } }, "verb": { - "target": "com.amazonaws.bedrockagentruntime#Verb" + "target": "com.amazonaws.bedrockagentruntime#Verb", + "traits": { + "smithy.api#documentation": "

The API method being used, based off the action group.

" + } }, "apiPath": { - "target": "com.amazonaws.bedrockagentruntime#ApiPath" + "target": "com.amazonaws.bedrockagentruntime#ApiPath", + "traits": { + "smithy.api#documentation": "

The path to the API to call, based off the action group.

" + } }, "parameters": { - "target": "com.amazonaws.bedrockagentruntime#Parameters" + "target": "com.amazonaws.bedrockagentruntime#Parameters", + "traits": { + "smithy.api#documentation": "

The parameters in the Lambda input event.

" + } }, "requestBody": { - "target": "com.amazonaws.bedrockagentruntime#RequestBody" + "target": "com.amazonaws.bedrockagentruntime#RequestBody", + "traits": { + "smithy.api#documentation": "

The parameters in the request body for the Lambda input event.

" + } } }, "traits": { - "smithy.api#documentation": "input to lambda used in action group" + "smithy.api#documentation": "

Contains information about the action group being invoked.

" } }, "com.amazonaws.bedrockagentruntime#ActionGroupInvocationOutput": { "type": "structure", "members": { "text": { - "target": "com.amazonaws.bedrockagentruntime#ActionGroupOutputString" + "target": "com.amazonaws.bedrockagentruntime#ActionGroupOutputString", + "traits": { + "smithy.api#documentation": "

The JSON-formatted string returned by the API invoked by the action group.

" + } } }, "traits": { - "smithy.api#documentation": "output from lambda used in action group" + "smithy.api#documentation": "

Contains the JSON-formatted string returned by the API invoked by the action group.

" } }, "com.amazonaws.bedrockagentruntime#ActionGroupName": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group Name", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#ActionGroupOutputString": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group Lambda Invocation Output String", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#AgentAliasId": { "type": "string", "traits": { - "smithy.api#documentation": "Identifier of the agent alias.", "smithy.api#length": { "max": 10 }, @@ -75,7 +90,6 @@ "com.amazonaws.bedrockagentruntime#AgentId": { "type": "string", "traits": { - "smithy.api#documentation": "Identifier of the agent.", "smithy.api#length": { "max": 10 }, @@ -107,7 +121,7 @@ "name": "bedrock" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Bedrock Agent", + "smithy.api#documentation": "

Contains APIs related to model invocation and querying of knowledge bases.

", "smithy.api#title": "Agents for Amazon Bedrock Runtime", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -778,7 +792,6 @@ "com.amazonaws.bedrockagentruntime#ApiPath": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group API path", "smithy.api#sensitive": {} } }, @@ -786,11 +799,14 @@ "type": "structure", "members": { "citations": { - "target": "com.amazonaws.bedrockagentruntime#Citations" + "target": "com.amazonaws.bedrockagentruntime#Citations", + "traits": { + "smithy.api#documentation": "

A list of citations and related information for a part of an agent response.

" + } } }, "traits": { - "smithy.api#documentation": "Citations associated with final agent response" + "smithy.api#documentation": "

Contains citations for a part of an agent response.

" } }, "com.amazonaws.bedrockagentruntime#BadGatewayException": { @@ -800,11 +816,14 @@ "target": "com.amazonaws.bedrockagentruntime#NonBlankString" }, "resourceName": { - "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + "target": "com.amazonaws.bedrockagentruntime#NonBlankString", + "traits": { + "smithy.api#documentation": "

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

" + } } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource", + "smithy.api#documentation": "

There was an issue with a dependency due to a server issue. Retry your request.

", "smithy.api#error": "server", "smithy.api#httpError": 502 } @@ -812,7 +831,6 @@ "com.amazonaws.bedrockagentruntime#BedrockModelArn": { "type": "string", "traits": { - "smithy.api#documentation": "Arn of a Bedrock model.", "smithy.api#length": { "min": 20, "max": 1011 @@ -824,23 +842,26 @@ "type": "structure", "members": { "generatedResponsePart": { - "target": "com.amazonaws.bedrockagentruntime#GeneratedResponsePart" + "target": "com.amazonaws.bedrockagentruntime#GeneratedResponsePart", + "traits": { + "smithy.api#documentation": "

Contains the generated response and metadata

" + } }, "retrievedReferences": { - "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences" + "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences", + "traits": { + "smithy.api#documentation": "

Contains metadata about the sources cited for the generated response.

" + } } }, "traits": { - "smithy.api#documentation": "Citation associated with the agent response" + "smithy.api#documentation": "

An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.

" } }, "com.amazonaws.bedrockagentruntime#Citations": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#Citation" - }, - "traits": { - "smithy.api#documentation": "List of citations" } }, "com.amazonaws.bedrockagentruntime#ConflictException": { @@ -851,7 +872,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when there is a conflict performing an operation", + "smithy.api#documentation": "

There was a conflict performing an operation. Resolve the conflict and retry your request.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -863,9 +884,6 @@ }, "value": { "target": "com.amazonaws.bedrockagentruntime#Parameters" - }, - "traits": { - "smithy.api#documentation": "Content type paramter map" } }, "com.amazonaws.bedrockagentruntime#CreationMode": { @@ -883,9 +901,6 @@ "smithy.api#enumValue": "OVERRIDDEN" } } - }, - "traits": { - "smithy.api#documentation": "indicates if agent uses default prompt or overriden prompt" } }, "com.amazonaws.bedrockagentruntime#DependencyFailedException": { @@ -895,11 +910,14 @@ "target": "com.amazonaws.bedrockagentruntime#NonBlankString" }, "resourceName": { - "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + "target": "com.amazonaws.bedrockagentruntime#NonBlankString", + "traits": { + "smithy.api#documentation": "

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

" + } } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration)", + "smithy.api#documentation": "

There was an issue with a dependency. Check the resource configurations and retry the request.

", "smithy.api#error": "client", "smithy.api#httpError": 424 } @@ -907,7 +925,6 @@ "com.amazonaws.bedrockagentruntime#FailureReasonString": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Failed Reason String", "smithy.api#sensitive": {} } }, @@ -915,14 +932,20 @@ "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the trace.

" + } }, "failureReason": { - "target": "com.amazonaws.bedrockagentruntime#FailureReasonString" + "target": "com.amazonaws.bedrockagentruntime#FailureReasonString", + "traits": { + "smithy.api#documentation": "

The reason the interaction failed.

" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which is emitted when agent trace could not be generated", + "smithy.api#documentation": "

Contains information about the failure of the interaction.

", "smithy.api#sensitive": {} } }, @@ -930,17 +953,19 @@ "type": "structure", "members": { "text": { - "target": "com.amazonaws.bedrockagentruntime#FinalResponseString" + "target": "com.amazonaws.bedrockagentruntime#FinalResponseString", + "traits": { + "smithy.api#documentation": "

The text in the response to the user.

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

Contains details about the response to the user.

" } }, "com.amazonaws.bedrockagentruntime#FinalResponseString": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group Lambda Invocation Output String", "smithy.api#sensitive": {} } }, @@ -948,34 +973,52 @@ "type": "structure", "members": { "textResponsePart": { - "target": "com.amazonaws.bedrockagentruntime#TextResponsePart" + "target": "com.amazonaws.bedrockagentruntime#TextResponsePart", + "traits": { + "smithy.api#documentation": "

Contains metadata about a textual part of the generated response that is accompanied by a citation.

" + } } }, "traits": { - "smithy.api#documentation": "Generate response part" + "smithy.api#documentation": "

Contains metadata about a part of the generated response that is accompanied by a citation.

" } }, "com.amazonaws.bedrockagentruntime#InferenceConfiguration": { "type": "structure", "members": { "temperature": { - "target": "com.amazonaws.bedrockagentruntime#Temperature" + "target": "com.amazonaws.bedrockagentruntime#Temperature", + "traits": { + "smithy.api#documentation": "

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

" + } }, "topP": { - "target": "com.amazonaws.bedrockagentruntime#TopP" + "target": "com.amazonaws.bedrockagentruntime#TopP", + "traits": { + "smithy.api#documentation": "

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.

" + } }, "topK": { - "target": "com.amazonaws.bedrockagentruntime#TopK" + "target": "com.amazonaws.bedrockagentruntime#TopK", + "traits": { + "smithy.api#documentation": "

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

" + } }, "maximumLength": { - "target": "com.amazonaws.bedrockagentruntime#MaximumLength" + "target": "com.amazonaws.bedrockagentruntime#MaximumLength", + "traits": { + "smithy.api#documentation": "

The maximum number of tokens allowed in the generated response.

" + } }, "stopSequences": { - "target": "com.amazonaws.bedrockagentruntime#StopSequences" + "target": "com.amazonaws.bedrockagentruntime#StopSequences", + "traits": { + "smithy.api#documentation": "

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

" + } } }, "traits": { - "smithy.api#documentation": "Configurations for controlling the inference response of an InvokeAgent API call" + "smithy.api#documentation": "

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

" } }, "com.amazonaws.bedrockagentruntime#InferenceResource": { @@ -989,7 +1032,6 @@ "com.amazonaws.bedrockagentruntime#InputText": { "type": "string", "traits": { - "smithy.api#documentation": "Model text input", "smithy.api#length": { "max": 25000000 }, @@ -1004,7 +1046,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown if there was an unexpected error during processing of request", + "smithy.api#documentation": "

An internal server error occurred. Retry your request.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1013,20 +1055,32 @@ "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the trace.

" + } }, "invocationType": { - "target": "com.amazonaws.bedrockagentruntime#InvocationType" + "target": "com.amazonaws.bedrockagentruntime#InvocationType", + "traits": { + "smithy.api#documentation": "

Specifies whether the agent is invoking an action group or a knowledge base.

" + } }, "actionGroupInvocationInput": { - "target": "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput" + "target": "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput", + "traits": { + "smithy.api#documentation": "

Contains information about the action group to be invoked.

" + } }, "knowledgeBaseLookupInput": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInput" + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInput", + "traits": { + "smithy.api#documentation": "

Contains details about the knowledge base to look up and the query to be made.

" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains input details for action group or knowledge base", + "smithy.api#documentation": "

Contains information pertaining to the action group or knowledge base that is being invoked.

", "smithy.api#sensitive": {} } }, @@ -1051,9 +1105,6 @@ "smithy.api#enumValue": "FINISH" } } - }, - "traits": { - "smithy.api#documentation": "types of invocations" } }, "com.amazonaws.bedrockagentruntime#InvokeAgent": { @@ -1094,7 +1145,7 @@ } ], "traits": { - "smithy.api#documentation": "Invokes the specified Bedrock model to run inference using the input provided in the request body.", + "smithy.api#documentation": "

Sends a prompt for the agent to process and respond to.

\n \n

The CLI doesn't support InvokeAgent.

\n \n \n

The response is returned in the bytes field of the chunk object.

\n ", "smithy.api#http": { "code": 200, "method": "POST", @@ -1108,13 +1159,13 @@ "sessionState": { "target": "com.amazonaws.bedrockagentruntime#SessionState", "traits": { - "smithy.api#documentation": "Session state passed by customer. Base64 encoded json string representation of SessionState." + "smithy.api#documentation": "

Contains parameters that specify various attributes of the session.

" } }, "agentId": { "target": "com.amazonaws.bedrockagentruntime#AgentId", "traits": { - "smithy.api#documentation": "Identifier for Agent", + "smithy.api#documentation": "

The unique identifier of the agent to use.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1122,7 +1173,7 @@ "agentAliasId": { "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", "traits": { - "smithy.api#documentation": "Identifier for Agent Alias", + "smithy.api#documentation": "

The alias of the agent to use.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1130,7 +1181,7 @@ "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { - "smithy.api#documentation": "Identifier used for the current session", + "smithy.api#documentation": "

The unique identifier of the session. Use the same value across requests to continue the same conversation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1138,25 +1189,24 @@ "endSession": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "End current session" + "smithy.api#documentation": "

Specifies whether to end the session with the agent or not.

" } }, "enableTrace": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Enable agent trace events for improved debugging" + "smithy.api#documentation": "

Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.

" } }, "inputText": { "target": "com.amazonaws.bedrockagentruntime#InputText", "traits": { - "smithy.api#documentation": "Input data in the format specified in the Content-Type request header.", + "smithy.api#documentation": "

The prompt text to send the agent.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "InvokeAgent Request", "smithy.api#input": {} } }, @@ -1166,7 +1216,7 @@ "completion": { "target": "com.amazonaws.bedrockagentruntime#ResponseStream", "traits": { - "smithy.api#documentation": "Inference response from the model in the format specified in the Content-Type response header.", + "smithy.api#documentation": "

The agent's response to the user prompt.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -1174,7 +1224,7 @@ "contentType": { "target": "com.amazonaws.bedrockagentruntime#MimeType", "traits": { - "smithy.api#documentation": "streaming response mimetype of the model", + "smithy.api#documentation": "

The MIME type of the input data in the request. The default value is application/json.

", "smithy.api#httpHeader": "x-amzn-bedrock-agent-content-type", "smithy.api#required": {} } @@ -1182,21 +1232,19 @@ "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { - "smithy.api#documentation": "streaming response mimetype of the model", + "smithy.api#documentation": "

The unique identifier of the session with the agent.

", "smithy.api#httpHeader": "x-amz-bedrock-agent-session-id", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "InvokeAgent Response", "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#KmsKeyArn": { "type": "string", "traits": { - "smithy.api#documentation": "A KMS key ARN", "smithy.api#length": { "min": 1, "max": 2048 @@ -1207,7 +1255,6 @@ "com.amazonaws.bedrockagentruntime#KnowledgeBaseId": { "type": "string", "traits": { - "smithy.api#documentation": "Identifier of the KnowledgeBase", "smithy.api#length": { "max": 10 }, @@ -1218,20 +1265,25 @@ "type": "structure", "members": { "text": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInputString" + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInputString", + "traits": { + "smithy.api#documentation": "

The query made to the knowledge base.

" + } }, "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagentruntime#TraceKnowledgeBaseId" + "target": "com.amazonaws.bedrockagentruntime#TraceKnowledgeBaseId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to look up.

" + } } }, "traits": { - "smithy.api#documentation": "Input to lambda used in action group" + "smithy.api#documentation": "

Contains details about the knowledge base to look up and the query to be made.

" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInputString": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group Lambda Invocation Output String", "smithy.api#sensitive": {} } }, @@ -1239,11 +1291,14 @@ "type": "structure", "members": { "retrievedReferences": { - "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences" + "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences", + "traits": { + "smithy.api#documentation": "

Contains metadata about the sources cited for the generated response.

" + } } }, "traits": { - "smithy.api#documentation": "Input to lambda used in action group" + "smithy.api#documentation": "

Contains details about the results from looking up the knowledge base.

" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseQuery": { @@ -1252,7 +1307,7 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Knowledge base input query in text", + "smithy.api#documentation": "

The text of the query made to the knowledge base.

", "smithy.api#length": { "max": 1000 }, @@ -1261,7 +1316,7 @@ } }, "traits": { - "smithy.api#documentation": "Knowledge base input query.", + "smithy.api#documentation": "

Contains the query made to the knowledge base.

", "smithy.api#sensitive": {} } }, @@ -1271,12 +1326,13 @@ "vectorSearchConfiguration": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseVectorSearchConfiguration", "traits": { + "smithy.api#documentation": "

Contains details about how the results from the vector search should be returned.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Search parameters for retrieving from knowledge base." + "smithy.api#documentation": "

Contains details about how the results should be returned.

\n

This data type is used in the following API operations:

\n " } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalResult": { @@ -1285,21 +1341,25 @@ "content": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContent", "traits": { + "smithy.api#documentation": "

Contains a chunk of text from a data source in the knowledge base.

", "smithy.api#required": {} } }, "location": { - "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation" + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation", + "traits": { + "smithy.api#documentation": "

Contains information about the location of the data source.

" + } }, "score": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "The relevance score of a result." + "smithy.api#documentation": "

The level of relevance of the result to the query.

" } } }, "traits": { - "smithy.api#documentation": "Result item returned from a knowledge base retrieval." + "smithy.api#documentation": "

Details about a result from querying the knowledge base.

" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalResults": { @@ -1308,7 +1368,6 @@ "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalResult" }, "traits": { - "smithy.api#documentation": "List of knowledge base retrieval results", "smithy.api#sensitive": {} } }, @@ -1318,21 +1377,26 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base that is queried and the foundation model used for generation.

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

The ARN of the foundation model used to generate a response.

", "smithy.api#required": {} } }, "retrievalConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration" + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configurations for how to retrieve and return the knowledge base query.

" + } } }, "traits": { - "smithy.api#documentation": "Configurations for retrieval and generation for knowledge base." + "smithy.api#documentation": "

Contains details about the resource being queried.

" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseVectorSearchConfiguration": { @@ -1343,7 +1407,7 @@ "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": 5, - "smithy.api#documentation": "Top-K results to retrieve from knowledge base.", + "smithy.api#documentation": "

The number of results to return.

\n \n

The numberOfResults field is currently unsupported for RetrieveAndGenerate. Don't include it in this field if you are sending a RetrieveAndGenerate request.

\n ", "smithy.api#range": { "min": 1, "max": 25 @@ -1353,24 +1417,20 @@ "overrideSearchType": { "target": "com.amazonaws.bedrockagentruntime#SearchType", "traits": { - "smithy.api#documentation": "Override the type of query to be performed on data store" + "smithy.api#documentation": "

By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.

" } } }, "traits": { - "smithy.api#documentation": "Knowledge base vector search configuration" + "smithy.api#documentation": "

Configurations for how to carry out the search.

" } }, "com.amazonaws.bedrockagentruntime#LambdaArn": { - "type": "string", - "traits": { - "smithy.api#documentation": "ARN of a Lambda." - } + "type": "string" }, "com.amazonaws.bedrockagentruntime#MaximumLength": { "type": "integer", "traits": { - "smithy.api#documentation": "Maximum length of output", "smithy.api#range": { "min": 0, "max": 4096 @@ -1378,45 +1438,62 @@ } }, "com.amazonaws.bedrockagentruntime#MimeType": { - "type": "string", - "traits": { - "smithy.api#documentation": "Content type of the request" - } + "type": "string" }, "com.amazonaws.bedrockagentruntime#ModelInvocationInput": { "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the trace.

" + } }, "text": { - "target": "com.amazonaws.bedrockagentruntime#PromptText" + "target": "com.amazonaws.bedrockagentruntime#PromptText", + "traits": { + "smithy.api#documentation": "

The text that prompted the agent at this step.

" + } }, "type": { - "target": "com.amazonaws.bedrockagentruntime#PromptType" + "target": "com.amazonaws.bedrockagentruntime#PromptType", + "traits": { + "smithy.api#documentation": "

The step in the agent sequence.

" + } }, "inferenceConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#InferenceConfiguration" + "target": "com.amazonaws.bedrockagentruntime#InferenceConfiguration", + "traits": { + "smithy.api#documentation": "

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

" + } }, "overrideLambda": { - "target": "com.amazonaws.bedrockagentruntime#LambdaArn" + "target": "com.amazonaws.bedrockagentruntime#LambdaArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.

" + } }, "promptCreationMode": { - "target": "com.amazonaws.bedrockagentruntime#CreationMode" + "target": "com.amazonaws.bedrockagentruntime#CreationMode", + "traits": { + "smithy.api#documentation": "

Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.

" + } }, "parserMode": { - "target": "com.amazonaws.bedrockagentruntime#CreationMode" + "target": "com.amazonaws.bedrockagentruntime#CreationMode", + "traits": { + "smithy.api#documentation": "

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.

" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information used to call Invoke Model", + "smithy.api#documentation": "

The input for the pre-processing step.

\n ", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#NextToken": { "type": "string", "traits": { - "smithy.api#documentation": "Opaque continuation token of previous paginated response.", "smithy.api#length": { "min": 1, "max": 2048 @@ -1427,7 +1504,6 @@ "com.amazonaws.bedrockagentruntime#NonBlankString": { "type": "string", "traits": { - "smithy.api#documentation": "Non Blank String", "smithy.api#pattern": "^[\\s\\S]*$" } }, @@ -1435,26 +1511,44 @@ "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the trace.

" + } }, "type": { - "target": "com.amazonaws.bedrockagentruntime#Type" + "target": "com.amazonaws.bedrockagentruntime#Type", + "traits": { + "smithy.api#documentation": "

Specifies what kind of information the agent returns in the observation. The following values are possible.

\n " + } }, "actionGroupInvocationOutput": { - "target": "com.amazonaws.bedrockagentruntime#ActionGroupInvocationOutput" + "target": "com.amazonaws.bedrockagentruntime#ActionGroupInvocationOutput", + "traits": { + "smithy.api#documentation": "

Contains the JSON-formatted string returned by the API invoked by the action group.

" + } }, "knowledgeBaseLookupOutput": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupOutput" + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupOutput", + "traits": { + "smithy.api#documentation": "

Contains details about the results from looking up the knowledge base.

" + } }, "finalResponse": { - "target": "com.amazonaws.bedrockagentruntime#FinalResponse" + "target": "com.amazonaws.bedrockagentruntime#FinalResponse", + "traits": { + "smithy.api#documentation": "

Contains details about the response to the user.

" + } }, "repromptResponse": { - "target": "com.amazonaws.bedrockagentruntime#RepromptResponse" + "target": "com.amazonaws.bedrockagentruntime#RepromptResponse", + "traits": { + "smithy.api#documentation": "

Contains details about the response to reprompt the input.

" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains output details for action group or knowledge base or final response", + "smithy.api#documentation": "

Contains the result or output of an action group or knowledge base, or the response to the user.

", "smithy.api#sensitive": {} } }, @@ -1462,27 +1556,38 @@ "type": "union", "members": { "rationale": { - "target": "com.amazonaws.bedrockagentruntime#Rationale" + "target": "com.amazonaws.bedrockagentruntime#Rationale", + "traits": { + "smithy.api#documentation": "

Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

" + } }, "invocationInput": { - "target": "com.amazonaws.bedrockagentruntime#InvocationInput" + "target": "com.amazonaws.bedrockagentruntime#InvocationInput", + "traits": { + "smithy.api#documentation": "

Contains information pertaining to the action group or knowledge base that is being invoked.

" + } }, "observation": { - "target": "com.amazonaws.bedrockagentruntime#Observation" + "target": "com.amazonaws.bedrockagentruntime#Observation", + "traits": { + "smithy.api#documentation": "

Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

" + } }, "modelInvocationInput": { - "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput" + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", + "traits": { + "smithy.api#documentation": "

The input for the orchestration step.

\n " + } } }, "traits": { - "smithy.api#documentation": "Trace contains intermidate response during orchestration", + "smithy.api#documentation": "

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#OutputString": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Output String", "smithy.api#sensitive": {} } }, @@ -1492,39 +1597,35 @@ "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Name of parameter" + "smithy.api#documentation": "

The name of the parameter.

" } }, "type": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Type of parameter" + "smithy.api#documentation": "

The type of the parameter.

" } }, "value": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Value of parameter" + "smithy.api#documentation": "

The value of the parameter.

" } } }, "traits": { - "smithy.api#documentation": "parameters included in action group invocation" + "smithy.api#documentation": "

A parameter in the Lambda input event.

" } }, "com.amazonaws.bedrockagentruntime#Parameters": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#Parameter" - }, - "traits": { - "smithy.api#documentation": "list of parameters included in action group invocation" } }, "com.amazonaws.bedrockagentruntime#PartBody": { "type": "blob", "traits": { - "smithy.api#documentation": "PartBody of the payload in bytes", "smithy.api#length": { "max": 1000000 }, @@ -1535,14 +1636,20 @@ "type": "structure", "members": { "bytes": { - "target": "com.amazonaws.bedrockagentruntime#PartBody" + "target": "com.amazonaws.bedrockagentruntime#PartBody", + "traits": { + "smithy.api#documentation": "

A part of the agent response in bytes.

" + } }, "attribution": { - "target": "com.amazonaws.bedrockagentruntime#Attribution" + "target": "com.amazonaws.bedrockagentruntime#Attribution", + "traits": { + "smithy.api#documentation": "

Contains citations for a part of an agent response.

" + } } }, "traits": { - "smithy.api#documentation": "Base 64 endoded byte response", + "smithy.api#documentation": "

Contains a part of an agent response and citations for it.

", "smithy.api#sensitive": {} } }, @@ -1550,14 +1657,20 @@ "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the trace.

" + } }, "parsedResponse": { - "target": "com.amazonaws.bedrockagentruntime#PostProcessingParsedResponse" + "target": "com.amazonaws.bedrockagentruntime#PostProcessingParsedResponse", + "traits": { + "smithy.api#documentation": "

Details about the response from the Lambda parsing of the output of the post-processing step.

" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information related to postprocessing", + "smithy.api#documentation": "

The foundation model output from the post-processing step.

", "smithy.api#sensitive": {} } }, @@ -1565,11 +1678,14 @@ "type": "structure", "members": { "text": { - "target": "com.amazonaws.bedrockagentruntime#OutputString" + "target": "com.amazonaws.bedrockagentruntime#OutputString", + "traits": { + "smithy.api#documentation": "

The text returned by the parser.

" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information if preprocessing was successful", + "smithy.api#documentation": "

Details about the response from the Lambda parsing of the output from the post-processing step.

", "smithy.api#sensitive": {} } }, @@ -1577,14 +1693,20 @@ "type": "union", "members": { "modelInvocationInput": { - "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput" + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", + "traits": { + "smithy.api#documentation": "

The input for the post-processing step.

\n " + } }, "modelInvocationOutput": { - "target": "com.amazonaws.bedrockagentruntime#PostProcessingModelInvocationOutput" + "target": "com.amazonaws.bedrockagentruntime#PostProcessingModelInvocationOutput", + "traits": { + "smithy.api#documentation": "

The foundation model output from the post-processing step.

" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information related to post processing step", + "smithy.api#documentation": "

Details about the post-processing step, in which the agent shapes the response.

", "smithy.api#sensitive": {} } }, @@ -1592,14 +1714,20 @@ "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the trace.

" + } }, "parsedResponse": { - "target": "com.amazonaws.bedrockagentruntime#PreProcessingParsedResponse" + "target": "com.amazonaws.bedrockagentruntime#PreProcessingParsedResponse", + "traits": { + "smithy.api#documentation": "

Details about the response from the Lambda parsing of the output of the pre-processing step.

" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information related to preprocessing", + "smithy.api#documentation": "

The foundation model output from the pre-processing step.

", "smithy.api#sensitive": {} } }, @@ -1607,17 +1735,20 @@ "type": "structure", "members": { "rationale": { - "target": "com.amazonaws.bedrockagentruntime#RationaleString" + "target": "com.amazonaws.bedrockagentruntime#RationaleString", + "traits": { + "smithy.api#documentation": "

The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.

" + } }, "isValid": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Boolean value" + "smithy.api#documentation": "

Whether the user input is valid or not. If false, the agent doesn't proceed to orchestration.

" } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information if preprocessing was successful", + "smithy.api#documentation": "

Details about the response from the Lambda parsing of the output from the pre-processing step.

", "smithy.api#sensitive": {} } }, @@ -1625,14 +1756,20 @@ "type": "union", "members": { "modelInvocationInput": { - "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput" + "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", + "traits": { + "smithy.api#documentation": "

The input for the pre-processing step.

\n " + } }, "modelInvocationOutput": { - "target": "com.amazonaws.bedrockagentruntime#PreProcessingModelInvocationOutput" + "target": "com.amazonaws.bedrockagentruntime#PreProcessingModelInvocationOutput", + "traits": { + "smithy.api#documentation": "

The foundation model output from the pre-processing step.

" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information related to preprocessing step", + "smithy.api#documentation": "

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

", "smithy.api#sensitive": {} } }, @@ -1643,15 +1780,11 @@ }, "value": { "target": "smithy.api#String" - }, - "traits": { - "smithy.api#documentation": "Session attributes that go to the prompt" } }, "com.amazonaws.bedrockagentruntime#PromptText": { "type": "string", "traits": { - "smithy.api#documentation": "Prompt Message", "smithy.api#sensitive": {} } }, @@ -1682,30 +1815,32 @@ "smithy.api#enumValue": "POST_PROCESSING" } } - }, - "traits": { - "smithy.api#documentation": "types of prompts" } }, "com.amazonaws.bedrockagentruntime#Rationale": { "type": "structure", "members": { "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId" + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the trace step.

" + } }, "text": { - "target": "com.amazonaws.bedrockagentruntime#RationaleString" + "target": "com.amazonaws.bedrockagentruntime#RationaleString", + "traits": { + "smithy.api#documentation": "

The reasoning or thought process of the agent, based on the input.

" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains information related to reasoning", + "smithy.api#documentation": "

Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RationaleString": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Rationale String", "smithy.api#sensitive": {} } }, @@ -1715,15 +1850,18 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Reprompt response text" + "smithy.api#documentation": "

The text reprompting the input.

" } }, "source": { - "target": "com.amazonaws.bedrockagentruntime#Source" + "target": "com.amazonaws.bedrockagentruntime#Source", + "traits": { + "smithy.api#documentation": "

Specifies what output is prompting the agent to reprompt the input.

" + } } }, "traits": { - "smithy.api#documentation": "Observation information if there were reprompts", + "smithy.api#documentation": "

Contains details about the agent's response to reprompt the input.

", "smithy.api#sensitive": {} } }, @@ -1731,11 +1869,14 @@ "type": "structure", "members": { "content": { - "target": "com.amazonaws.bedrockagentruntime#ContentMap" + "target": "com.amazonaws.bedrockagentruntime#ContentMap", + "traits": { + "smithy.api#documentation": "

The content in the request body.

" + } } }, "traits": { - "smithy.api#documentation": "Request Body Content Map" + "smithy.api#documentation": "

The parameters in the request body for the Lambda input event.

" } }, "com.amazonaws.bedrockagentruntime#ResourceNotFoundException": { @@ -1746,7 +1887,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a resource referenced by the operation does not exist", + "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1755,41 +1896,74 @@ "type": "union", "members": { "chunk": { - "target": "com.amazonaws.bedrockagentruntime#PayloadPart" + "target": "com.amazonaws.bedrockagentruntime#PayloadPart", + "traits": { + "smithy.api#documentation": "

Contains a part of an agent response and citations for it.

" + } }, "trace": { - "target": "com.amazonaws.bedrockagentruntime#TracePart" + "target": "com.amazonaws.bedrockagentruntime#TracePart", + "traits": { + "smithy.api#documentation": "

Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.

" + } }, "internalServerException": { - "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + "target": "com.amazonaws.bedrockagentruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "

An internal server error occurred. Retry your request.

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

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

" + } }, "resourceNotFoundException": { - "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", + "traits": { + "smithy.api#documentation": "

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

" + } }, "serviceQuotaExceededException": { - "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", + "traits": { + "smithy.api#documentation": "

The number of requests exceeds the service quota. Resubmit your request later.

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

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

" + } }, "accessDeniedException": { - "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", + "traits": { + "smithy.api#documentation": "

The request is denied because of missing access permissions. Check your permissions and retry your request.

" + } }, "conflictException": { - "target": "com.amazonaws.bedrockagentruntime#ConflictException" + "target": "com.amazonaws.bedrockagentruntime#ConflictException", + "traits": { + "smithy.api#documentation": "

There was a conflict performing an operation. Resolve the conflict and retry your request.

" + } }, "dependencyFailedException": { - "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", + "traits": { + "smithy.api#documentation": "

There was an issue with a dependency. Check the resource configurations and retry the request.

" + } }, "badGatewayException": { - "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", + "traits": { + "smithy.api#documentation": "

There was an issue with a dependency due to a server issue. Retry your request.

" + } } }, "traits": { - "smithy.api#documentation": "Response body of is a stream", + "smithy.api#documentation": "

The response from invoking the agent and associated citations and trace information.

", "smithy.api#streaming": {} } }, @@ -1799,13 +1973,13 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Content of a retrieval result in text", + "smithy.api#documentation": "

The cited text from the data source.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Content of a retrieval result.", + "smithy.api#documentation": "

Contains the cited text from the data source.

", "smithy.api#sensitive": {} } }, @@ -1815,15 +1989,19 @@ "type": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocationType", "traits": { + "smithy.api#documentation": "

The type of the location of the data source.

", "smithy.api#required": {} } }, "s3Location": { - "target": "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location" + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location", + "traits": { + "smithy.api#documentation": "

Contains the S3 location of the data source.

" + } } }, "traits": { - "smithy.api#documentation": "The source location of a retrieval result.", + "smithy.api#documentation": "

Contains information about the location of the data source.

", "smithy.api#sensitive": {} } }, @@ -1836,9 +2014,6 @@ "smithy.api#enumValue": "S3" } } - }, - "traits": { - "smithy.api#documentation": "The location type of a retrieval result." } }, "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location": { @@ -1847,12 +2022,12 @@ "uri": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "URI of S3 location" + "smithy.api#documentation": "

The S3 URI of the data source.

" } } }, "traits": { - "smithy.api#documentation": "The S3 location of a retrieval result." + "smithy.api#documentation": "

Contains the S3 location of the data source.

" } }, "com.amazonaws.bedrockagentruntime#Retrieve": { @@ -1893,7 +2068,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieve from knowledge base.", + "smithy.api#documentation": "

Queries a knowledge base and retrieves information from it.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1945,7 +2120,7 @@ } ], "traits": { - "smithy.api#documentation": "RetrieveAndGenerate API", + "smithy.api#documentation": "

Queries a knowledge base and generates responses based on the retrieved results. The response cites up to five sources but only selects the ones that are relevant to the query.

\n \n

The numberOfResults field is currently unsupported for RetrieveAndGenerate. Don't include it in the vectorSearchConfiguration object.

\n ", "smithy.api#http": { "code": 200, "method": "POST", @@ -1959,15 +2134,19 @@ "type": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateType", "traits": { + "smithy.api#documentation": "

The type of resource that is queried by the request.

", "smithy.api#required": {} } }, "knowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrieveAndGenerateConfiguration" + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about the resource being queried.

" + } } }, "traits": { - "smithy.api#documentation": "Configures the retrieval and generation for the session." + "smithy.api#documentation": "

Contains details about the resource being queried.

" } }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateInput": { @@ -1976,7 +2155,7 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Customer input of the turn in text", + "smithy.api#documentation": "

The query made to the knowledge base.

", "smithy.api#length": { "max": 1000 }, @@ -1985,7 +2164,7 @@ } }, "traits": { - "smithy.api#documentation": "Customer input of the turn", + "smithy.api#documentation": "

Contains the query made to the knowledge base.

", "smithy.api#sensitive": {} } }, @@ -1995,13 +2174,13 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service response of the turn in text", + "smithy.api#documentation": "

The response generated from querying the knowledge base.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Service response of the turn", + "smithy.api#documentation": "

Contains the response generated from querying the knowledge base.

", "smithy.api#sensitive": {} } }, @@ -2009,19 +2188,29 @@ "type": "structure", "members": { "sessionId": { - "target": "com.amazonaws.bedrockagentruntime#SessionId" + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.

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

Contains the query made to the knowledge base.

", "smithy.api#required": {} } }, "retrieveAndGenerateConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateConfiguration" + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about the resource being queried and the foundation model used for generation.

" + } }, "sessionConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateSessionConfiguration" + "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateSessionConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about the session with the knowledge base.

" + } } }, "traits": { @@ -2042,17 +2231,22 @@ "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { + "smithy.api#documentation": "

The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.

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

Contains the response generated from querying the knowledge base.

", "smithy.api#required": {} } }, "citations": { - "target": "com.amazonaws.bedrockagentruntime#Citations" + "target": "com.amazonaws.bedrockagentruntime#Citations", + "traits": { + "smithy.api#documentation": "

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

" + } } }, "traits": { @@ -2065,13 +2259,13 @@ "kmsKeyArn": { "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", "traits": { - "smithy.api#documentation": "The KMS key arn to encrypt the customer data of the session.", + "smithy.api#documentation": "

The ARN of the KMS key encrypting the session.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Configures common parameters of the session." + "smithy.api#documentation": "

Contains configuration about the session with the knowledge base.

" } }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateType": { @@ -2083,9 +2277,6 @@ "smithy.api#enumValue": "KNOWLEDGE_BASE" } } - }, - "traits": { - "smithy.api#documentation": "The type of RetrieveAndGenerate." } }, "com.amazonaws.bedrockagentruntime#RetrieveRequest": { @@ -2094,6 +2285,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to query.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2101,14 +2293,21 @@ "retrievalQuery": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseQuery", "traits": { + "smithy.api#documentation": "

The query to send the knowledge base.

", "smithy.api#required": {} } }, "retrievalConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration" + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about how the results should be returned.

" + } }, "nextToken": { - "target": "com.amazonaws.bedrockagentruntime#NextToken" + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

" + } } }, "traits": { @@ -2129,11 +2328,15 @@ "retrievalResults": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalResults", "traits": { + "smithy.api#documentation": "

A list of results from querying the knowledge base.

", "smithy.api#required": {} } }, "nextToken": { - "target": "com.amazonaws.bedrockagentruntime#NextToken" + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

" + } } }, "traits": { @@ -2144,23 +2347,26 @@ "type": "structure", "members": { "content": { - "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContent" + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContent", + "traits": { + "smithy.api#documentation": "

Contains the cited text from the data source.

" + } }, "location": { - "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation" + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation", + "traits": { + "smithy.api#documentation": "

Contains information about the location of the data source.

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

Contains metadata about a sources cited for the generated response.

" } }, "com.amazonaws.bedrockagentruntime#RetrievedReferences": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#RetrievedReference" - }, - "traits": { - "smithy.api#documentation": "list of retrieved references" } }, "com.amazonaws.bedrockagentruntime#SearchType": { @@ -2178,9 +2384,6 @@ "smithy.api#enumValue": "SEMANTIC" } } - }, - "traits": { - "smithy.api#documentation": "Query type to be performed on data store." } }, "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException": { @@ -2191,7 +2394,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a request is made beyond the service quota", + "smithy.api#documentation": "

The number of requests exceeds the service quota. Resubmit your request later.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2203,15 +2406,11 @@ }, "value": { "target": "smithy.api#String" - }, - "traits": { - "smithy.api#documentation": "Session attributes are pass through attributes passed to the action group" } }, "com.amazonaws.bedrockagentruntime#SessionId": { "type": "string", "traits": { - "smithy.api#documentation": "Identifier of the session.", "smithy.api#length": { "min": 2, "max": 100 @@ -2225,18 +2424,18 @@ "sessionAttributes": { "target": "com.amazonaws.bedrockagentruntime#SessionAttributesMap", "traits": { - "smithy.api#documentation": "Session Attributes" + "smithy.api#documentation": "

Contains attributes that persist across a session and the values of those attributes.

" } }, "promptSessionAttributes": { "target": "com.amazonaws.bedrockagentruntime#PromptSessionAttributesMap", "traits": { - "smithy.api#documentation": "Prompt Session Attributes" + "smithy.api#documentation": "

Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see Prompt template placeholder variables.

" } } }, "traits": { - "smithy.api#documentation": "Session state provided" + "smithy.api#documentation": "

Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Session context.

" } }, "com.amazonaws.bedrockagentruntime#Source": { @@ -2262,7 +2461,6 @@ } }, "traits": { - "smithy.api#documentation": "Parsing error source", "smithy.api#sensitive": {} } }, @@ -2272,7 +2470,7 @@ "start": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Start of span", + "smithy.api#documentation": "

Where the text with a citation starts in the generated output.

", "smithy.api#range": { "min": 0 } @@ -2281,7 +2479,7 @@ "end": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "End of span", + "smithy.api#documentation": "

Where the text with a citation ends in the generated output.

", "smithy.api#range": { "min": 0 } @@ -2289,7 +2487,7 @@ } }, "traits": { - "smithy.api#documentation": "Span of text" + "smithy.api#documentation": "

Contains information about where the text with a citation begins and ends in the generated output.

" } }, "com.amazonaws.bedrockagentruntime#StopSequences": { @@ -2298,7 +2496,6 @@ "target": "smithy.api#String" }, "traits": { - "smithy.api#documentation": "List of stop sequences", "smithy.api#length": { "min": 0, "max": 4 @@ -2308,7 +2505,6 @@ "com.amazonaws.bedrockagentruntime#Temperature": { "type": "float", "traits": { - "smithy.api#documentation": "Controls randomness, higher values increase diversity", "smithy.api#range": { "min": 0, "max": 1 @@ -2321,15 +2517,18 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Response part in text" + "smithy.api#documentation": "

The part of the generated text that contains a citation.

" } }, "span": { - "target": "com.amazonaws.bedrockagentruntime#Span" + "target": "com.amazonaws.bedrockagentruntime#Span", + "traits": { + "smithy.api#documentation": "

Contains information about where the text with a citation begins and ends in the generated output.

" + } } }, "traits": { - "smithy.api#documentation": "Text response part", + "smithy.api#documentation": "

Contains the part of the generated text that contains a citation, alongside where it begins and ends.

", "smithy.api#sensitive": {} } }, @@ -2341,7 +2540,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the number of requests exceeds the limit", + "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -2349,7 +2548,6 @@ "com.amazonaws.bedrockagentruntime#TopK": { "type": "integer", "traits": { - "smithy.api#documentation": "Sample from the k most likely next tokens", "smithy.api#range": { "min": 0, "max": 500 @@ -2359,7 +2557,6 @@ "com.amazonaws.bedrockagentruntime#TopP": { "type": "float", "traits": { - "smithy.api#documentation": "Cumulative probability cutoff for token selection", "smithy.api#range": { "min": 0, "max": 1 @@ -2370,27 +2567,38 @@ "type": "union", "members": { "preProcessingTrace": { - "target": "com.amazonaws.bedrockagentruntime#PreProcessingTrace" + "target": "com.amazonaws.bedrockagentruntime#PreProcessingTrace", + "traits": { + "smithy.api#documentation": "

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

" + } }, "orchestrationTrace": { - "target": "com.amazonaws.bedrockagentruntime#OrchestrationTrace" + "target": "com.amazonaws.bedrockagentruntime#OrchestrationTrace", + "traits": { + "smithy.api#documentation": "

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

" + } }, "postProcessingTrace": { - "target": "com.amazonaws.bedrockagentruntime#PostProcessingTrace" + "target": "com.amazonaws.bedrockagentruntime#PostProcessingTrace", + "traits": { + "smithy.api#documentation": "

Details about the post-processing step, in which the agent shapes the response..

" + } }, "failureTrace": { - "target": "com.amazonaws.bedrockagentruntime#FailureTrace" + "target": "com.amazonaws.bedrockagentruntime#FailureTrace", + "traits": { + "smithy.api#documentation": "

Contains information about the failure of the interaction.

" + } } }, "traits": { - "smithy.api#documentation": "Trace contains intermidate response for customer", + "smithy.api#documentation": "

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#TraceId": { "type": "string", "traits": { - "smithy.api#documentation": "Identifier for trace", "smithy.api#length": { "min": 2, "max": 16 @@ -2400,7 +2608,6 @@ "com.amazonaws.bedrockagentruntime#TraceKnowledgeBaseId": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group Knowledge Base Id", "smithy.api#sensitive": {} } }, @@ -2408,20 +2615,32 @@ "type": "structure", "members": { "agentId": { - "target": "com.amazonaws.bedrockagentruntime#AgentId" + "target": "com.amazonaws.bedrockagentruntime#AgentId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the agent.

" + } }, "agentAliasId": { - "target": "com.amazonaws.bedrockagentruntime#AgentAliasId" + "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the alias of the agent.

" + } }, "sessionId": { - "target": "com.amazonaws.bedrockagentruntime#SessionId" + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the session with the agent.

" + } }, "trace": { - "target": "com.amazonaws.bedrockagentruntime#Trace" + "target": "com.amazonaws.bedrockagentruntime#Trace", + "traits": { + "smithy.api#documentation": "

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

" + } } }, "traits": { - "smithy.api#documentation": "Trace Part which contains intermidate response for customer", + "smithy.api#documentation": "

Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

", "smithy.api#sensitive": {} } }, @@ -2458,9 +2677,6 @@ "smithy.api#enumValue": "REPROMPT" } } - }, - "traits": { - "smithy.api#documentation": "types of observations" } }, "com.amazonaws.bedrockagentruntime#ValidationException": { @@ -2471,7 +2687,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the request's input validation fails", + "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2479,7 +2695,6 @@ "com.amazonaws.bedrockagentruntime#Verb": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Trace Action Group Action verb", "smithy.api#sensitive": {} } } diff --git a/codegen/sdk-codegen/aws-models/cloudtrail.json b/codegen/sdk-codegen/aws-models/cloudtrail.json index b3f472e6ad8..20883be5d27 100644 --- a/codegen/sdk-codegen/aws-models/cloudtrail.json +++ b/codegen/sdk-codegen/aws-models/cloudtrail.json @@ -251,7 +251,7 @@ } }, "traits": { - "smithy.api#documentation": "

Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those\n events that are important to you. For more information about advanced event selectors, see\n Logging data events in the CloudTrail User Guide.

\n \n

You cannot apply both event selectors and advanced event selectors to a trail.

" + "smithy.api#documentation": "

Advanced event selectors let you create fine-grained selectors for CloudTrail management and data events. They help you control costs by logging only those\n events that are important to you. For more information about advanced event selectors, see\n Logging management events and \n Logging data events in the CloudTrail User Guide.

\n

You cannot apply both event selectors and advanced event selectors to a trail.

\n

\n Supported CloudTrail event record fields for management events\n

\n \n

\n Supported CloudTrail event record fields for data events\n

\n \n \n

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is\n eventCategory.

\n " } }, "com.amazonaws.cloudtrail#AdvancedEventSelectors": { @@ -266,7 +266,7 @@ "Field": { "target": "com.amazonaws.cloudtrail#SelectorField", "traits": { - "smithy.api#documentation": "

A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for\n selecting events as filtering is not supported.

\n

For CloudTrail management events, supported fields include readOnly,\n eventCategory, and eventSource.

\n

For CloudTrail data events, supported fields include readOnly,\n eventCategory, eventName, resources.type, and resources.ARN.

\n

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is\n eventCategory.

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

A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for\n selecting events as filtering is not supported.

\n

For CloudTrail management events, supported fields include readOnly,\n eventCategory, and eventSource.

\n

For CloudTrail data events, supported fields include readOnly,\n eventCategory, eventName, resources.type, and resources.ARN.

\n

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is\n eventCategory.

\n ", "smithy.api#required": {} } }, @@ -2302,6 +2302,9 @@ { "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, { "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" }, @@ -3112,6 +3115,9 @@ "target": "com.amazonaws.cloudtrail#DescribeTrailsResponse" }, "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, @@ -6089,6 +6095,9 @@ { "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, @@ -6802,7 +6811,7 @@ "AttributeValue": { "target": "com.amazonaws.cloudtrail#LookupAttributeValue", "traits": { - "smithy.api#documentation": "

Specifies a value for the specified AttributeKey.

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

Specifies a value for the specified AttributeKey.

\n

The maximum length for the AttributeValue is 2000 characters. The\n following characters ('_', ' ', ',',\n '\\\\n') count as two characters towards the 2000 character limit.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/codebuild.json b/codegen/sdk-codegen/aws-models/codebuild.json index 59dc8150881..9169566f101 100644 --- a/codegen/sdk-codegen/aws-models/codebuild.json +++ b/codegen/sdk-codegen/aws-models/codebuild.json @@ -7529,7 +7529,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts running a build.

" + "smithy.api#documentation": "

Starts running a build with the settings defined in the project. These setting include: how to run a build, \n where to get the source code, which build environment to use, which build commands to run, and where to store the build output.

\n

You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that \n specific start build request. The settings in the project are unaltered.

" } }, "com.amazonaws.codebuild#StartBuildBatch": { @@ -7840,7 +7840,7 @@ "buildspecOverride": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" + "smithy.api#documentation": "

A buildspec file declaration that overrides the latest one defined \n in the build project, for this build only. The buildspec defined on the project is not changed.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

\n \n

Since this property allows you to change the build commands that will run in the container, \n you should note that an IAM principal with the ability to call this API and set this parameter \n can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location \n like a file in your source repository or a Amazon S3 bucket.

\n " } }, "insecureSslOverride": { @@ -8873,7 +8873,7 @@ "type": { "target": "com.amazonaws.codebuild#WebhookFilterType", "traits": { - "smithy.api#documentation": "

The type of webhook filter. There are six webhook filter types: EVENT,\n ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF,\n FILE_PATH, and COMMIT_MESSAGE.

\n
\n
\n EVENT\n
\n
\n

A webhook event triggers a build when the provided pattern\n matches one of five event types: PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED,\n PULL_REQUEST_REOPENED, and\n PULL_REQUEST_MERGED. The EVENT patterns are\n specified as a comma-separated string. For example, PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull\n request created, and pull request updated events.

\n \n

The PULL_REQUEST_REOPENED works with GitHub and GitHub\n Enterprise only.

\n \n
\n
\n ACTOR_ACCOUNT_ID\n
\n
\n

A webhook event triggers a build when a GitHub, GitHub Enterprise, or\n Bitbucket account ID matches the regular expression pattern.\n

\n
\n
\n HEAD_REF\n
\n
\n

A webhook event triggers a build when the head reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name and refs/tags/tag-name.

\n

Works with GitHub and GitHub Enterprise push, GitHub and GitHub\n Enterprise pull request, Bitbucket push, and Bitbucket pull request events.\n

\n
\n
\n BASE_REF\n
\n
\n

A webhook event triggers a build when the base reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name.

\n \n

Works with pull request events only.

\n \n
\n
\n FILE_PATH\n
\n
\n

A webhook triggers a build when the path of a changed file matches the\n regular expression pattern.

\n \n

Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.

\n \n
\n
COMMIT_MESSAGE
\n
\n

A webhook triggers a build when the head commit message matches the\n regular expression pattern.

\n \n

Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.

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

The type of webhook filter. There are six webhook filter types: EVENT,\n ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF,\n FILE_PATH, and COMMIT_MESSAGE.

\n ", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/cognito-identity-provider.json b/codegen/sdk-codegen/aws-models/cognito-identity-provider.json index a321f56bc7c..5770dc03be0 100644 --- a/codegen/sdk-codegen/aws-models/cognito-identity-provider.json +++ b/codegen/sdk-codegen/aws-models/cognito-identity-provider.json @@ -1510,7 +1510,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -1586,7 +1586,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -1924,7 +1924,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -1962,7 +1962,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } } @@ -2081,7 +2081,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } } @@ -2144,7 +2144,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } } @@ -2210,7 +2210,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -2279,7 +2279,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } } @@ -2350,7 +2350,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } } @@ -2690,7 +2690,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -2777,7 +2777,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -2879,7 +2879,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -2965,7 +2965,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

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

Resets the specified user's password in a user pool as an administrator. Works on any\n user.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Deactivates a user's password, requiring them to change it. If a user tries to sign in\n after the API is called, Amazon Cognito responds with a\n PasswordResetRequiredException error. Your app must then perform the\n actions that reset your user's password: the forgot-password flow. In addition, if the\n user pool has phone verification selected and a verified phone number exists for the\n user, or if email verification is selected and a verified email exists for the user,\n calling this API will also result in sending a message to the end user with the code to\n change their password.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

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

Resets the specified user's password in a user pool as an administrator. Works on any\n user.

\n

To use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Deactivates a user's password, requiring them to change it. If a user tries to sign in\n after the API is called, Amazon Cognito responds with a\n PasswordResetRequiredException error. Your app must then perform the\n actions that reset your user's password: the forgot-password flow. In addition, if the\n user pool has phone verification selected and a verified phone number exists for the\n user, or if email verification is selected and a verified email exists for the user,\n calling this API will also result in sending a message to the end user with the code to\n change their password.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminResetUserPasswordRequest": { @@ -3047,7 +3047,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -3291,7 +3291,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -3362,7 +3362,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -3434,7 +3434,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -3507,7 +3507,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -3585,7 +3585,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -3682,7 +3682,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -3758,7 +3758,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } } @@ -4942,7 +4942,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -5072,7 +5072,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -8465,7 +8465,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Calling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering\n User Accounts in the Amazon Cognito Developer Guide. To\n use the confirmation code for resetting the password, call ConfirmForgotPassword.

\n

If neither a verified phone number nor a verified email exists, this API returns\n InvalidParameterException. If your app client has a client secret and\n you don't provide a SECRET_HASH parameter, this API returns\n NotAuthorizedException.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

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

Calling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering\n User Accounts in the Amazon Cognito Developer Guide. To\n use the confirmation code for resetting the password, call ConfirmForgotPassword.

\n

If neither a verified phone number nor a verified email exists, this API returns\n InvalidParameterException. If your app client has a client secret and\n you don't provide a SECRET_HASH parameter, this API returns\n NotAuthorizedException.

\n

To use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -8494,7 +8494,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -10909,7 +10909,7 @@ "Filter": { "target": "com.amazonaws.cognitoidentityprovider#UserFilterType", "traits": { - "smithy.api#documentation": "

A filter string of the form \"AttributeName\n Filter-Type \"AttributeValue\"\". Quotation marks\n within the filter string must be escaped using the backslash (\\) character. For example,\n \"family_name = \\\"Reddy\\\"\".

\n \n

If the filter string is empty, ListUsers returns all users in the user\n pool.

\n

You can only search for the following standard attributes:

\n \n

Custom attributes aren't searchable.

\n \n

You can also list users with a client-side filter. The server-side filter matches\n no more than one attribute. For an advanced search, use a client-side filter with\n the --query parameter of the list-users action in the\n CLI. When you use a client-side filter, ListUsers returns a paginated list of zero\n or more users. You can receive multiple pages in a row with zero results. Repeat the\n query with each pagination token that is returned until you receive a null\n pagination token value, and then review the combined result.

\n

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface\n User Guide.

\n \n

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer\n Guide.

" + "smithy.api#documentation": "

A filter string of the form \"AttributeName\n Filter-Type \"AttributeValue\"\". Quotation marks\n within the filter string must be escaped using the backslash (\\) character. For example,\n \"family_name = \\\"Reddy\\\"\".

\n \n

If the filter string is empty, ListUsers returns all users in the user\n pool.

\n

You can only search for the following standard attributes:

\n \n

Custom attributes aren't searchable.

\n \n

You can also list users with a client-side filter. The server-side filter matches\n no more than one attribute. For an advanced search, use a client-side filter with\n the --query parameter of the list-users action in the\n CLI. When you use a client-side filter, ListUsers returns a paginated list of zero\n or more users. You can receive multiple pages in a row with zero results. Repeat the\n query with each pagination token that is returned until you receive a null\n pagination token value, and then review the combined result.

\n

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface\n User Guide.

\n \n

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer\n Guide.

" } } }, @@ -11238,7 +11238,7 @@ "MaxValue": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The maximum value of an attribute that is of the number data type.

" + "smithy.api#documentation": "

The maximum length of a number attribute value. Must be a number less than or equal to\n 2^1023, represented as a string with a length of 131072 characters or\n fewer.

" } } }, @@ -11781,7 +11781,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, @@ -12797,6 +12797,9 @@ "target": "com.amazonaws.cognitoidentityprovider#SetUserPoolMfaConfigResponse" }, "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" + }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -13409,7 +13412,7 @@ "MaxLength": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The maximum length.

" + "smithy.api#documentation": "

The maximum length of a string attribute value. Must be a number less than or equal to\n 2^1023, represented as a string with a length of 131072 characters or\n fewer.

" } } }, @@ -13854,7 +13857,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The username of the user that you want to query or modify. The value of this parameter is typically your user's\nusername, but it can be any of their alias attributes. If username isn't an alias attribute in \nyour user pool, you can also use their sub in this request.

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

The username of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/guardduty.json b/codegen/sdk-codegen/aws-models/guardduty.json index 2a2021b95cb..ecf9db595c3 100644 --- a/codegen/sdk-codegen/aws-models/guardduty.json +++ b/codegen/sdk-codegen/aws-models/guardduty.json @@ -1770,7 +1770,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a single Amazon GuardDuty detector. A detector is a resource that represents the\n GuardDuty service. To start using GuardDuty, you must create a detector in each Region where\n you enable the service. You can have only one detector per account per Region. All data\n sources are enabled in a new detector by default.

\n

There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.

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

Creates a single GuardDuty detector. A detector is a resource that represents the\n GuardDuty service. To start using GuardDuty, you must create a detector in each Region where\n you enable the service. You can have only one detector per account per Region. All data\n sources are enabled in a new detector by default.

\n \n

Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)\n and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. \n You can add only one of these two features because Runtime Monitoring already includes the \n threat detection for Amazon EKS resources. For more information, see\n Runtime Monitoring.

\n

There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.

", "smithy.api#http": { "method": "POST", "uri": "/detector", @@ -3394,7 +3394,7 @@ "AutoEnableOrganizationMembers": { "target": "com.amazonaws.guardduty#AutoEnableMembers", "traits": { - "smithy.api#documentation": "

Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization.

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

Indicates the auto-enablement configuration of GuardDuty or any of the corresponding protection plans for the member accounts in the\n organization.

\n ", "smithy.api#jsonName": "autoEnableOrganizationMembers" } } @@ -3738,7 +3738,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about a GuardDuty feature.

" + "smithy.api#documentation": "

Contains information about a GuardDuty feature.

\n

Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)\n and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. \n You can add only one of these two features because Runtime Monitoring already includes the \n threat detection for Amazon EKS resources. For more information, see\n Runtime Monitoring.

" } }, "com.amazonaws.guardduty#DetectorFeatureConfigurationResult": { @@ -3774,7 +3774,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about a GuardDuty feature.

" + "smithy.api#documentation": "

Contains information about a GuardDuty feature.

\n

Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)\n and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. \n You can add only one of these two features because Runtime Monitoring already includes the \n threat detection for Amazon EKS resources. For more information, see\n Runtime Monitoring.

" } }, "com.amazonaws.guardduty#DetectorFeatureConfigurations": { @@ -6150,7 +6150,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves how many active member accounts \n in your Amazon Web Services organization have\n each feature enabled within GuardDuty. Only a delegated GuardDuty administrator of an organization can run this API.

\n

When you create a new Amazon Web Services organization, it might take up to 24 \n hours to generate the statistics for the entire organization.

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

Retrieves how many active member accounts have\n each feature enabled within GuardDuty. Only a delegated GuardDuty administrator of an organization can run this API.

\n

When you create a new organization, it might take up to 24 \n hours to generate the statistics for the entire organization.

", "smithy.api#http": { "method": "GET", "uri": "/organization/statistics", @@ -12706,7 +12706,7 @@ } ], "traits": { - "smithy.api#documentation": "

Initiates the malware scan. Invoking this API will automatically create the Service-linked role in \n the corresponding account.

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

Initiates the malware scan. Invoking this API will automatically create the Service-linked role in \n the corresponding account.

\n

When the malware scan starts, you can use the associated scan ID to track the status of the scan. For more information,\n see DescribeMalwareScans.

", "smithy.api#http": { "method": "POST", "uri": "/malware-scan/start", @@ -13459,7 +13459,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the GuardDuty detector specified by the detectorId.

\n

There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.

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

Updates the GuardDuty detector specified by the detector ID.

\n

Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)\n and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. \n You can add only one of these two features because Runtime Monitoring already includes the \n threat detection for Amazon EKS resources. For more information, see\n Runtime Monitoring.

\n

There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}", @@ -13851,7 +13851,7 @@ } ], "traits": { - "smithy.api#documentation": "

Contains information on member accounts to be updated.

\n

There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.

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

Contains information on member accounts to be updated.

\n

Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)\n and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. \n You can add only one of these two features because Runtime Monitoring already includes the \n threat detection for Amazon EKS resources. For more information, see\n Runtime Monitoring.

\n

There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member/detector/update", @@ -13936,7 +13936,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures the delegated administrator account with the provided values. You must provide\n a value for either autoEnableOrganizationMembers or autoEnable, but not both.

\n

There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.

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

Configures the delegated administrator account with the provided values. You must provide\n a value for either autoEnableOrganizationMembers or autoEnable, but not both.

\n

Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING)\n and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. \n You can add only one of these two features because Runtime Monitoring already includes the \n threat detection for Amazon EKS resources. For more information, see\n Runtime Monitoring.

\n

There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/admin", @@ -13986,7 +13986,7 @@ "AutoEnableOrganizationMembers": { "target": "com.amazonaws.guardduty#AutoEnableMembers", "traits": { - "smithy.api#documentation": "

Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.

\n

Use one of the \n following configuration values for autoEnableOrganizationMembers:

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

Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.

\n

Use one of the \n following configuration values for autoEnableOrganizationMembers:

\n ", "smithy.api#jsonName": "autoEnableOrganizationMembers" } } @@ -14309,6 +14309,18 @@ "traits": { "smithy.api#enumValue": "EC2_RUNTIME_MONITORING" } + }, + "RDS_DBI_PROTECTION_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_DBI_PROTECTION_PROVISIONED" + } + }, + "RDS_DBI_PROTECTION_SERVERLESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_DBI_PROTECTION_SERVERLESS" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/transfer.json b/codegen/sdk-codegen/aws-models/transfer.json index 138a2a7f110..8b653c0ee36 100644 --- a/codegen/sdk-codegen/aws-models/transfer.json +++ b/codegen/sdk-codegen/aws-models/transfer.json @@ -94,7 +94,7 @@ "EncryptionAlgorithm": { "target": "com.amazonaws.transfer#EncryptionAlg", "traits": { - "smithy.api#documentation": "

The algorithm that is used to encrypt the file.

\n \n

You can only specify NONE if the URL for your connector uses HTTPS. This ensures that\n no traffic is sent in clear text.

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

The algorithm that is used to encrypt the file.

\n

Note the following:

\n " } }, "SigningAlgorithm": { @@ -614,7 +614,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates the connector, which captures the parameters for a connection for the\n AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server.\n For more details about connectors, see Create AS2 connectors and Create SFTP connectors.

\n \n

You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).

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

Creates the connector, which captures the parameters for a connection for the\n AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server.\n For more details about connectors, see Configure AS2 connectors and Create SFTP connectors.

\n \n

You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).

\n " } }, "com.amazonaws.transfer#CreateConnectorRequest": { @@ -3289,6 +3289,12 @@ "smithy.api#enumValue": "AES256_CBC" } }, + "DES_EDE3_CBC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DES_EDE3_CBC" + } + }, "NONE": { "target": "smithy.api#Unit", "traits": { @@ -3314,7 +3320,7 @@ "AddressAllocationIds": { "target": "com.amazonaws.transfer#AddressAllocationIds", "traits": { - "smithy.api#documentation": "

A list of address allocation IDs that are required to attach an Elastic IP address to your\n server's endpoint.

\n \n

This property can only be set when EndpointType is set to VPC\n and it is only valid in the UpdateServer API.

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

A list of address allocation IDs that are required to attach an Elastic IP address to your\n server's endpoint.

\n

An address allocation ID corresponds to the allocation ID of an Elastic IP address. This\n value can be retrieved from the allocationId field from the Amazon EC2\n Address\n data type. One way to retrieve this value is by calling the EC2 DescribeAddresses API.

\n

This parameter is optional. Set this parameter if you want to make your VPC endpoint\n public-facing. For details, see Create an internet-facing endpoint for your server.

\n \n

This property can only be set as follows:

\n
    \n
  • \n

    \n EndpointType must be set to\n VPC\n

    \n
    • \n
  • \n

    The Transfer Family server must be offline.

    \n
    • \n
  • \n

    You cannot set this parameter for Transfer Family servers that use the FTP protocol.

    \n
    • \n
  • \n

    The server must already have SubnetIds populated (SubnetIds and AddressAllocationIds cannot be updated simultaneously).

    \n
    • \n
  • \n

    \n AddressAllocationIds can't contain duplicates, and must be equal in length to SubnetIds. For example,\n if you have three subnet IDs, you must also specify three address allocation IDs.

    \n
    • \n
  • \n

    Call the UpdateServer API to set or change this parameter.

    \n
    • \n
\n " } }, "SubnetIds": { @@ -6475,12 +6481,12 @@ "TrustedHostKeys": { "target": "com.amazonaws.transfer#SftpConnectorTrustedHostKeyList", "traits": { - "smithy.api#documentation": "

The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.\n You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

\n

The three standard SSH public key format elements are <key type>,\n <body base64>, and an optional <comment>, with spaces\n between each element. Specify only the <key type> and <body\n base64>: do not enter the <comment> portion of the key.

\n

For the trusted host key, Transfer Family accepts RSA and ECDSA keys.

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

The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.\n You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

\n

The three standard SSH public key format elements are <key type>,\n <body base64>, and an optional <comment>, with spaces\n between each element. Specify only the <key type> and <body\n base64>: do not enter the <comment> portion of the key.

\n

For the trusted host key, Transfer Family accepts RSA and ECDSA keys.

\n \n

Run this command to retrieve the SFTP server host key, where your SFTP server name is ftp.host.com.

\n

\n ssh-keyscan ftp.host.com\n

\n

This prints the public host key to standard output.

\n

\n ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key\n

\n

Copy and paste this string into the TrustedHostKeys field for the create-connector command or into the Trusted host keys field in the console.

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

Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a\n partner's SFTP server.

" + "smithy.api#documentation": "

Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a\n partner's SFTP server.

\n \n

Because the SftpConnectorConfig data type is used for both creating and updating SFTP connectors, its parameters,\n TrustedHostKeys and UserSecretId are marked as not required. This is a bit misleading, as they are not required when\n you are updating an existing SFTP connector, but are required when you are creating a new SFTP connector.

\n " } }, "com.amazonaws.transfer#SftpConnectorTrustedHostKey": { @@ -9162,7 +9168,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns new properties to a user. Parameters you pass modify any or all of the following:\n the home directory, role, and policy for the UserName and ServerId\n you specify.

\n

The response returns the ServerId and the UserName for the\n updated user.

" + "smithy.api#documentation": "

Assigns new properties to a user. Parameters you pass modify any or all of the following:\n the home directory, role, and policy for the UserName and ServerId\n you specify.

\n

The response returns the ServerId and the UserName for the\n updated user.

\n

In the console, you can select Restricted when you create or update a\n user. This ensures that the user can't access anything outside of their home directory. The\n programmatic way to configure this behavior is to update the user. Set their\n HomeDirectoryType to LOGICAL, and specify\n HomeDirectoryMappings with Entry as root (/) and\n Target as their home directory.

\n

For example, if the user's home directory is /test/admin-user, the following\n command updates the user so that their configuration in the console shows the\n Restricted flag as selected.

\n

\n aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings \"[{\\\"Entry\\\":\\\"/\\\", \\\"Target\\\":\\\"/test/admin-user\\\"}]\"\n

" } }, "com.amazonaws.transfer#UpdateUserRequest": {