AWS bedrock documentation change
Summary
Expanded API request structure with new encryption configuration, notification settings, and status terminology updates
Security assessment
Added 'encryptionConfiguration' field with KMS key details demonstrates documentation of security controls for data encryption, but no evidence of addressing a specific vulnerability. Status terminology changes are operational improvements.
Diff
diff --git a/bedrock/latest/userguide/bda-using-api.md b/bedrock/latest/userguide/bda-using-api.md index 4d34159f6..54873b018 100644 --- a/bedrock/latest/userguide/bda-using-api.md +++ b/bedrock/latest/userguide/bda-using-api.md @@ -55 +55 @@ You have a project set up, you can start processing images using the InvokeDataA -This API call initiates the asynchronous processing of your files in a specified S3 bucket. The API accepts the project ARN and the location of the files to be processed, then starts the asynchronous processing job. A job ID is returned for tracking the process. Errors will be raised if the project doesn't exist, if the caller has the necessary permissions, or if the input files aren't in a supported format. +This API call initiates the asynchronous processing of your files in a specified S3 bucket. The API accepts the project ARN and the file to be processed, then starts the asynchronous processing job. A job ID is returned for tracking the process. Errors will be raised if the project doesn't exist, if the caller has the necessary permissions, or if the input files aren't in a supported format. @@ -61,7 +61,29 @@ The following is the structure of the JSON request: - "InputConfiguration" : { "s3Uri": "string"}, // required - "DataAutomationConfiguration" : { - "DataAutomationARN": "", - "stage": "LIVE" // or "DEV" - }, // optional - "BlueprintArn": [], // optional - "OutputConfiguration" : { + { + "blueprints": [ + { + "blueprintArn": "string", + "stage": "string", + "version": "string" + } + ], + "clientToken": "string", + "dataAutomationConfiguration": { + "dataAutomationProjectArn": "string", + "stage": "string" + }, + "dataAutomationProfileArn": "string", + "encryptionConfiguration": { + "kmsEncryptionContext": { + "string" : "string" + }, + "kmsKeyId": "string" + }, + "inputConfiguration": { + "s3Uri": "string" + }, + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": boolean + } + }, + "outputConfiguration": { @@ -69,4 +90,0 @@ The following is the structure of the JSON request: - }, // required - "EncryptionConfiguration": { // optional - "KmsKeyId": "string", - "KmsEncryptionContext": { "key" : "string" }, @@ -74,2 +92,6 @@ The following is the structure of the JSON request: - "NotificationConfiguration": { // optional - "EventBridgeConfiguration": {"EventBridgeEnabled" : Boolean }, + "tags": [ + { + "key": "sstring", + "value": "string" + } + ] @@ -77,2 +98,0 @@ The following is the structure of the JSON request: - "ClientToken": "string", - "JobTags": { "string" : "string" } @@ -86 +105 @@ To check the status of your processing job and retrieve results, use GetDataAuto -The GetDataAutomationStatus API allows you to monitor the progress of your job and access the results once processing is complete. The API accepts the job ID returned by InvokeDataAutomationAsync. It checks the current status of the job and returns relevant information. Once the job is complete, it provides the location of the results in S3. +The GetDataAutomationStatus API allows you to monitor the progress of your job and access the results once processing is complete. The API accepts the invocation ARN returned by InvokeDataAutomationAsync. It checks the current status of the job and returns relevant information. Once the job is complete, it provides the location of the results in S3. @@ -88 +107 @@ The GetDataAutomationStatus API allows you to monitor the progress of your job a -If the job is still in progress, it returns the current state (e.g., "RUNNING", "QUEUED"). If the job is complete, it returns "COMPLETED" along with the S3 location of the results. If there was an error, it returns "FAILED" with error details. +If the job is still in progress, it returns the current state (e.g., "InProgress"). If the job is complete, it returns "Success" along with the S3 location of the results. If there was an error, it returns "ServiceError" or "ClientError" with error details.