Skip to content

Commit 69ece5c

Browse files
author
awstools
committed
feat(client-bedrock-agent): Introduce a new parameter which represents the user-agent header value used by the Bedrock Knowledge Base Web Connector.
1 parent 2a8c44a commit 69ece5c

File tree

6 files changed

+39
-11
lines changed

6 files changed

+39
-11
lines changed

‎clients/client-bedrock-agent/src/commands/CreateDataSourceCommand.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
8080
* ],
8181
* scope: "HOST_ONLY" || "SUBDOMAINS",
8282
* userAgent: "STRING_VALUE",
83+
* userAgentHeader: "STRING_VALUE",
8384
* },
8485
* },
8586
* confluenceConfiguration: { // ConfluenceDataSourceConfiguration
@@ -256,6 +257,7 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
256257
* // ],
257258
* // scope: "HOST_ONLY" || "SUBDOMAINS",
258259
* // userAgent: "STRING_VALUE",
260+
* // userAgentHeader: "STRING_VALUE",
259261
* // },
260262
* // },
261263
* // confluenceConfiguration: { // ConfluenceDataSourceConfiguration

‎clients/client-bedrock-agent/src/commands/GetDataSourceCommand.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ export interface GetDataSourceCommandOutput extends GetDataSourceResponse, __Met
8484
* // ],
8585
* // scope: "HOST_ONLY" || "SUBDOMAINS",
8686
* // userAgent: "STRING_VALUE",
87+
* // userAgentHeader: "STRING_VALUE",
8788
* // },
8889
* // },
8990
* // confluenceConfiguration: { // ConfluenceDataSourceConfiguration

‎clients/client-bedrock-agent/src/commands/UpdateDataSourceCommand.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse,
8080
* ],
8181
* scope: "HOST_ONLY" || "SUBDOMAINS",
8282
* userAgent: "STRING_VALUE",
83+
* userAgentHeader: "STRING_VALUE",
8384
* },
8485
* },
8586
* confluenceConfiguration: { // ConfluenceDataSourceConfiguration
@@ -256,6 +257,7 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse,
256257
* // ],
257258
* // scope: "HOST_ONLY" || "SUBDOMAINS",
258259
* // userAgent: "STRING_VALUE",
260+
* // userAgentHeader: "STRING_VALUE",
259261
* // },
260262
* // },
261263
* // confluenceConfiguration: { // ConfluenceDataSourceConfiguration

‎clients/client-bedrock-agent/src/models/models_0.ts‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3455,13 +3455,19 @@ export interface WebCrawlerConfiguration {
34553455
scope?: WebScopeType | undefined;
34563456

34573457
/**
3458-
* <p>A string used for identifying the crawler or a bot when it accesses a web server. By default,
3459-
* this is set to <code>bedrockbot_UUID</code> for your crawler. You can optionally append a custom
3460-
* string to <code>bedrockbot_UUID</code> to allowlist a specific user agent permitted to access your source URLs.
3461-
* </p>
3458+
* <p>Returns the user agent suffix for your web crawler.</p>
34623459
* @public
34633460
*/
34643461
userAgent?: string | undefined;
3462+
3463+
/**
3464+
* <p>A string used for identifying the crawler or bot when it accesses a web server. The user agent header value
3465+
* consists of the <code>bedrockbot</code>, UUID, and a user agent suffix for your crawler (if one is provided).
3466+
* By default, it is set to <code>bedrockbot_UUID</code>. You can optionally append a custom
3467+
* suffix to <code>bedrockbot_UUID</code> to allowlist a specific user agent permitted to access your source URLs. </p>
3468+
* @public
3469+
*/
3470+
userAgentHeader?: string | undefined;
34653471
}
34663472

34673473
/**
@@ -3892,12 +3898,12 @@ export interface ParsingPrompt {
38923898
}
38933899

38943900
/**
3895-
* <p>Settings for a foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> used to parse documents for a data source.</p>
3901+
* <p>Settings for a foundation model used to parse documents for a data source.</p>
38963902
* @public
38973903
*/
38983904
export interface BedrockFoundationModelConfiguration {
38993905
/**
3900-
* <p>The ARN of the foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> to use for parsing.</p>
3906+
* <p>The ARN of the foundation model to use for parsing.</p>
39013907
* @public
39023908
*/
39033909
modelArn: string | undefined;
@@ -9681,6 +9687,7 @@ export const WebCrawlerConfigurationFilterSensitiveLog = (obj: WebCrawlerConfigu
96819687
...(obj.inclusionFilters && { inclusionFilters: SENSITIVE_STRING }),
96829688
...(obj.exclusionFilters && { exclusionFilters: SENSITIVE_STRING }),
96839689
...(obj.userAgent && { userAgent: SENSITIVE_STRING }),
9690+
...(obj.userAgentHeader && { userAgentHeader: SENSITIVE_STRING }),
96849691
});
96859692

96869693
/**

‎clients/client-bedrock-agent/src/models/models_1.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1068,7 +1068,7 @@ export interface SupplementalDataStorageConfiguration {
10681068
*/
10691069
export interface VectorKnowledgeBaseConfiguration {
10701070
/**
1071-
* <p>The Amazon Resource Name (ARN) of the model or inference profile used to create vector embeddings for the knowledge base.</p>
1071+
* <p>The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.</p>
10721072
* @public
10731073
*/
10741074
embeddingModelArn: string | undefined;

‎codegen/sdk-codegen/aws-models/bedrock-agent.json‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2449,7 +2449,7 @@
24492449
"modelArn": {
24502450
"target": "com.amazonaws.bedrockagent#BedrockModelArn",
24512451
"traits": {
2452-
"smithy.api#documentation": "<p>The ARN of the foundation model or <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html\">inference profile</a> to use for parsing.</p>",
2452+
"smithy.api#documentation": "<p>The ARN of the foundation model to use for parsing.</p>",
24532453
"smithy.api#required": {}
24542454
}
24552455
},
@@ -2467,7 +2467,7 @@
24672467
}
24682468
},
24692469
"traits": {
2470-
"smithy.api#documentation": "<p>Settings for a foundation model or <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html\">inference profile</a> used to parse documents for a data source.</p>"
2470+
"smithy.api#documentation": "<p>Settings for a foundation model used to parse documents for a data source.</p>"
24712471
}
24722472
},
24732473
"com.amazonaws.bedrockagent#BedrockModelArn": {
@@ -17373,6 +17373,16 @@
1737317373
"smithy.api#sensitive": {}
1737417374
}
1737517375
},
17376+
"com.amazonaws.bedrockagent#UserAgentHeader": {
17377+
"type": "string",
17378+
"traits": {
17379+
"smithy.api#length": {
17380+
"min": 61,
17381+
"max": 86
17382+
},
17383+
"smithy.api#sensitive": {}
17384+
}
17385+
},
1737617386
"com.amazonaws.bedrockagent#ValidateFlowDefinition": {
1737717387
"type": "operation",
1737817388
"input": {
@@ -17515,7 +17525,7 @@
1751517525
"embeddingModelArn": {
1751617526
"target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn",
1751717527
"traits": {
17518-
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the model or inference profile used to create vector embeddings for the knowledge base.</p>",
17528+
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.</p>",
1751917529
"smithy.api#required": {}
1752017530
}
1752117531
},
@@ -17590,7 +17600,13 @@
1759017600
"userAgent": {
1759117601
"target": "com.amazonaws.bedrockagent#UserAgent",
1759217602
"traits": {
17593-
"smithy.api#documentation": "<p>A string used for identifying the crawler or a bot when it accesses a web server. By default, \n this is set to <code>bedrockbot_UUID</code> for your crawler. You can optionally append a custom \n string to <code>bedrockbot_UUID</code> to allowlist a specific user agent permitted to access your source URLs. \n </p>"
17603+
"smithy.api#documentation": "<p>Returns the user agent suffix for your web crawler.</p>"
17604+
}
17605+
},
17606+
"userAgentHeader": {
17607+
"target": "com.amazonaws.bedrockagent#UserAgentHeader",
17608+
"traits": {
17609+
"smithy.api#documentation": "<p>A string used for identifying the crawler or bot when it accesses a web server. The user agent header value\n consists of the <code>bedrockbot</code>, UUID, and a user agent suffix for your crawler (if one is provided).\n By default, it is set to <code>bedrockbot_UUID</code>. You can optionally append a custom \n suffix to <code>bedrockbot_UUID</code> to allowlist a specific user agent permitted to access your source URLs. </p>"
1759417610
}
1759517611
}
1759617612
},

0 commit comments

Comments
 (0)