Invokes the specified Bedrock model to run inference using the input provided in the request body. \n You use InvokeModel to run inference for text models, image models, and embedding models.
\nFor more information about invoking models, see Using the API in the Bedrock User Guide.
\nFor example requests, see Examples (after the Errors section).
", + "smithy.api#documentation": "Invokes the specified Bedrock model to run inference using the input provided in the request body. \n You use InvokeModel to run inference for text models, image models, and embedding models.
\nFor more information, see Run inference in the Bedrock User Guide.
\nFor example requests, see Examples (after the Errors section).
", "smithy.api#http": { "code": 200, "method": "POST", @@ -786,7 +786,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" } }, "com.amazonaws.bedrockruntime#InvokeModelRequest": { @@ -892,7 +892,7 @@ } ], "traits": { - "smithy.api#documentation": "Invoke the specified Bedrock model to run inference using the input provided.\n Return the response in a stream.
\nFor more information about invoking models, see Using the API in the Bedrock User Guide.
\nFor an example request and response, see Examples (after the Errors section).
", + "smithy.api#documentation": "Invoke the specified Bedrock model to run inference using the input provided.\n Return the response in a stream.
\nFor more information, see Run inference in the Bedrock User Guide.
\nFor an example request and response, see Examples (after the Errors section).
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1104,6 +1104,9 @@ }, "throttlingException": { "target": "com.amazonaws.bedrockruntime#ThrottlingException" + }, + "modelTimeoutException": { + "target": "com.amazonaws.bedrockruntime#ModelTimeoutException" } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/bedrock.json b/codegen/sdk-codegen/aws-models/bedrock.json index 9bbba4caa64..d5bba06e1a0 100644 --- a/codegen/sdk-codegen/aws-models/bedrock.json +++ b/codegen/sdk-codegen/aws-models/bedrock.json @@ -780,6 +780,23 @@ "smithy.api#documentation": "CloudWatch logging configuration.
" } }, + "com.amazonaws.bedrock#CommitmentDuration": { + "type": "enum", + "members": { + "ONE_MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OneMonth" + } + }, + "SIX_MONTHS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SixMonths" + } + } + } + }, "com.amazonaws.bedrock#ConflictException": { "type": "structure", "members": { @@ -828,7 +845,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a fine-tuning job to customize a base model.
\nYou specify the base foundation model and the location of the training data.\n After the model-customization job completes successfully, your custom model resource will be ready to use. Training data\n contains input and output text for each record in a JSONL format. Optionally, you can specify validation data\n in the same format as the training data. Bedrock returns validation loss metrics and output generations \n after the job completes.\n
\n\n Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.\n To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.
For more information, see Custom models in the Bedrock User Guide.
", + "smithy.api#documentation": "Creates a fine-tuning job to customize a base model.
\nYou specify the base foundation model and the location of the training data.\n After the model-customization job completes successfully, your custom model resource will be ready to use. Training data\n contains input and output text for each record in a JSONL format. Optionally, you can specify validation data\n in the same format as the training data. Bedrock returns validation loss metrics and output generations\n after the job completes.\n
\n\n Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.\n To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.
For more information, see Custom models in the Bedrock User Guide.
", "smithy.api#http": { "code": 201, "method": "POST", @@ -860,7 +877,7 @@ "roleArn": { "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Bedrock can assume to perform tasks on your behalf.\n For example, during model training, Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket.\n To pass this role to Bedrock, the caller of this API must have the iam:PassRole permission.\n
The Amazon Resource Name (ARN) of an IAM role that Bedrock can assume to perform tasks on your behalf.\n For example, during model training, Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket.\n To pass this role to Bedrock, the caller of this API must have the iam:PassRole permission.\n
VPC configuration (optional). Configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for this job.
", + "smithy.api#documentation": "VPC configuration (optional). Configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for this job.
", "smithy.api#tags": [ "model-customization-vpc" ] @@ -955,6 +972,110 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a provisioned throughput with dedicated capacity for a foundation model or a fine-tuned model.
\nFor more information, see Provisioned throughput in the Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/provisioned-model-throughput" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "Unique token value that you can provide. If this token matches a previous request,\n Bedrock ignores the request, but does not return an error.
", + "smithy.api#idempotencyToken": {} + } + }, + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "Number of model units to allocate.
", + "smithy.api#required": {} + } + }, + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "Unique name for this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "Name or ARN of the model to associate with this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", + "traits": { + "smithy.api#documentation": "Commitment duration requested for the provisioned throughput.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "Tags to associate with this provisioned throughput.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse": { + "type": "structure", + "members": { + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "traits": { + "smithy.api#documentation": "The ARN for this provisioned throughput.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#CustomModelArn": { "type": "string", "traits": { @@ -1131,6 +1252,67 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/provisioned-model-throughput/{provisionedModelId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", + "traits": { + "smithy.api#documentation": "The ARN or name of the provisioned throughput.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#ErrorMessage": { "type": "string", "traits": { @@ -1552,7 +1734,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the properties associated with a model-customization job, including the status of the job.\n For more information, see Custom models in the Bedrock User Guide.
", + "smithy.api#documentation": "Retrieves the properties associated with a model-customization job, including the status of the job.\n For more information, see Custom models in the Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -1626,7 +1808,7 @@ "status": { "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", "traits": { - "smithy.api#documentation": "The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use.\n If the job failed, the failure message contains information about why the job failed.
" + "smithy.api#documentation": "The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use.\n If the job failed, the failure message contains information about why the job failed.
" } }, "failureMessage": { @@ -1769,6 +1951,153 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#GetProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get details for a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/provisioned-model-throughput/{provisionedModelId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", + "traits": { + "smithy.api#documentation": "The ARN or name of the provisioned throughput.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse": { + "type": "structure", + "members": { + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "The current number of model units requested to be available for this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "desiredModelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "The desired number of model units that was requested to be available for this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "The name of the provisioned throughput.
", + "smithy.api#required": {} + } + }, + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the provisioned throughput.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN or name of the model associated with this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "desiredModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the new model to asssociate with this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "foundationModelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "ARN of the foundation model.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "Status of the provisioned throughput.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the creation time for this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the last modified time of this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "Failure message for any issues that the create operation encounters.
" + } + }, + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", + "traits": { + "smithy.api#documentation": "Commitment duration of the provisioned throughput.
" + } + }, + "commitmentExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Commitment expiration time for the provisioned throughput.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#IdempotencyToken": { "type": "string", "traits": { @@ -2090,7 +2419,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria.
\nFor more information, see Custom models in the Bedrock User Guide.
", + "smithy.api#documentation": "Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria.
\nFor more information, see Custom models in the Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -2192,7 +2521,136 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrock#ListTagsForResource": { + "com.amazonaws.bedrock#ListProvisionedModelThroughputs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/provisioned-model-throughputs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "provisionedModelSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Return provisioned capacities created after the specified time.
", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Return provisioned capacities created before the specified time.
", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "Return the list of provisioned capacities that match the specified status.
", + "smithy.api#httpQuery": "statusEquals" + } + }, + "modelArnEquals": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "Return the list of provisioned capacities where their model ARN is equal to this parameter.
", + "smithy.api#httpQuery": "modelArnEquals" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "Return the list of provisioned capacities if their name contains these characters.
", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "THe maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "Continuation token from the previous response, for Bedrock to list the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortByProvisionedModels", + "traits": { + "smithy.api#documentation": "The field to sort by in the returned list of provisioned capacities.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order of the results.
", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "Continuation token for the next request to list the next set of results.
" + } + }, + "provisionedModelSummaries": { + "target": "com.amazonaws.bedrock#ProvisionedModelSummaries", + "traits": { + "smithy.api#documentation": "List of summaries, one for each provisioned throughput in the response.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.bedrock#ListTagsForResourceRequest" @@ -2500,7 +2958,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:amazon-bedrock:[a-zA-Z0-9-]*:(([0-9]{12})|(aws))?:(custom|built-in)-model/.+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" } }, "com.amazonaws.bedrock#ModelModality": { @@ -2593,14 +3051,186 @@ "smithy.api#pattern": "^\\S*$" } }, + "com.amazonaws.bedrock#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.bedrock#Provider": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z0-9-]{1,63}$" } }, + "com.amazonaws.bedrock#ProvisionedModelArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.bedrock#ProvisionedModelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ProvisionedModelSummary" + } + }, + "com.amazonaws.bedrock#ProvisionedModelSummary": { + "type": "structure", + "members": { + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "The name of the provisioned throughput.
", + "smithy.api#required": {} + } + }, + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the provisioned throughput.
", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the model associated with this provisioned throughput.
", + "smithy.api#required": {} + } + }, + "desiredModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "Desired model ARN.
", + "smithy.api#required": {} + } + }, + "foundationModelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "Foundation model ARN.
", + "smithy.api#required": {} + } + }, + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "The number of model units allocated.
", + "smithy.api#required": {} + } + }, + "desiredModelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "Desired model units.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "Status of the provisioned throughput.
", + "smithy.api#required": {} + } + }, + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", + "traits": { + "smithy.api#documentation": "Commitment duration for the provisioned throughput.
" + } + }, + "commitmentExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "Commitment expiration time for the provisioned throughput.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time that this provisioned throughput was created.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The time that this provisioned throughput was last modified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Set of fields associated with a provisioned throughput.
" + } + }, "com.amazonaws.bedrock#ProvisionedModelThroughputResource": { - "type": "resource" + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughput" + }, + { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughput" + }, + { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughput" + }, + { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputs" + }, + { + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughput" + } + ] }, "com.amazonaws.bedrock#PutModelInvocationLoggingConfiguration": { "type": "operation", @@ -2749,6 +3379,17 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.bedrock#SortByProvisionedModels": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, "com.amazonaws.bedrock#SortJobsBy": { "type": "enum", "members": { @@ -3024,7 +3665,7 @@ "min": 20, "max": 1011 }, - "smithy.api#pattern": "(^arn:aws(-[^:]+)?:amazon-bedrock:[a-zA-Z0-9-]*:[0-9]{12}:(fine-tuning-job|custom-model)/.+$)|([a-zA-Z0-9][a-zA-Z0-9\\-]*$)|(^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:([0-9]{12}|):(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(/[a-z0-9]{12})$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}$)" + "smithy.api#pattern": "(^[a-zA-Z0-9][a-zA-Z0-9\\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:provisioned-model/[a-z0-9]{12}$)))" } }, "com.amazonaws.bedrock#TaggingResource": { @@ -3074,7 +3715,7 @@ } }, "traits": { - "smithy.api#documentation": "The request contains more tags than can be associated with a resource (50 tags per resource). \n The maximum number of tags includes both existing tags and those included in your current request.
", + "smithy.api#documentation": "The request contains more tags than can be associated with a resource (50 tags per resource).\n The maximum number of tags includes both existing tags and those included in your current request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3191,6 +3832,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#UpdateProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/provisioned-model-throughput/{provisionedModelId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#UpdateProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", + "traits": { + "smithy.api#documentation": "The ARN or name of the provisioned throughput to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "desiredProvisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "The new name for this provisioned throughput.
" + } + }, + "desiredModelId": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The ARN of the new model to associate with this provisioned throughput.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#UpdateProvisionedModelThroughputResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#ValidationDataConfig": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index dfc92aa3a04..8d9b31253f2 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -64606,6 +64606,54 @@ "traits": { "smithy.api#enumValue": "mac2-m2pro.metal" } + }, + "r7iz_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.large" + } + }, + "r7iz_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.xlarge" + } + }, + "r7iz_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.2xlarge" + } + }, + "r7iz_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.4xlarge" + } + }, + "r7iz_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.8xlarge" + } + }, + "r7iz_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.12xlarge" + } + }, + "r7iz_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.16xlarge" + } + }, + "r7iz_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7iz.32xlarge" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/managedblockchain.json b/codegen/sdk-codegen/aws-models/managedblockchain.json index 3f1caebf716..391394c7562 100644 --- a/codegen/sdk-codegen/aws-models/managedblockchain.json +++ b/codegen/sdk-codegen/aws-models/managedblockchain.json @@ -612,7 +612,7 @@ "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "The unique identifier of the network for the node.
\nEthereum public networks have the following NetworkIds:
\n n-ethereum-mainnet\n
\n n-ethereum-goerli\n
\n n-ethereum-rinkeby\n
The unique identifier of the network for the node.
\nEthereum public networks have the following NetworkIds:
\n n-ethereum-mainnet\n
\n n-ethereum-goerli\n
The unique identifier of the network that the node is on.
\nEthereum public networks have the following NetworkIds:
\n n-ethereum-mainnet\n
\n n-ethereum-goerli\n
\n n-ethereum-rinkeby\n
The unique identifier of the network that the node is on.
\nEthereum public networks have the following NetworkIds:
\n n-ethereum-mainnet\n
\n n-ethereum-goerli\n
The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are as follows:
mainnet = 1\n
goerli = 5\n
rinkeby = 4\n
The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are as follows:
mainnet = 1\n
goerli = 5\n
The default root CA for new databases created by your Amazon Web Services account. This is either the root CA override \n set on your Amazon Web Services account or the system default CA for the Region if no override exists. To override the default CA, use the \n ModifyCertificates operation.
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
", + "smithy.api#documentation": "Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -19156,7 +19162,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether major version upgrades are allowed.
\nValid for Cluster Type: Aurora DB clusters only
\nConstraints:
\nYou must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.
Specifies whether major version upgrades are allowed.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nYou must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.
The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately in your request.
Default: Uses existing setting
" + "smithy.api#documentation": "The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately in your request.
Default: Uses existing setting
\nConstraints:
\nIf you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the \n specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to modify the DB instance class, \n and then run it again to upgrade the engine version.
\nThe version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS updates the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.
If the instance that you're modifying is acting as a read replica, the engine version\n that you specify must be the same or higher than the version that the source DB instance\n or cluster is running.
\nIn RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.
The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS updates the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.
If the instance that you're modifying is acting as a read replica, the engine version\n that you specify must be the same or higher than the version that the source DB instance\n or cluster is running.
\nIn RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.
Constraints:
\nIf you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the \n specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to modify the DB instance class, \n and then run it again to upgrade the engine version.
\nThe name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The name of the custom DB cluster parameter group to associate with this DB cluster.
\nIf the DBClusterParameterGroupName parameter is omitted, the default DB cluster parameter group for the specified\n engine is used.
Constraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DeletionProtection": { @@ -24526,7 +24532,7 @@ "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see \n DB instance class in the \n Amazon RDS User Guide.
\nValid for: Multi-AZ DB clusters only
" } }, "StorageType": { @@ -25404,7 +25410,7 @@ } ], "traits": { - "smithy.api#documentation": "Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
\nThe target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.
\nThis command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.
\nThis command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
The name of the new DB instance to be created.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe name of the new DB instance to create.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nThe date and time to restore from.
\nValid Values: Value must be a time in Universal Coordinated Time (UTC) format
\nConstraints:
\nMust be before the latest restorable time for the DB instance
\nCan't be specified if the UseLatestRestorableTime parameter is enabled
Example: 2009-09-07T23:45:00Z\n
The date and time to restore from.
\nConstraints:
\nMust be a time in Universal Coordinated Time (UTC) format.
\nMust be before the latest restorable time for the DB instance.
\nCan't be specified if the UseLatestRestorableTime parameter is enabled.
Example: 2009-09-07T23:45:00Z\n
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.
\nConstraints: Can't be specified if the RestoreTime parameter is provided.
Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.
\nConstraints:
\nCan't be specified if the RestoreTime parameter is provided.
The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.
\nDefault: The same DBInstanceClass as the original DB instance.
" + "smithy.api#documentation": "The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.
\nDefault: The same DB instance class as the original DB instance.
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the database accepts connections.
\nConstraints: Value must be 1150-65535\n
Default: The same port as the original DB instance.
" + "smithy.api#documentation": "The port number on which the database accepts connections.
\nDefault: The same port as the original DB instance.
\nConstraints:
\nThe value must be 1150-65535.
The Availability Zone (AZ) where the DB instance will be created.
\nDefault: A random, system-chosen Availability Zone.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a\n
The Availability Zone (AZ) where the DB instance will be created.
\nDefault: A random, system-chosen Availability Zone.
\nConstraints:
\nYou can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a\n
The DB subnet group name to use for the new instance.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mydbsubnetgroup\n
The DB subnet group name to use for the new instance.
\nConstraints:
\nIf supplied, must match the name of an existing DB subnet group.
\nExample: mydbsubnetgroup\n
A value that indicates whether the DB instance is a Multi-AZ deployment.
\nThis setting doesn't apply to RDS Custom.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a \n Multi-AZ deployment.
Secifies whether the DB instance is a Multi-AZ deployment.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nYou can't specify the AvailabilityZone parameter if the DB instance is a \n Multi-AZ deployment.
A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "Specifies whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specifies whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.
\nThis setting doesn't apply to RDS Custom.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "License model information for the restored DB instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Same as source.
\nValid values: license-included | bring-your-own-license | general-public-license\n
The license model information for the restored DB instance.
\nThis setting doesn't apply to RDS Custom.
\nValid Values: license-included | bring-your-own-license | general-public-license\n
Default: Same as the source.
" } }, "DBName": { @@ -25583,25 +25589,25 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nValid Values:
\n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
Default: The same as source
\nConstraints:
\nMust be compatible with the engine of the source.
\nThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
\nConstraints: Must be an integer greater than 1000.
\n\n SQL Server\n
\nSetting the IOPS value for the SQL Server database engine isn't supported.
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
\nThis setting doesn't apply to SQL Server.
\nConstraints:
\nMust be an integer greater than 1000.
\nThe name of the option group to be used for the restored DB instance.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The name of the option group to use for the restored DB instance.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
\nThis setting doesn't apply to RDS Custom.
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
" + "smithy.api#documentation": "Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
" } }, "Tags": { @@ -25610,7 +25616,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\nValid values: gp2 | gp3 | io1 | standard\n
If you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
The storage type to associate with the DB instance.
\nValid Values: gp2 | gp3 | io1 | standard\n
Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.
Constraints:
\nIf you specify io1 or gp3, you must also include a value for the\n Iops parameter.
Specify the Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nThis setting doesn't apply to RDS Custom.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nThis setting doesn't apply to RDS Custom.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" } }, "DomainIAMRoleName": { @@ -25670,7 +25676,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "EnableCloudwatchLogsExports": { @@ -25694,13 +25700,13 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match the name of an existing DB parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nA value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
" + "smithy.api#documentation": "Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.
" } }, "SourceDbiResourceId": { @@ -25718,13 +25724,13 @@ "SourceDBInstanceAutomatedBackupsArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } }, "CustomIamInstanceProfile": { @@ -25742,13 +25748,13 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
" + "smithy.api#documentation": "The network type of the DB instance.
\nThe network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n
\nValid Values:
\n\n IPV4\n
\n DUAL\n
Specifies the storage throughput value for the DB instance.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" + "smithy.api#documentation": "The storage throughput value for the DB instance.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora.
" } }, "AllocatedStorage": { diff --git a/codegen/sdk-codegen/aws-models/sso.json b/codegen/sdk-codegen/aws-models/sso.json index 9804c216731..5d32bc16399 100644 --- a/codegen/sdk-codegen/aws-models/sso.json +++ b/codegen/sdk-codegen/aws-models/sso.json @@ -760,6 +760,31 @@ ], "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://portal.sso.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [], "endpoint": { @@ -1233,7 +1258,7 @@ "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://portal.sso-fips.us-gov-east-1.amazonaws.com" + "url": "https://portal.sso.us-gov-east-1.amazonaws.com" } }, "params": { diff --git a/codegen/sdk-codegen/aws-models/sts.json b/codegen/sdk-codegen/aws-models/sts.json index d49956a1f71..ad261493c74 100644 --- a/codegen/sdk-codegen/aws-models/sts.json +++ b/codegen/sdk-codegen/aws-models/sts.json @@ -1665,9 +1665,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1684,10 +1684,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1", - "UseGlobalEndpoint": true + "Region": "ap-northeast-1" } }, { @@ -1697,9 +1697,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1716,10 +1716,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "ap-south-1", - "UseGlobalEndpoint": true + "Region": "ap-south-1" } }, { @@ -1729,9 +1729,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1748,10 +1748,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1", - "UseGlobalEndpoint": true + "Region": "ap-southeast-1" } }, { @@ -1761,9 +1761,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1780,10 +1780,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2", - "UseGlobalEndpoint": true + "Region": "ap-southeast-2" } }, { @@ -1793,9 +1793,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1812,10 +1812,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "aws-global", - "UseGlobalEndpoint": true + "Region": "aws-global" } }, { @@ -1825,9 +1825,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1844,10 +1844,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "ca-central-1", - "UseGlobalEndpoint": true + "Region": "ca-central-1" } }, { @@ -1857,9 +1857,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1876,10 +1876,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-1", - "UseGlobalEndpoint": true + "Region": "eu-central-1" } }, { @@ -1889,9 +1889,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1908,10 +1908,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "eu-north-1", - "UseGlobalEndpoint": true + "Region": "eu-north-1" } }, { @@ -1921,9 +1921,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1940,10 +1940,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1", - "UseGlobalEndpoint": true + "Region": "eu-west-1" } }, { @@ -1953,9 +1953,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -1972,10 +1972,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2", - "UseGlobalEndpoint": true + "Region": "eu-west-2" } }, { @@ -1985,9 +1985,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2004,10 +2004,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-3", - "UseGlobalEndpoint": true + "Region": "eu-west-3" } }, { @@ -2017,9 +2017,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2036,10 +2036,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "sa-east-1", - "UseGlobalEndpoint": true + "Region": "sa-east-1" } }, { @@ -2049,9 +2049,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2068,10 +2068,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", - "UseGlobalEndpoint": true + "Region": "us-east-1" } }, { @@ -2081,9 +2081,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2100,10 +2100,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-2", - "UseGlobalEndpoint": true + "Region": "us-east-2" } }, { @@ -2113,9 +2113,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2132,10 +2132,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-1", - "UseGlobalEndpoint": true + "Region": "us-west-1" } }, { @@ -2145,9 +2145,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-1", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2164,10 +2164,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-2", - "UseGlobalEndpoint": true + "Region": "us-west-2" } }, { @@ -2177,9 +2177,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", "signingRegion": "us-east-3", - "signingName": "sts" + "signingName": "sts", + "name": "sigv4" } ] }, @@ -2196,10 +2196,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-3", - "UseGlobalEndpoint": true + "Region": "us-east-3" } }, { @@ -2220,10 +2220,10 @@ } ], "params": { + "UseGlobalEndpoint": true, "UseDualStack": false, "UseFIPS": false, "Region": "us-west-1", - "UseGlobalEndpoint": true, "Endpoint": "https://example.com" } }, @@ -2235,10 +2235,10 @@ } }, "params": { + "UseGlobalEndpoint": false, "UseDualStack": false, "UseFIPS": false, - "Endpoint": "https://example.com", - "UseGlobalEndpoint": false + "Endpoint": "https://example.com" } } ], @@ -2339,7 +2339,7 @@ } }, "Policy": { - "target": "com.amazonaws.sts#sessionPolicyDocumentType", + "target": "com.amazonaws.sts#unrestrictedSessionPolicyDocumentType", "traits": { "smithy.api#documentation": "An IAM policy in JSON format that you want to use as an inline session policy.
\nThis parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nThe plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\nAn Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,\n and session tags into a packed binary format that has a separate limit. Your request can\n fail for this limit even if your plaintext meets the other requirements. The\n PackedPolicySize response element indicates by percentage how close the\n policies and tags for your request are to the upper size limit.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The HomeDirectory parameter is only used if HomeDirectoryType is set to LOGICAL.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The HomeDirectory parameter is only used if HomeDirectoryType is set to LOGICAL.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The HomeDirectory parameter is only used if HomeDirectoryType is set to LOGICAL.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The HomeDirectory parameter is only used if HomeDirectoryType is set to LOGICAL.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
", + "smithy.api#documentation": "This exception is thrown when an error occurs in the Transfer Family service.
", "smithy.api#error": "server", "smithy.api#httpError": 503 } @@ -4952,7 +4952,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "When you can get additional results from the ListUsers call, a\n NextToken parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken parameter to continue listing additional\n users.
If there are additional results from the ListUsers call, a\n NextToken parameter is returned in the output. You can then pass \n the NextToken to a subsequent ListUsers command, to continue listing additional\n users.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The HomeDirectory parameter is only used if HomeDirectoryType is set to LOGICAL.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The HomeDirectory parameter is only used if HomeDirectoryType is set to LOGICAL.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.
The requested resource does not exist.
", + "smithy.api#documentation": "The requested resource does not exist, or exists in a region other than the one specified for the command.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -6385,7 +6385,7 @@ "TrustedHostKeys": { "target": "com.amazonaws.transfer#SftpConnectorTrustedHostKeyList", "traits": { - "smithy.api#documentation": "The public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting. You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are , and an optional
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
\nFor RSA keys, the key type is ssh-rsa.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256,\n ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the\n size of the key you generated.
The public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting. You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are , and an optional
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
\nFor RSA keys, the key type is ssh-rsa.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256,\n ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the\n size of the key you generated.
Tests whether your SFTP connector is set up successfully. We highly recommend that you call this\n operation to test your ability to transfer files between a Transfer Family server and a trading partner's\n SFTP server.
" + "smithy.api#documentation": "Tests whether your SFTP connector is set up successfully. We highly recommend that you call this\n operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's\n SFTP server.
" } }, "com.amazonaws.transfer#TestConnectionRequest": { @@ -6983,7 +6983,7 @@ "StatusMessage": { "target": "com.amazonaws.transfer#Message", "traits": { - "smithy.api#documentation": "Returns Connection succeeded if the test is successful. Or, returns a descriptive error message \n if the test fails. The following list provides the details for some error messages and troubleshooting steps for each.
\n Unable to access secrets manager: Verify that your secret name aligns with the one in\n Transfer Role permissions.
\n\n Unknown Host/Connection failed: Verify the server URL in the connector\n configuration , and\n verify that the login credentials work successfully outside of the connector.
\n\n Private key not found: Verify that the secret exists and is formatted correctly.
\n\n Invalid trusted host keys: Verify that the trusted host key in the connector\n configuration matches the ssh-keyscan output.
Returns Connection succeeded if the test is successful. Or, returns a descriptive error message \n if the test fails. The following list provides troubleshooting details, depending on the error message that you receive.
Verify that your secret name aligns with the one in\n Transfer Role permissions.
\nVerify the server URL in the connector\n configuration , and verify that the login credentials work successfully outside of the connector.
\nVerify that the secret exists and is formatted correctly.
\nVerify that the trusted host key in the connector\n configuration matches the ssh-keyscan output.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The HomeDirectory parameter is only used if HomeDirectoryType is set to LOGICAL.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The HomeDirectory parameter is only used if HomeDirectoryType is set to LOGICAL.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.