Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
", "idempotent":true }, + "DisableBaseline":{ + "name":"DisableBaseline", + "http":{ + "method":"POST", + "requestUri":"/disable-baseline", + "responseCode":200 + }, + "input":{"shape":"DisableBaselineInput"}, + "output":{"shape":"DisableBaselineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline.
This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
" + "documentation":"This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
" + }, + "EnableBaseline":{ + "name":"EnableBaseline", + "http":{ + "method":"POST", + "requestUri":"/enable-baseline", + "responseCode":200 + }, + "input":{"shape":"EnableBaselineInput"}, + "output":{"shape":"EnableBaselineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target.
This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
" }, + "GetBaseline":{ + "name":"GetBaseline", + "http":{ + "method":"POST", + "requestUri":"/get-baseline", + "responseCode":200 + }, + "input":{"shape":"GetBaselineInput"}, + "output":{"shape":"GetBaselineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieve details about an existing Baseline resource by specifying its identifier.
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure.
Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Amazon Web Services Control Tower User Guide .
Retrieve details of an EnabledBaseline resource by specifying its identifier.
Returns the status of the specified landing zone operation. Details for an operation are available for 60 days.
" }, + "ListBaselines":{ + "name":"ListBaselines", + "http":{ + "method":"POST", + "requestUri":"/list-baselines", + "responseCode":200 + }, + "input":{"shape":"ListBaselinesInput"}, + "output":{"shape":"ListBaselinesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a summary list of all available baselines.
" + }, + "ListEnabledBaselines":{ + "name":"ListEnabledBaselines", + "http":{ + "method":"POST", + "requestUri":"/list-enabled-baselines", + "responseCode":200 + }, + "input":{"shape":"ListEnabledBaselinesInput"}, + "output":{"shape":"ListEnabledBaselinesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources.
Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
" }, + "ResetEnabledBaseline":{ + "name":"ResetEnabledBaseline", + "http":{ + "method":"POST", + "requestUri":"/reset-enabled-baseline", + "responseCode":200 + }, + "input":{"shape":"ResetEnabledBaselineInput"}, + "output":{"shape":"ResetEnabledBaselineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU.
Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
" }, + "UpdateEnabledBaseline":{ + "name":"UpdateEnabledBaseline", + "http":{ + "method":"POST", + "requestUri":"/update-enabled-baseline", + "responseCode":200 + }, + "input":{"shape":"UpdateEnabledBaselineInput"}, + "output":{"shape":"UpdateEnabledBaselineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Updates an EnabledBaseline resource's applied parameters or version.
The end time of the operation (if applicable), in ISO 8601 format.
" + }, + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"The identifier of the specified operation.
" + }, + "operationType":{ + "shape":"BaselineOperationType", + "documentation":"An enumerated type (enum) with possible values of ENABLE_BASELINE, DISABLE_BASELINE, UPDATE_ENABLED_BASELINE, or RESET_ENABLED_BASELINE.
The start time of the operation, in ISO 8601 format.
" + }, + "status":{ + "shape":"BaselineOperationStatus", + "documentation":"An enumerated type (enum) with possible values of SUCCEEDED, FAILED, or IN_PROGRESS.
A status message that gives more information about the operation's status, if applicable.
" + } + }, + "documentation":"An object of shape BaselineOperation, returning details about the specified Baseline operation ID.
The full ARN of a Baseline.
" + }, + "description":{ + "shape":"String", + "documentation":"A summary description of a Baseline.
" + }, + "name":{ + "shape":"String", + "documentation":"The human-readable name of a Baseline.
" + } + }, + "documentation":"Returns a summary of information about a Baseline object.
The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.
" + "documentation":"The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review The manifest file.
" }, "tags":{ "shape":"TagMap", @@ -443,6 +695,26 @@ } } }, + "DisableBaselineInput":{ + "type":"structure", + "required":["enabledBaselineIdentifier"], + "members":{ + "enabledBaselineIdentifier":{ + "shape":"Arn", + "documentation":"Identifier of the EnabledBaseline resource to be deactivated, in ARN format.
The ID (in UUID format) of the asynchronous DisableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the landing zone Region deny control. For information on how to find the controlIdentifier, see the overview page.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
The drift summary of the enabled control.
Amazon Web Services Control Tower expects the enabled control configuration to include all supported and governed Regions. If the enabled control differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.
" }, + "EnableBaselineInput":{ + "type":"structure", + "required":[ + "baselineIdentifier", + "baselineVersion", + "targetIdentifier" + ], + "members":{ + "baselineIdentifier":{ + "shape":"Arn", + "documentation":"The ARN of the baseline to be enabled.
" + }, + "baselineVersion":{ + "shape":"BaselineVersion", + "documentation":"The specific version to be enabled of the specified baseline.
" + }, + "parameters":{ + "shape":"EnabledBaselineParameters", + "documentation":"A list of key-value objects that specify enablement parameters, where key is a string and value is a document of any type.
Tags associated with input to EnableBaseline.
The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.
" + } + } + }, + "EnableBaselineOutput":{ + "type":"structure", + "required":[ + "arn", + "operationIdentifier" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The ARN of the EnabledBaseline resource.
The ID (in UUID format) of the asynchronous EnableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the landing zone Region deny control. For information on how to find the controlIdentifier, see the overview page.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
An array of EnabledControlParameter objects
A list of input parameter values, which are specified to configure the control when you enable it.
" }, "tags":{ "shape":"TagMap", @@ -534,6 +853,148 @@ } } }, + "EnabledBaselineBaselineIdentifiers":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":5, + "min":1 + }, + "EnabledBaselineDetails":{ + "type":"structure", + "required":[ + "arn", + "baselineIdentifier", + "statusSummary", + "targetIdentifier" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The ARN of the EnabledBaseline resource.
The specific Baseline enabled as part of the EnabledBaseline resource.
The enabled version of the Baseline.
Shows the parameters that are applied when enabling this Baseline.
The target on which to enable the Baseline.
Details of the EnabledBaseline resource.
Identifiers for the Baseline objects returned as part of the filter operation.
Identifiers for the targets of the Baseline filter operation.
A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
A string denoting the parameter key.
" + }, + "value":{ + "shape":"EnabledBaselineParameterDocument", + "documentation":"A low-level Document object of any type (for example, a Java Object).
A key-value parameter to an EnabledBaseline resource.
A string denoting the parameter key.
" + }, + "value":{ + "shape":"EnabledBaselineParameterDocument", + "documentation":"A low-level document object of any type (for example, a Java Object).
" + } + }, + "documentation":"Summary of an applied parameter to an EnabledBaseline resource.
The ARN of the EnabledBaseline resource
The specific baseline that is enabled as part of the EnabledBaseline resource.
The enabled version of the baseline.
" + }, + "statusSummary":{"shape":"EnablementStatusSummary"}, + "targetIdentifier":{ + "shape":"String", + "documentation":"The target upon which the baseline is enabled.
" + } + }, + "documentation":"Returns a summary of information about an EnabledBaseline object.
The key of a key/value pair. It is of type string.
The key of a key/value pair.
" }, "value":{ "shape":"Document", - "documentation":"The value of a key/value pair. It can be of type array string, number, object, or boolean.
The value of a key/value pair.
" } }, - "documentation":" A set of parameters that configure the behavior of the enabled control. A key/value pair, where Key is of type String and Value is of type Document.
A key/value pair, where Key is of type String and Value is of type Document.
The deployment summary of the enabled control.
" }, + "GetBaselineInput":{ + "type":"structure", + "required":["baselineIdentifier"], + "members":{ + "baselineIdentifier":{ + "shape":"BaselineArn", + "documentation":"The ARN of the Baseline resource to be retrieved.
The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).
" + } + } + }, + "GetBaselineOperationOutput":{ + "type":"structure", + "required":["baselineOperation"], + "members":{ + "baselineOperation":{ + "shape":"BaselineOperation", + "documentation":"A baselineOperation object that shows information about the specified operation ID.
The baseline ARN.
" + }, + "description":{ + "shape":"String", + "documentation":"A description of the baseline.
" + }, + "name":{ + "shape":"String", + "documentation":"A user-friendly name for the baseline.
" + } + } + }, "GetControlOperationInput":{ "type":"structure", "required":["operationIdentifier"], @@ -684,6 +1196,25 @@ } } }, + "GetEnabledBaselineInput":{ + "type":"structure", + "required":["enabledBaselineIdentifier"], + "members":{ + "enabledBaselineIdentifier":{ + "shape":"Arn", + "documentation":"Identifier of the EnabledBaseline resource to be retrieved, in ARN format.
Details of the EnabledBaseline resource.
The landing zone manifest JSON text file that specifies the landing zone configurations.
" + "documentation":"The landing zone manifest.yaml text file that specifies the landing zone configurations.
The landing zone deployment status.
" + "documentation":"The landing zone deployment status. One of ACTIVE, PROCESSING, FAILED.
The maximum number of results to be shown.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"A pagination token.
" + } + } + }, + "ListBaselinesMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":4 + }, + "ListBaselinesOutput":{ + "type":"structure", + "required":["baselines"], + "members":{ + "baselines":{ + "shape":"Baselines", + "documentation":"A list of Baseline object details.
A pagination token.
" + } + } + }, + "ListEnabledBaselinesInput":{ + "type":"structure", + "members":{ + "filter":{ + "shape":"EnabledBaselineFilter", + "documentation":"A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
The maximum number of results to be shown.
" + }, + "nextToken":{ + "shape":"ListEnabledBaselinesNextToken", + "documentation":"A pagination token.
" + } + } + }, + "ListEnabledBaselinesMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":5 + }, + "ListEnabledBaselinesNextToken":{ + "type":"string", + "pattern":"\\S+" + }, + "ListEnabledBaselinesOutput":{ + "type":"structure", + "required":["enabledBaselines"], + "members":{ + "enabledBaselines":{ + "shape":"EnabledBaselines", + "documentation":"Retuens a list of summaries of EnabledBaseline resources.
A pagination token.
" + } + } + }, "ListEnabledControlsInput":{ "type":"structure", "required":["targetIdentifier"], @@ -1004,6 +1609,26 @@ "max":50, "min":1 }, + "ResetEnabledBaselineInput":{ + "type":"structure", + "required":["enabledBaselineIdentifier"], + "members":{ + "enabledBaselineIdentifier":{ + "shape":"Arn", + "documentation":"Specifies the ID of the EnabledBaseline resource to be re-enabled, in ARN format.
The ID (in UUID format) of the asynchronous ResetEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The number of seconds to wait before retrying.
", + "documentation":"The number of seconds the caller should wait before retrying.
", "location":"header", "locationName":"Retry-After" }, "serviceCode":{ "shape":"String", - "documentation":"The ID of the service that is associated with the error.
" + "documentation":"The ID of the service that is associated with the error.
" } }, "documentation":"The request was denied due to request throttling.
", @@ -1170,6 +1795,37 @@ "members":{ } }, + "UpdateEnabledBaselineInput":{ + "type":"structure", + "required":[ + "baselineVersion", + "enabledBaselineIdentifier" + ], + "members":{ + "baselineVersion":{ + "shape":"BaselineVersion", + "documentation":"Specifies the new Baseline version, to which the EnabledBaseline should be updated.
Specifies the EnabledBaseline resource to be updated.
Parameters to apply when making an update.
" + } + } + }, + "UpdateEnabledBaselineOutput":{ + "type":"structure", + "required":["operationIdentifier"], + "members":{ + "operationIdentifier":{ + "shape":"OperationIdentifier", + "documentation":"The ID (in UUID format) of the asynchronous UpdateEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.
" + "documentation":"The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review The manifest file.
Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.
" + }, + "ModelDiagnosticsOutputConfiguration":{ + "shape":"ModelDiagnosticsOutputConfiguration", + "documentation":"The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics. You must also specify the RoleArn request parameter.
IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.
" + "documentation":"IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.
" }, "RoleArn":{ "shape":"IamRoleArn", @@ -2021,6 +2025,10 @@ "RetrainingSchedulerStatus":{ "shape":"RetrainingSchedulerStatus", "documentation":"Indicates the status of the retraining scheduler.
" + }, + "ModelDiagnosticsOutputConfiguration":{ + "shape":"ModelDiagnosticsOutputConfiguration", + "documentation":"Configuration information for the model's pointwise model diagnostics.
" } } }, @@ -2165,6 +2173,14 @@ "AutoPromotionResultReason":{ "shape":"AutoPromotionResultReason", "documentation":"Indicates the reason for the AutoPromotionResult. For example, a model might not be promoted if its performance was worse than the active version, if there was an error during training, or if the retraining scheduler was using MANUAL promote mode. The model will be promoted in MANAGED promote mode if the performance is better than the previous model.
The Amazon S3 location where Amazon Lookout for Equipment saves the pointwise model diagnostics for the model version.
" + }, + "ModelDiagnosticsResultsObject":{ + "shape":"S3Object", + "documentation":"The Amazon S3 output prefix for where Lookout for Equipment saves the pointwise model diagnostics for the model version.
" } } }, @@ -2766,7 +2782,7 @@ }, "SensorsWithShortDateRange":{ "shape":"SensorsWithShortDateRange", - "documentation":"Parameter that describes the total number of sensors that have a short date range of less than 90 days of data overall.
" + "documentation":"Parameter that describes the total number of sensors that have a short date range of less than 14 days of data overall.
" } }, "documentation":"Entity that comprises aggregated information on sensors having insufficient data.
" @@ -3109,7 +3125,7 @@ }, "InferenceExecutionSummaries":{ "shape":"InferenceExecutionSummaries", - "documentation":"Provides an array of information about the individual inference executions returned from the ListInferenceExecutions operation, including model used, inference scheduler, data configuration, and so on.
Provides an array of information about the individual inference executions returned from the ListInferenceExecutions operation, including model used, inference scheduler, data configuration, and so on.
If you don't supply the InferenceSchedulerName request parameter, or if you supply the name of an inference scheduler that doesn't exist, ListInferenceExecutions returns an empty array in InferenceExecutionSummaries.
Retruns the name of the label group.
" + "documentation":"Returns the name of the label group.
" }, "IntervalStartTime":{ "shape":"Timestamp", @@ -3224,7 +3240,7 @@ }, "LabelSummaries":{ "shape":"LabelSummaries", - "documentation":"A summary of the items in the label group.
" + "documentation":"A summary of the items in the label group.
If you don't supply the LabelGroupName request parameter, or if you supply the name of a label group that doesn't exist, ListLabels returns an empty array in LabelSummaries.
Provides information on the specified model version, including the created time, model and dataset ARNs, and status.
" + "documentation":"Provides information on the specified model version, including the created time, model and dataset ARNs, and status.
If you don't supply the ModelName request parameter, or if you supply the name of a model that doesn't exist, ListModelVersions returns an empty array in ModelVersionSummaries.
The Amazon S3 location for the pointwise model diagnostics.
" + }, + "KmsKeyId":{ + "shape":"NameOrArn", + "documentation":"The Amazon Web Services Key Management Service (KMS) key identifier to encrypt the pointwise model diagnostics files.
" + } + }, + "documentation":"Output configuration information for the pointwise model diagnostics for an Amazon Lookout for Equipment model.
" + }, + "ModelDiagnosticsS3OutputConfiguration":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"S3Bucket", + "documentation":"The name of the Amazon S3 bucket where the pointwise model diagnostics are located. You must be the owner of the Amazon S3 bucket.
" + }, + "Prefix":{ + "shape":"S3Prefix", + "documentation":"The Amazon S3 prefix for the location of the pointwise model diagnostics. The prefix specifies the folder and evaluation result file name. (bucket).
When you call CreateModel or UpdateModel, specify the path within the bucket that you want Lookout for Equipment to save the model to. During training, Lookout for Equipment creates the model evaluation model as a compressed JSON file with the name model_diagnostics_results.json.gz.
When you call DescribeModel or DescribeModelVersion, prefix contains the file path and filename of the model evaluation file.
The Amazon S3 location for the pointwise model diagnostics for an Amazon Lookout for Equipment model.
" + }, "ModelMetrics":{ "type":"string", "max":50000, @@ -3543,7 +3589,8 @@ "RetrainingSchedulerStatus":{ "shape":"RetrainingSchedulerStatus", "documentation":"Indicates the status of the retraining scheduler.
" - } + }, + "ModelDiagnosticsOutputConfiguration":{"shape":"ModelDiagnosticsOutputConfiguration"} }, "documentation":"Provides information about the specified machine learning model, including dataset and model names and ARNs, as well as status.
" }, @@ -3555,7 +3602,7 @@ "type":"string", "max":2048, "min":20, - "pattern":"^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+\\/.+\\/model-version\\/[0-9]{1,}$" + "pattern":"^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/[0-9a-zA-Z_-]{1,200}\\/.+\\/model-version\\/[0-9]{1,}$" }, "ModelVersionSourceType":{ "type":"string", @@ -3888,7 +3935,7 @@ "members":{ "AffectedSensorCount":{ "shape":"Integer", - "documentation":"Indicates the number of sensors that have less than 90 days of data.
" + "documentation":"Indicates the number of sensors that have less than 14 days of data.
" } }, "documentation":"Entity that comprises information on sensors that have shorter date range.
" @@ -4303,6 +4350,10 @@ "RoleArn":{ "shape":"IamRoleArn", "documentation":"The ARN of the model to update.
" + }, + "ModelDiagnosticsOutputConfiguration":{ + "shape":"ModelDiagnosticsOutputConfiguration", + "documentation":"The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics for the model. You must also specify the RoleArn request parameter.
Creates an Amazon Q index.
To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.
Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.
Creates an Amazon Q index.
To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.
Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.
Performs a logical OR operation on all supplied filters.
Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.
" + "documentation":"Enables filtering of responses based on document attributes or metadata fields.
" }, "AttributeFilters":{ "type":"list", @@ -1623,6 +1623,12 @@ "type":"boolean", "box":true }, + "BoostingDurationInSeconds":{ + "type":"long", + "box":true, + "max":999999999, + "min":0 + }, "ChatSyncInput":{ "type":"structure", "required":[ @@ -2351,6 +2357,21 @@ "type":"list", "member":{"shape":"DataSource"} }, + "DateAttributeBoostingConfiguration":{ + "type":"structure", + "required":["boostingLevel"], + "members":{ + "boostingDurationInSeconds":{ + "shape":"BoostingDurationInSeconds", + "documentation":"Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.
Specifies how much a document attribute is boosted.
" + } + }, + "documentation":"Provides information on boosting DATE type document attributes.
For more information on how boosting document attributes work in Amazon Q, see Boosting using document attributes.
" + }, "DeleteApplicationRequest":{ "type":"structure", "required":["applicationId"], @@ -2694,6 +2715,45 @@ }, "documentation":"A document attribute or metadata field.
" }, + "DocumentAttributeBoostingConfiguration":{ + "type":"structure", + "members":{ + "dateConfiguration":{ + "shape":"DateAttributeBoostingConfiguration", + "documentation":"Provides information on boosting DATE type document attributes.
Provides information on boosting NUMBER type document attributes.
Provides information on boosting STRING type document attributes.
Provides information on boosting STRING_LIST type document attributes.
Provides information on boosting supported Amazon Q document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q prioritizes generating responses from content that matches the boosted document attributes.
For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q, see Boosting using document attributes.
", + "union":true + }, + "DocumentAttributeBoostingLevel":{ + "type":"string", + "enum":[ + "NONE", + "LOW", + "MEDIUM", + "HIGH", + "VERY_HIGH" + ] + }, + "DocumentAttributeBoostingOverrideMap":{ + "type":"map", + "key":{"shape":"DocumentAttributeKey"}, + "value":{"shape":"DocumentAttributeBoostingConfiguration"}, + "min":1 + }, "DocumentAttributeCondition":{ "type":"structure", "required":[ @@ -2711,7 +2771,7 @@ }, "value":{"shape":"DocumentAttributeValue"} }, - "documentation":"The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q. You use this with DocumentAttributeTarget to apply the condition.
For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Q can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q then will map your newly created metadata field to your index field.
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q. You use this with DocumentAttributeTarget to apply the condition.
For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Q can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q then will map your newly created metadata field to your index field.
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q.
For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.
Amazon Q can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q will then map your newly created document attribute to your index field.
You can also use this with DocumentAttributeCondition .
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q.
For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.
Amazon Q can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q will then map your newly created document attribute to your index field.
You can also use this with DocumentAttributeCondition .
Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
" } }, - "documentation":"Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q.
You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.
If you want to apply advanced alterations on the Amazon Q structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.
You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
" + "documentation":"Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q.
You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.
If you want to apply advanced alterations on the Amazon Q structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.
You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
" }, "Index":{ "type":"structure", @@ -3744,7 +3804,7 @@ }, "target":{"shape":"DocumentAttributeTarget"} }, - "documentation":"Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q.
To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration .
For more information, see Custom document enrichment.
" + "documentation":"Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q.
To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration .
For more information, see Custom document enrichment.
" }, "InlineDocumentEnrichmentConfigurations":{ "type":"list", @@ -4567,7 +4627,11 @@ "FACTUALLY_CORRECT", "COMPLETE", "RELEVANT_SOURCES", - "HELPFUL" + "HELPFUL", + "NOT_BASED_ON_DOCUMENTS", + "NOT_COMPLETE", + "NOT_CONCISE", + "OTHER" ] }, "Messages":{ @@ -4582,6 +4646,10 @@ "type":"structure", "required":["indexId"], "members":{ + "boostingOverride":{ + "shape":"DocumentAttributeBoostingOverrideMap", + "documentation":"Overrides the default boosts applied by Amazon Q to supported document attribute data types.
" + }, "indexId":{ "shape":"IndexId", "documentation":"The identifier for the Amazon Q index.
" @@ -4594,6 +4662,28 @@ "max":800, "min":1 }, + "NumberAttributeBoostingConfiguration":{ + "type":"structure", + "required":["boostingLevel"], + "members":{ + "boostingLevel":{ + "shape":"DocumentAttributeBoostingLevel", + "documentation":"Specifies the duration, in seconds, of a boost applies to a NUMBER type document attribute.
Specifies how much a document attribute is boosted.
" + } + }, + "documentation":"Provides information on boosting NUMBER type document attributes.
For more information on how boosting document attributes work in Amazon Q, see Boosting using document attributes.
" + }, + "NumberAttributeBoostingType":{ + "type":"string", + "enum":[ + "PRIORITIZE_LARGER_VALUES", + "PRIORITIZE_SMALLER_VALUES" + ] + }, "OAuth2ClientCredentialConfiguration":{ "type":"structure", "required":[ @@ -4985,7 +5075,7 @@ }, "ruleType":{ "shape":"RuleType", - "documentation":"The type fo rule.
" + "documentation":"The type of rule.
" } }, "documentation":"Guardrail rules for an Amazon Q application. Amazon Q supports only one rule at a time.
" @@ -5244,6 +5334,48 @@ "max":2048, "min":1 }, + "StringAttributeBoostingConfiguration":{ + "type":"structure", + "required":["boostingLevel"], + "members":{ + "attributeValueBoosting":{ + "shape":"StringAttributeValueBoosting", + "documentation":"Specifies specific values of a STRING type document attribute being boosted.
Specifies how much a document attribute is boosted.
" + } + }, + "documentation":"Provides information on boosting STRING type document attributes.
For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q, see Boosting using document attributes.
" + }, + "StringAttributeValueBoosting":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"StringAttributeValueBoostingLevel"}, + "max":10, + "min":1 + }, + "StringAttributeValueBoostingLevel":{ + "type":"string", + "enum":[ + "LOW", + "MEDIUM", + "HIGH", + "VERY_HIGH" + ] + }, + "StringListAttributeBoostingConfiguration":{ + "type":"structure", + "required":["boostingLevel"], + "members":{ + "boostingLevel":{ + "shape":"DocumentAttributeBoostingLevel", + "documentation":"Specifies how much a document attribute is boosted.
" + } + }, + "documentation":"Provides information on boosting STRING_LIST type document attributes.
For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q, see Boosting using document attributes.
" + }, "SubnetId":{ "type":"string", "max":200, @@ -5396,7 +5528,7 @@ "members":{ "description":{ "shape":"TopicDescription", - "documentation":"A description for your topic control configuration. Use this outline how the large language model (LLM) should use this topic control configuration.
" + "documentation":"A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.
" }, "exampleChatMessages":{ "shape":"ExampleChatMessages", @@ -5995,5 +6127,5 @@ "member":{"shape":"WebExperience"} } }, - "documentation":"" + "documentation":"
Amazon Q is in preview release and is subject to change.
This is the Amazon Q (for business use) API Reference. Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q (for business use) Developer Guide .
For an overview of the Amazon Q APIs, see Overview of Amazon Q API operations.
For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q in the Amazon Q (for business use) Developer Guide.
You can use the following AWS SDKs to access Amazon Q APIs:
The following resources provide additional information about using the Amazon Q API:
" } diff --git a/docs/source/conf.py b/docs/source/conf.py index bc6b17d100..cea3c975ab 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.34.' # The full version, including alpha/beta/rc tags. -release = '1.34.41' +release = '1.34.42' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.