@aws-sdk/client-bedrock-agentcore-control 3.982.0 → 3.984.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -0
- package/dist-cjs/index.js +176 -15
- package/dist-es/BedrockAgentCoreControl.js +10 -0
- package/dist-es/commands/CreateBrowserProfileCommand.js +16 -0
- package/dist-es/commands/DeleteBrowserProfileCommand.js +16 -0
- package/dist-es/commands/GetBrowserProfileCommand.js +16 -0
- package/dist-es/commands/ListBrowserProfilesCommand.js +16 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/enums.js +6 -0
- package/dist-es/pagination/ListBrowserProfilesPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +96 -15
- package/dist-types/BedrockAgentCoreControl.d.ts +36 -0
- package/dist-types/BedrockAgentCoreControlClient.d.ts +6 -2
- package/dist-types/commands/CreateBrowserProfileCommand.d.ts +100 -0
- package/dist-types/commands/CreatePolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBrowserProfileCommand.d.ts +97 -0
- package/dist-types/commands/DeletePolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetBrowserProfileCommand.d.ts +98 -0
- package/dist-types/commands/GetPolicyCommand.d.ts +1 -1
- package/dist-types/commands/ListBrowserProfilesCommand.d.ts +101 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/StartPolicyGenerationCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/enums.d.ts +14 -0
- package/dist-types/models/models_0.d.ts +252 -354
- package/dist-types/models/models_1.d.ts +350 -2
- package/dist-types/pagination/ListBrowserProfilesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +13 -0
- package/dist-types/ts3.4/BedrockAgentCoreControl.d.ts +76 -0
- package/dist-types/ts3.4/BedrockAgentCoreControlClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreateBrowserProfileCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreatePolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteBrowserProfileCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeletePolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetBrowserProfileCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetPolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListBrowserProfilesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartPolicyGenerationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/enums.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +59 -88
- package/dist-types/ts3.4/models/models_1.d.ts +88 -0
- package/dist-types/ts3.4/pagination/ListBrowserProfilesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +13 -0
- package/package.json +2 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import { AgentManagedRuntimeType, AgentRuntimeEndpointStatus, AgentRuntimeStatus, ApiKeyCredentialLocation, AuthorizerType, BrowserNetworkMode, BrowserStatus, ClaimMatchOperatorType, CodeInterpreterNetworkMode, CodeInterpreterStatus, CredentialProviderType, CredentialProviderVendorType, EvaluatorLevel, EvaluatorStatus, EvaluatorType, ExceptionLevel, FilterOperator, FindingType, GatewayInterceptionPoint, GatewayPolicyEngineMode, GatewayProtocolType, GatewayStatus, InboundTokenClaimValueType, KeyType, MemoryStatus, MemoryStrategyStatus, MemoryStrategyType, MemoryView, NetworkMode, OAuthGrantType, OnlineEvaluationConfigStatus, OnlineEvaluationExecutionStatus, OverrideType, PolicyEngineStatus, PolicyGenerationStatus,
|
|
2
|
+
import { AgentManagedRuntimeType, AgentRuntimeEndpointStatus, AgentRuntimeStatus, ApiKeyCredentialLocation, AuthorizerType, BrowserNetworkMode, BrowserProfileStatus, BrowserStatus, ClaimMatchOperatorType, CodeInterpreterNetworkMode, CodeInterpreterStatus, CredentialProviderType, CredentialProviderVendorType, EvaluatorLevel, EvaluatorStatus, EvaluatorType, ExceptionLevel, FilterOperator, FindingType, GatewayInterceptionPoint, GatewayPolicyEngineMode, GatewayProtocolType, GatewayStatus, InboundTokenClaimValueType, KeyType, MemoryStatus, MemoryStrategyStatus, MemoryStrategyType, MemoryView, NetworkMode, OAuthGrantType, OnlineEvaluationConfigStatus, OnlineEvaluationExecutionStatus, OverrideType, PolicyEngineStatus, PolicyGenerationStatus, ResourceType, RestApiMethod, SearchType, ServerProtocol, TargetStatus } from "./enums";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -1003,7 +1003,7 @@ export interface ListAgentRuntimesRequest {
|
|
|
1003
1003
|
nextToken?: string | undefined;
|
|
1004
1004
|
}
|
|
1005
1005
|
/**
|
|
1006
|
-
* <p>Contains information about an agent runtime. An agent runtime is the execution environment for a Amazon Bedrock Agent.</p>
|
|
1006
|
+
* <p>Contains information about an agent runtime. An agent runtime is the execution environment for a Amazon Bedrock AgentCore Agent.</p>
|
|
1007
1007
|
* @public
|
|
1008
1008
|
*/
|
|
1009
1009
|
export interface AgentRuntime {
|
|
@@ -1400,6 +1400,252 @@ export interface UpdateApiKeyCredentialProviderResponse {
|
|
|
1400
1400
|
*/
|
|
1401
1401
|
lastUpdatedTime: Date | undefined;
|
|
1402
1402
|
}
|
|
1403
|
+
/**
|
|
1404
|
+
* @public
|
|
1405
|
+
*/
|
|
1406
|
+
export interface CreateBrowserProfileRequest {
|
|
1407
|
+
/**
|
|
1408
|
+
* <p>The name of the browser profile. The name must be unique within your account and can contain alphanumeric characters and underscores.</p>
|
|
1409
|
+
* @public
|
|
1410
|
+
*/
|
|
1411
|
+
name: string | undefined;
|
|
1412
|
+
/**
|
|
1413
|
+
* <p>A description of the browser profile. Use this field to describe the purpose or contents of the profile.</p>
|
|
1414
|
+
* @public
|
|
1415
|
+
*/
|
|
1416
|
+
description?: string | undefined;
|
|
1417
|
+
/**
|
|
1418
|
+
* <p>A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.</p>
|
|
1419
|
+
* @public
|
|
1420
|
+
*/
|
|
1421
|
+
clientToken?: string | undefined;
|
|
1422
|
+
/**
|
|
1423
|
+
* <p>A map of tag keys and values to assign to the browser profile. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.</p>
|
|
1424
|
+
* @public
|
|
1425
|
+
*/
|
|
1426
|
+
tags?: Record<string, string> | undefined;
|
|
1427
|
+
}
|
|
1428
|
+
/**
|
|
1429
|
+
* @public
|
|
1430
|
+
*/
|
|
1431
|
+
export interface CreateBrowserProfileResponse {
|
|
1432
|
+
/**
|
|
1433
|
+
* <p>The unique identifier of the created browser profile.</p>
|
|
1434
|
+
* @public
|
|
1435
|
+
*/
|
|
1436
|
+
profileId: string | undefined;
|
|
1437
|
+
/**
|
|
1438
|
+
* <p>The Amazon Resource Name (ARN) of the created browser profile.</p>
|
|
1439
|
+
* @public
|
|
1440
|
+
*/
|
|
1441
|
+
profileArn: string | undefined;
|
|
1442
|
+
/**
|
|
1443
|
+
* <p>The timestamp when the browser profile was created.</p>
|
|
1444
|
+
* @public
|
|
1445
|
+
*/
|
|
1446
|
+
createdAt: Date | undefined;
|
|
1447
|
+
/**
|
|
1448
|
+
* <p>The current status of the browser profile.</p>
|
|
1449
|
+
* @public
|
|
1450
|
+
*/
|
|
1451
|
+
status: BrowserProfileStatus | undefined;
|
|
1452
|
+
}
|
|
1453
|
+
/**
|
|
1454
|
+
* @public
|
|
1455
|
+
*/
|
|
1456
|
+
export interface DeleteBrowserProfileRequest {
|
|
1457
|
+
/**
|
|
1458
|
+
* <p>The unique identifier of the browser profile to delete.</p>
|
|
1459
|
+
* @public
|
|
1460
|
+
*/
|
|
1461
|
+
profileId: string | undefined;
|
|
1462
|
+
/**
|
|
1463
|
+
* <p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1464
|
+
* @public
|
|
1465
|
+
*/
|
|
1466
|
+
clientToken?: string | undefined;
|
|
1467
|
+
}
|
|
1468
|
+
/**
|
|
1469
|
+
* @public
|
|
1470
|
+
*/
|
|
1471
|
+
export interface DeleteBrowserProfileResponse {
|
|
1472
|
+
/**
|
|
1473
|
+
* <p>The unique identifier of the deleted browser profile.</p>
|
|
1474
|
+
* @public
|
|
1475
|
+
*/
|
|
1476
|
+
profileId: string | undefined;
|
|
1477
|
+
/**
|
|
1478
|
+
* <p>The Amazon Resource Name (ARN) of the deleted browser profile.</p>
|
|
1479
|
+
* @public
|
|
1480
|
+
*/
|
|
1481
|
+
profileArn: string | undefined;
|
|
1482
|
+
/**
|
|
1483
|
+
* <p>The current status of the browser profile deletion.</p>
|
|
1484
|
+
* @public
|
|
1485
|
+
*/
|
|
1486
|
+
status: BrowserProfileStatus | undefined;
|
|
1487
|
+
/**
|
|
1488
|
+
* <p>The timestamp when the browser profile was last updated.</p>
|
|
1489
|
+
* @public
|
|
1490
|
+
*/
|
|
1491
|
+
lastUpdatedAt: Date | undefined;
|
|
1492
|
+
/**
|
|
1493
|
+
* <p>The timestamp when browser session data was last saved to this profile before deletion.</p>
|
|
1494
|
+
* @public
|
|
1495
|
+
*/
|
|
1496
|
+
lastSavedAt?: Date | undefined;
|
|
1497
|
+
}
|
|
1498
|
+
/**
|
|
1499
|
+
* @public
|
|
1500
|
+
*/
|
|
1501
|
+
export interface GetBrowserProfileRequest {
|
|
1502
|
+
/**
|
|
1503
|
+
* <p>The unique identifier of the browser profile to retrieve.</p>
|
|
1504
|
+
* @public
|
|
1505
|
+
*/
|
|
1506
|
+
profileId: string | undefined;
|
|
1507
|
+
}
|
|
1508
|
+
/**
|
|
1509
|
+
* @public
|
|
1510
|
+
*/
|
|
1511
|
+
export interface GetBrowserProfileResponse {
|
|
1512
|
+
/**
|
|
1513
|
+
* <p>The unique identifier of the browser profile.</p>
|
|
1514
|
+
* @public
|
|
1515
|
+
*/
|
|
1516
|
+
profileId: string | undefined;
|
|
1517
|
+
/**
|
|
1518
|
+
* <p>The Amazon Resource Name (ARN) of the browser profile.</p>
|
|
1519
|
+
* @public
|
|
1520
|
+
*/
|
|
1521
|
+
profileArn: string | undefined;
|
|
1522
|
+
/**
|
|
1523
|
+
* <p>The name of the browser profile.</p>
|
|
1524
|
+
* @public
|
|
1525
|
+
*/
|
|
1526
|
+
name: string | undefined;
|
|
1527
|
+
/**
|
|
1528
|
+
* <p>The description of the browser profile.</p>
|
|
1529
|
+
* @public
|
|
1530
|
+
*/
|
|
1531
|
+
description?: string | undefined;
|
|
1532
|
+
/**
|
|
1533
|
+
* <p>The current status of the browser profile.</p>
|
|
1534
|
+
* @public
|
|
1535
|
+
*/
|
|
1536
|
+
status: BrowserProfileStatus | undefined;
|
|
1537
|
+
/**
|
|
1538
|
+
* <p>The timestamp when the browser profile was created.</p>
|
|
1539
|
+
* @public
|
|
1540
|
+
*/
|
|
1541
|
+
createdAt: Date | undefined;
|
|
1542
|
+
/**
|
|
1543
|
+
* <p>The timestamp when the browser profile was last updated.</p>
|
|
1544
|
+
* @public
|
|
1545
|
+
*/
|
|
1546
|
+
lastUpdatedAt: Date | undefined;
|
|
1547
|
+
/**
|
|
1548
|
+
* <p>The timestamp when browser session data was last saved to this profile.</p>
|
|
1549
|
+
* @public
|
|
1550
|
+
*/
|
|
1551
|
+
lastSavedAt?: Date | undefined;
|
|
1552
|
+
/**
|
|
1553
|
+
* <p>The identifier of the browser session from which data was last saved to this profile.</p>
|
|
1554
|
+
* @public
|
|
1555
|
+
*/
|
|
1556
|
+
lastSavedBrowserSessionId?: string | undefined;
|
|
1557
|
+
/**
|
|
1558
|
+
* <p>The identifier of the browser from which data was last saved to this profile.</p>
|
|
1559
|
+
* @public
|
|
1560
|
+
*/
|
|
1561
|
+
lastSavedBrowserId?: string | undefined;
|
|
1562
|
+
}
|
|
1563
|
+
/**
|
|
1564
|
+
* @public
|
|
1565
|
+
*/
|
|
1566
|
+
export interface ListBrowserProfilesRequest {
|
|
1567
|
+
/**
|
|
1568
|
+
* <p>The maximum number of results to return in the response.</p>
|
|
1569
|
+
* @public
|
|
1570
|
+
*/
|
|
1571
|
+
maxResults?: number | undefined;
|
|
1572
|
+
/**
|
|
1573
|
+
* <p>A token to retrieve the next page of results.</p>
|
|
1574
|
+
* @public
|
|
1575
|
+
*/
|
|
1576
|
+
nextToken?: string | undefined;
|
|
1577
|
+
}
|
|
1578
|
+
/**
|
|
1579
|
+
* <p>Contains summary information about a browser profile. A browser profile stores persistent browser data that can be reused across browser sessions.</p>
|
|
1580
|
+
* @public
|
|
1581
|
+
*/
|
|
1582
|
+
export interface BrowserProfileSummary {
|
|
1583
|
+
/**
|
|
1584
|
+
* <p>The unique identifier of the browser profile.</p>
|
|
1585
|
+
* @public
|
|
1586
|
+
*/
|
|
1587
|
+
profileId: string | undefined;
|
|
1588
|
+
/**
|
|
1589
|
+
* <p>The Amazon Resource Name (ARN) of the browser profile.</p>
|
|
1590
|
+
* @public
|
|
1591
|
+
*/
|
|
1592
|
+
profileArn: string | undefined;
|
|
1593
|
+
/**
|
|
1594
|
+
* <p>The name of the browser profile.</p>
|
|
1595
|
+
* @public
|
|
1596
|
+
*/
|
|
1597
|
+
name: string | undefined;
|
|
1598
|
+
/**
|
|
1599
|
+
* <p>The description of the browser profile.</p>
|
|
1600
|
+
* @public
|
|
1601
|
+
*/
|
|
1602
|
+
description?: string | undefined;
|
|
1603
|
+
/**
|
|
1604
|
+
* <p>The current status of the browser profile. Possible values include READY, SAVING, DELETING, and DELETED.</p>
|
|
1605
|
+
* @public
|
|
1606
|
+
*/
|
|
1607
|
+
status: BrowserProfileStatus | undefined;
|
|
1608
|
+
/**
|
|
1609
|
+
* <p>The timestamp when the browser profile was created.</p>
|
|
1610
|
+
* @public
|
|
1611
|
+
*/
|
|
1612
|
+
createdAt: Date | undefined;
|
|
1613
|
+
/**
|
|
1614
|
+
* <p>The timestamp when the browser profile was last updated.</p>
|
|
1615
|
+
* @public
|
|
1616
|
+
*/
|
|
1617
|
+
lastUpdatedAt: Date | undefined;
|
|
1618
|
+
/**
|
|
1619
|
+
* <p>The timestamp when browser session data was last saved to this profile.</p>
|
|
1620
|
+
* @public
|
|
1621
|
+
*/
|
|
1622
|
+
lastSavedAt?: Date | undefined;
|
|
1623
|
+
/**
|
|
1624
|
+
* <p>The identifier of the browser session from which data was last saved to this profile.</p>
|
|
1625
|
+
* @public
|
|
1626
|
+
*/
|
|
1627
|
+
lastSavedBrowserSessionId?: string | undefined;
|
|
1628
|
+
/**
|
|
1629
|
+
* <p>The identifier of the browser from which data was last saved to this profile.</p>
|
|
1630
|
+
* @public
|
|
1631
|
+
*/
|
|
1632
|
+
lastSavedBrowserId?: string | undefined;
|
|
1633
|
+
}
|
|
1634
|
+
/**
|
|
1635
|
+
* @public
|
|
1636
|
+
*/
|
|
1637
|
+
export interface ListBrowserProfilesResponse {
|
|
1638
|
+
/**
|
|
1639
|
+
* <p>The list of browser profile summaries.</p>
|
|
1640
|
+
* @public
|
|
1641
|
+
*/
|
|
1642
|
+
profileSummaries: BrowserProfileSummary[] | undefined;
|
|
1643
|
+
/**
|
|
1644
|
+
* <p>A token to retrieve the next page of results.</p>
|
|
1645
|
+
* @public
|
|
1646
|
+
*/
|
|
1647
|
+
nextToken?: string | undefined;
|
|
1648
|
+
}
|
|
1403
1649
|
/**
|
|
1404
1650
|
* <p>Configuration for enabling browser signing capabilities that allow agents to cryptographically identify themselves to websites using HTTP message signatures.</p>
|
|
1405
1651
|
* @public
|
|
@@ -1478,7 +1724,7 @@ export interface CreateBrowserRequest {
|
|
|
1478
1724
|
*/
|
|
1479
1725
|
browserSigning?: BrowserSigningConfigInput | undefined;
|
|
1480
1726
|
/**
|
|
1481
|
-
* <p>A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but does not return an error.</p>
|
|
1727
|
+
* <p>A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.</p>
|
|
1482
1728
|
* @public
|
|
1483
1729
|
*/
|
|
1484
1730
|
clientToken?: string | undefined;
|
|
@@ -1655,7 +1901,7 @@ export interface ListBrowsersRequest {
|
|
|
1655
1901
|
type?: ResourceType | undefined;
|
|
1656
1902
|
}
|
|
1657
1903
|
/**
|
|
1658
|
-
* <p>Contains summary information about a browser. A browser enables Amazon Bedrock Agent to interact with web content.</p>
|
|
1904
|
+
* <p>Contains summary information about a browser. A browser enables Amazon Bedrock AgentCore Agent to interact with web content.</p>
|
|
1659
1905
|
* @public
|
|
1660
1906
|
*/
|
|
1661
1907
|
export interface BrowserSummary {
|
|
@@ -1751,7 +1997,7 @@ export interface CreateCodeInterpreterRequest {
|
|
|
1751
1997
|
*/
|
|
1752
1998
|
networkConfiguration: CodeInterpreterNetworkConfiguration | undefined;
|
|
1753
1999
|
/**
|
|
1754
|
-
* <p>A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but does not return an error.</p>
|
|
2000
|
+
* <p>A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.</p>
|
|
1755
2001
|
* @public
|
|
1756
2002
|
*/
|
|
1757
2003
|
clientToken?: string | undefined;
|
|
@@ -1907,7 +2153,7 @@ export interface ListCodeInterpretersRequest {
|
|
|
1907
2153
|
type?: ResourceType | undefined;
|
|
1908
2154
|
}
|
|
1909
2155
|
/**
|
|
1910
|
-
* <p>Contains summary information about a code interpreter. A code interpreter enables Amazon Bedrock Agent to execute code.</p>
|
|
2156
|
+
* <p>Contains summary information about a code interpreter. A code interpreter enables Amazon Bedrock AgentCore Agent to execute code.</p>
|
|
1911
2157
|
* @public
|
|
1912
2158
|
*/
|
|
1913
2159
|
export interface CodeInterpreterSummary {
|
|
@@ -7889,351 +8135,3 @@ export interface ListPolicyGenerationsResponse {
|
|
|
7889
8135
|
*/
|
|
7890
8136
|
nextToken?: string | undefined;
|
|
7891
8137
|
}
|
|
7892
|
-
/**
|
|
7893
|
-
* <p>Represents content input for policy generation operations. This structure encapsulates the natural language descriptions or other content formats that are used as input for AI-powered policy generation.</p>
|
|
7894
|
-
* @public
|
|
7895
|
-
*/
|
|
7896
|
-
export type Content = Content.RawTextMember | Content.$UnknownMember;
|
|
7897
|
-
/**
|
|
7898
|
-
* @public
|
|
7899
|
-
*/
|
|
7900
|
-
export declare namespace Content {
|
|
7901
|
-
/**
|
|
7902
|
-
* <p>The raw text content containing natural language descriptions of desired policy behavior. This text is processed by AI to generate corresponding Cedar policy statements that match the described intent.</p>
|
|
7903
|
-
* @public
|
|
7904
|
-
*/
|
|
7905
|
-
interface RawTextMember {
|
|
7906
|
-
rawText: string;
|
|
7907
|
-
$unknown?: never;
|
|
7908
|
-
}
|
|
7909
|
-
/**
|
|
7910
|
-
* @public
|
|
7911
|
-
*/
|
|
7912
|
-
interface $UnknownMember {
|
|
7913
|
-
rawText?: never;
|
|
7914
|
-
$unknown: [string, any];
|
|
7915
|
-
}
|
|
7916
|
-
/**
|
|
7917
|
-
* @deprecated unused in schema-serde mode.
|
|
7918
|
-
*
|
|
7919
|
-
*/
|
|
7920
|
-
interface Visitor<T> {
|
|
7921
|
-
rawText: (value: string) => T;
|
|
7922
|
-
_: (name: string, value: any) => T;
|
|
7923
|
-
}
|
|
7924
|
-
}
|
|
7925
|
-
/**
|
|
7926
|
-
* @public
|
|
7927
|
-
*/
|
|
7928
|
-
export interface StartPolicyGenerationRequest {
|
|
7929
|
-
/**
|
|
7930
|
-
* <p>The identifier of the policy engine that provides the context for policy generation. This engine's schema and tool context are used to ensure generated policies are valid and applicable.</p>
|
|
7931
|
-
* @public
|
|
7932
|
-
*/
|
|
7933
|
-
policyEngineId: string | undefined;
|
|
7934
|
-
/**
|
|
7935
|
-
* <p>The resource information that provides context for policy generation. This helps the AI understand the target resources and generate appropriate access control rules.</p>
|
|
7936
|
-
* @public
|
|
7937
|
-
*/
|
|
7938
|
-
resource: Resource | undefined;
|
|
7939
|
-
/**
|
|
7940
|
-
* <p>The natural language description of the desired policy behavior. This content is processed by AI to generate corresponding Cedar policy statements that match the described intent.</p>
|
|
7941
|
-
* @public
|
|
7942
|
-
*/
|
|
7943
|
-
content: Content | undefined;
|
|
7944
|
-
/**
|
|
7945
|
-
* <p>A customer-assigned name for the policy generation request. This helps track and identify generation operations, especially when running multiple generations simultaneously.</p>
|
|
7946
|
-
* @public
|
|
7947
|
-
*/
|
|
7948
|
-
name: string | undefined;
|
|
7949
|
-
/**
|
|
7950
|
-
* <p>A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without starting a duplicate generation.</p>
|
|
7951
|
-
* @public
|
|
7952
|
-
*/
|
|
7953
|
-
clientToken?: string | undefined;
|
|
7954
|
-
}
|
|
7955
|
-
/**
|
|
7956
|
-
* @public
|
|
7957
|
-
*/
|
|
7958
|
-
export interface StartPolicyGenerationResponse {
|
|
7959
|
-
/**
|
|
7960
|
-
* <p>The identifier of the policy engine associated with the started policy generation. </p>
|
|
7961
|
-
* @public
|
|
7962
|
-
*/
|
|
7963
|
-
policyEngineId: string | undefined;
|
|
7964
|
-
/**
|
|
7965
|
-
* <p>The unique identifier assigned to the policy generation request for tracking progress. </p>
|
|
7966
|
-
* @public
|
|
7967
|
-
*/
|
|
7968
|
-
policyGenerationId: string | undefined;
|
|
7969
|
-
/**
|
|
7970
|
-
* <p>The customer-assigned name for the policy generation request.</p>
|
|
7971
|
-
* @public
|
|
7972
|
-
*/
|
|
7973
|
-
name: string | undefined;
|
|
7974
|
-
/**
|
|
7975
|
-
* <p>The ARN of the created policy generation request.</p>
|
|
7976
|
-
* @public
|
|
7977
|
-
*/
|
|
7978
|
-
policyGenerationArn: string | undefined;
|
|
7979
|
-
/**
|
|
7980
|
-
* <p>The resource information associated with the policy generation request.</p>
|
|
7981
|
-
* @public
|
|
7982
|
-
*/
|
|
7983
|
-
resource: Resource | undefined;
|
|
7984
|
-
/**
|
|
7985
|
-
* <p>The timestamp when the policy generation request was created.</p>
|
|
7986
|
-
* @public
|
|
7987
|
-
*/
|
|
7988
|
-
createdAt: Date | undefined;
|
|
7989
|
-
/**
|
|
7990
|
-
* <p>The timestamp when the policy generation was last updated.</p>
|
|
7991
|
-
* @public
|
|
7992
|
-
*/
|
|
7993
|
-
updatedAt: Date | undefined;
|
|
7994
|
-
/**
|
|
7995
|
-
* <p>The initial status of the policy generation request.</p>
|
|
7996
|
-
* @public
|
|
7997
|
-
*/
|
|
7998
|
-
status: PolicyGenerationStatus | undefined;
|
|
7999
|
-
/**
|
|
8000
|
-
* <p>Additional information about the generation status.</p>
|
|
8001
|
-
* @public
|
|
8002
|
-
*/
|
|
8003
|
-
statusReasons: string[] | undefined;
|
|
8004
|
-
/**
|
|
8005
|
-
* <p>Initial findings from the policy generation process.</p>
|
|
8006
|
-
* @public
|
|
8007
|
-
*/
|
|
8008
|
-
findings?: string | undefined;
|
|
8009
|
-
}
|
|
8010
|
-
/**
|
|
8011
|
-
* @public
|
|
8012
|
-
*/
|
|
8013
|
-
export interface CreatePolicyRequest {
|
|
8014
|
-
/**
|
|
8015
|
-
* <p>The customer-assigned immutable name for the policy. Must be unique within the account. This name is used for policy identification and cannot be changed after creation.</p>
|
|
8016
|
-
* @public
|
|
8017
|
-
*/
|
|
8018
|
-
name: string | undefined;
|
|
8019
|
-
/**
|
|
8020
|
-
* <p>The Cedar policy statement that defines the access control rules. This contains the actual policy logic written in Cedar policy language, specifying effect (permit or forbid), principals, actions, resources, and conditions for agent behavior control.</p>
|
|
8021
|
-
* @public
|
|
8022
|
-
*/
|
|
8023
|
-
definition: PolicyDefinition | undefined;
|
|
8024
|
-
/**
|
|
8025
|
-
* <p>A human-readable description of the policy's purpose and functionality (1-4,096 characters). This helps policy administrators understand the policy's intent, business rules, and operational scope. Use this field to document why the policy exists, what business requirement it addresses, and any special considerations for maintenance. Clear descriptions are essential for policy governance, auditing, and troubleshooting.</p>
|
|
8026
|
-
* @public
|
|
8027
|
-
*/
|
|
8028
|
-
description?: string | undefined;
|
|
8029
|
-
/**
|
|
8030
|
-
* <p>The validation mode for the policy creation. Determines how Cedar analyzer validation results are handled during policy creation. FAIL_ON_ANY_FINDINGS (default) runs the Cedar analyzer to validate the policy against the Cedar schema and tool context, failing creation if the analyzer detects any validation issues to ensure strict conformance. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows policy creation even if validation issues are detected, useful for testing or when the policy schema is evolving. Use FAIL_ON_ANY_FINDINGS for production policies to ensure correctness, and IGNORE_ALL_FINDINGS only when you understand and accept the analyzer findings.</p>
|
|
8031
|
-
* @public
|
|
8032
|
-
*/
|
|
8033
|
-
validationMode?: PolicyValidationMode | undefined;
|
|
8034
|
-
/**
|
|
8035
|
-
* <p>The identifier of the policy engine which contains this policy. Policy engines group related policies and provide the execution context for policy evaluation.</p>
|
|
8036
|
-
* @public
|
|
8037
|
-
*/
|
|
8038
|
-
policyEngineId: string | undefined;
|
|
8039
|
-
/**
|
|
8040
|
-
* <p>A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy.</p>
|
|
8041
|
-
* @public
|
|
8042
|
-
*/
|
|
8043
|
-
clientToken?: string | undefined;
|
|
8044
|
-
}
|
|
8045
|
-
/**
|
|
8046
|
-
* @public
|
|
8047
|
-
*/
|
|
8048
|
-
export interface CreatePolicyResponse {
|
|
8049
|
-
/**
|
|
8050
|
-
* <p>The unique identifier for the created policy. This is a system-generated identifier consisting of the user name plus a 10-character generated suffix, used for all subsequent policy operations.</p>
|
|
8051
|
-
* @public
|
|
8052
|
-
*/
|
|
8053
|
-
policyId: string | undefined;
|
|
8054
|
-
/**
|
|
8055
|
-
* <p>The customer-assigned name of the created policy. This matches the name provided in the request and serves as the human-readable identifier for the policy.</p>
|
|
8056
|
-
* @public
|
|
8057
|
-
*/
|
|
8058
|
-
name: string | undefined;
|
|
8059
|
-
/**
|
|
8060
|
-
* <p>The identifier of the policy engine that manages this policy. This confirms the policy engine assignment and is used for policy evaluation routing.</p>
|
|
8061
|
-
* @public
|
|
8062
|
-
*/
|
|
8063
|
-
policyEngineId: string | undefined;
|
|
8064
|
-
/**
|
|
8065
|
-
* <p>The Cedar policy statement that was created. This is the validated policy definition that will be used for agent behavior control and access decisions.</p>
|
|
8066
|
-
* @public
|
|
8067
|
-
*/
|
|
8068
|
-
definition: PolicyDefinition | undefined;
|
|
8069
|
-
/**
|
|
8070
|
-
* <p>The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.</p>
|
|
8071
|
-
* @public
|
|
8072
|
-
*/
|
|
8073
|
-
description?: string | undefined;
|
|
8074
|
-
/**
|
|
8075
|
-
* <p>The timestamp when the policy was created. This is automatically set by the service and used for auditing and lifecycle management.</p>
|
|
8076
|
-
* @public
|
|
8077
|
-
*/
|
|
8078
|
-
createdAt: Date | undefined;
|
|
8079
|
-
/**
|
|
8080
|
-
* <p>The timestamp when the policy was last updated. For newly created policies, this matches the createdAt timestamp.</p>
|
|
8081
|
-
* @public
|
|
8082
|
-
*/
|
|
8083
|
-
updatedAt: Date | undefined;
|
|
8084
|
-
/**
|
|
8085
|
-
* <p>The Amazon Resource Name (ARN) of the created policy. This globally unique identifier can be used for cross-service references and IAM policy statements.</p>
|
|
8086
|
-
* @public
|
|
8087
|
-
*/
|
|
8088
|
-
policyArn: string | undefined;
|
|
8089
|
-
/**
|
|
8090
|
-
* <p>The current status of the policy. A status of <code>ACTIVE</code> indicates the policy is ready for use.</p>
|
|
8091
|
-
* @public
|
|
8092
|
-
*/
|
|
8093
|
-
status: PolicyStatus | undefined;
|
|
8094
|
-
/**
|
|
8095
|
-
* <p>Additional information about the policy status. This provides details about any failures or the current state of the policy creation process.</p>
|
|
8096
|
-
* @public
|
|
8097
|
-
*/
|
|
8098
|
-
statusReasons: string[] | undefined;
|
|
8099
|
-
}
|
|
8100
|
-
/**
|
|
8101
|
-
* @public
|
|
8102
|
-
*/
|
|
8103
|
-
export interface DeletePolicyRequest {
|
|
8104
|
-
/**
|
|
8105
|
-
* <p>The identifier of the policy engine that manages the policy to be deleted. This ensures the policy is deleted from the correct policy engine context.</p>
|
|
8106
|
-
* @public
|
|
8107
|
-
*/
|
|
8108
|
-
policyEngineId: string | undefined;
|
|
8109
|
-
/**
|
|
8110
|
-
* <p>The unique identifier of the policy to be deleted. This must be a valid policy ID that exists within the specified policy engine.</p>
|
|
8111
|
-
* @public
|
|
8112
|
-
*/
|
|
8113
|
-
policyId: string | undefined;
|
|
8114
|
-
}
|
|
8115
|
-
/**
|
|
8116
|
-
* @public
|
|
8117
|
-
*/
|
|
8118
|
-
export interface DeletePolicyResponse {
|
|
8119
|
-
/**
|
|
8120
|
-
* <p>The unique identifier of the policy being deleted. This confirms which policy the deletion operation targets.</p>
|
|
8121
|
-
* @public
|
|
8122
|
-
*/
|
|
8123
|
-
policyId: string | undefined;
|
|
8124
|
-
/**
|
|
8125
|
-
* <p>The customer-assigned name of the deleted policy. This confirms which policy was successfully removed from the system and matches the name that was originally assigned during policy creation.</p>
|
|
8126
|
-
* @public
|
|
8127
|
-
*/
|
|
8128
|
-
name: string | undefined;
|
|
8129
|
-
/**
|
|
8130
|
-
* <p>The identifier of the policy engine from which the policy was deleted. This confirms the policy engine context for the deletion operation.</p>
|
|
8131
|
-
* @public
|
|
8132
|
-
*/
|
|
8133
|
-
policyEngineId: string | undefined;
|
|
8134
|
-
/**
|
|
8135
|
-
* <p>Represents the definition structure for policies within the AgentCore Policy system. This structure encapsulates different policy formats and languages that can be used to define access control rules.</p>
|
|
8136
|
-
* @public
|
|
8137
|
-
*/
|
|
8138
|
-
definition: PolicyDefinition | undefined;
|
|
8139
|
-
/**
|
|
8140
|
-
* <p>The human-readable description of the deleted policy.</p>
|
|
8141
|
-
* @public
|
|
8142
|
-
*/
|
|
8143
|
-
description?: string | undefined;
|
|
8144
|
-
/**
|
|
8145
|
-
* <p>The timestamp when the deleted policy was originally created.</p>
|
|
8146
|
-
* @public
|
|
8147
|
-
*/
|
|
8148
|
-
createdAt: Date | undefined;
|
|
8149
|
-
/**
|
|
8150
|
-
* <p>The timestamp when the deleted policy was last modified before deletion. This tracks the final state of the policy before it was removed from the system.</p>
|
|
8151
|
-
* @public
|
|
8152
|
-
*/
|
|
8153
|
-
updatedAt: Date | undefined;
|
|
8154
|
-
/**
|
|
8155
|
-
* <p>The Amazon Resource Name (ARN) of the deleted policy. This globally unique identifier confirms which policy resource was successfully removed.</p>
|
|
8156
|
-
* @public
|
|
8157
|
-
*/
|
|
8158
|
-
policyArn: string | undefined;
|
|
8159
|
-
/**
|
|
8160
|
-
* <p>The status of the policy deletion operation. This provides information about any issues that occurred during the deletion process.</p>
|
|
8161
|
-
* @public
|
|
8162
|
-
*/
|
|
8163
|
-
status: PolicyStatus | undefined;
|
|
8164
|
-
/**
|
|
8165
|
-
* <p>Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.</p>
|
|
8166
|
-
* @public
|
|
8167
|
-
*/
|
|
8168
|
-
statusReasons: string[] | undefined;
|
|
8169
|
-
}
|
|
8170
|
-
/**
|
|
8171
|
-
* @public
|
|
8172
|
-
*/
|
|
8173
|
-
export interface GetPolicyRequest {
|
|
8174
|
-
/**
|
|
8175
|
-
* <p>The identifier of the policy engine that manages the policy to be retrieved.</p>
|
|
8176
|
-
* @public
|
|
8177
|
-
*/
|
|
8178
|
-
policyEngineId: string | undefined;
|
|
8179
|
-
/**
|
|
8180
|
-
* <p>The unique identifier of the policy to be retrieved. This must be a valid policy ID that exists within the specified policy engine.</p>
|
|
8181
|
-
* @public
|
|
8182
|
-
*/
|
|
8183
|
-
policyId: string | undefined;
|
|
8184
|
-
}
|
|
8185
|
-
/**
|
|
8186
|
-
* @public
|
|
8187
|
-
*/
|
|
8188
|
-
export interface GetPolicyResponse {
|
|
8189
|
-
/**
|
|
8190
|
-
* <p>The unique identifier of the retrieved policy. This matches the policy ID provided in the request and serves as the system identifier for the policy.</p>
|
|
8191
|
-
* @public
|
|
8192
|
-
*/
|
|
8193
|
-
policyId: string | undefined;
|
|
8194
|
-
/**
|
|
8195
|
-
* <p>The customer-assigned name of the policy. This is the human-readable identifier that was specified when the policy was created.</p>
|
|
8196
|
-
* @public
|
|
8197
|
-
*/
|
|
8198
|
-
name: string | undefined;
|
|
8199
|
-
/**
|
|
8200
|
-
* <p>The identifier of the policy engine that manages this policy. This confirms the policy engine context for the retrieved policy.</p>
|
|
8201
|
-
* @public
|
|
8202
|
-
*/
|
|
8203
|
-
policyEngineId: string | undefined;
|
|
8204
|
-
/**
|
|
8205
|
-
* <p>The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.</p>
|
|
8206
|
-
* @public
|
|
8207
|
-
*/
|
|
8208
|
-
definition: PolicyDefinition | undefined;
|
|
8209
|
-
/**
|
|
8210
|
-
* <p>The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.</p>
|
|
8211
|
-
* @public
|
|
8212
|
-
*/
|
|
8213
|
-
description?: string | undefined;
|
|
8214
|
-
/**
|
|
8215
|
-
* <p>The timestamp when the policy was originally created.</p>
|
|
8216
|
-
* @public
|
|
8217
|
-
*/
|
|
8218
|
-
createdAt: Date | undefined;
|
|
8219
|
-
/**
|
|
8220
|
-
* <p>The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration.</p>
|
|
8221
|
-
* @public
|
|
8222
|
-
*/
|
|
8223
|
-
updatedAt: Date | undefined;
|
|
8224
|
-
/**
|
|
8225
|
-
* <p>The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.</p>
|
|
8226
|
-
* @public
|
|
8227
|
-
*/
|
|
8228
|
-
policyArn: string | undefined;
|
|
8229
|
-
/**
|
|
8230
|
-
* <p>The current status of the policy.</p>
|
|
8231
|
-
* @public
|
|
8232
|
-
*/
|
|
8233
|
-
status: PolicyStatus | undefined;
|
|
8234
|
-
/**
|
|
8235
|
-
* <p>Additional information about the policy status. This provides details about any failures or the current state of the policy.</p>
|
|
8236
|
-
* @public
|
|
8237
|
-
*/
|
|
8238
|
-
statusReasons: string[] | undefined;
|
|
8239
|
-
}
|