@aws-sdk/client-bedrock-agentcore-control 3.1104.0 → 3.1105.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 +84 -0
- package/dist-cjs/index.js +728 -90
- package/dist-es/BedrockAgentCoreControl.js +30 -0
- package/dist-es/commands/BatchPutGatewayRateLimitsCommand.js +4 -0
- package/dist-es/commands/CreateCapacityProviderCommand.js +4 -0
- package/dist-es/commands/CreateGatewayRateLimitCommand.js +4 -0
- package/dist-es/commands/DeleteCapacityProviderCommand.js +4 -0
- package/dist-es/commands/DeleteGatewayRateLimitCommand.js +4 -0
- package/dist-es/commands/GetCapacityProviderCommand.js +4 -0
- package/dist-es/commands/GetGatewayRateLimitCommand.js +4 -0
- package/dist-es/commands/ListAgentRuntimeVersionsByCapacityProviderCommand.js +4 -0
- package/dist-es/commands/ListCapacityProvidersCommand.js +4 -0
- package/dist-es/commands/ListGatewayRateLimitsCommand.js +4 -0
- package/dist-es/commands/UpdateCapacityProviderCommand.js +4 -0
- package/dist-es/commands/UpdateGatewayRateLimitCommand.js +4 -0
- package/dist-es/commands/index.js +12 -0
- package/dist-es/models/enums.js +47 -0
- package/dist-es/models/errors.js +13 -0
- package/dist-es/pagination/ListAgentRuntimeVersionsByCapacityProviderPaginator.js +4 -0
- package/dist-es/pagination/ListCapacityProvidersPaginator.js +4 -0
- package/dist-es/pagination/ListGatewayRateLimitsPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/schemas/schemas_0.js +531 -90
- package/dist-types/BedrockAgentCoreControl.d.ts +106 -0
- package/dist-types/BedrockAgentCoreControlClient.d.ts +14 -2
- package/dist-types/commands/BatchPutGatewayRateLimitsCommand.d.ts +164 -0
- package/dist-types/commands/CreateAgentRuntimeCommand.d.ts +7 -0
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +189 -0
- package/dist-types/commands/CreateGatewayRateLimitCommand.d.ts +156 -0
- package/dist-types/commands/CreateHarnessCommand.d.ts +8 -0
- package/dist-types/commands/CreateHarnessEndpointCommand.d.ts +1 -1
- package/dist-types/commands/CreatePolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAgentRuntimeCommand.d.ts +3 -1
- package/dist-types/commands/DeleteAgentRuntimeEndpointCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +94 -0
- package/dist-types/commands/DeleteGatewayRateLimitCommand.d.ts +91 -0
- package/dist-types/commands/DeleteGatewayTargetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteHarnessCommand.d.ts +4 -0
- package/dist-types/commands/DeleteHarnessEndpointCommand.d.ts +1 -1
- package/dist-types/commands/DeletePolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetAgentRuntimeCommand.d.ts +7 -0
- package/dist-types/commands/GetCapacityProviderCommand.d.ts +180 -0
- package/dist-types/commands/GetGatewayRateLimitCommand.d.ts +120 -0
- package/dist-types/commands/GetGatewayTargetCommand.d.ts +1 -1
- package/dist-types/commands/GetHarnessCommand.d.ts +4 -0
- package/dist-types/commands/GetHarnessEndpointCommand.d.ts +1 -1
- package/dist-types/commands/GetPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetPolicyGenerationCommand.d.ts +2 -1
- package/dist-types/commands/GetPolicyGenerationSummaryCommand.d.ts +1 -1
- package/dist-types/commands/GetPolicySummaryCommand.d.ts +1 -1
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetTokenVaultCommand.d.ts +1 -1
- package/dist-types/commands/ListAgentRuntimeVersionsByCapacityProviderCommand.d.ts +92 -0
- package/dist-types/commands/ListCapacityProvidersCommand.d.ts +93 -0
- package/dist-types/commands/ListGatewayRateLimitsCommand.d.ts +126 -0
- package/dist-types/commands/ListGatewayTargetsCommand.d.ts +1 -1
- package/dist-types/commands/ListHarnessEndpointsCommand.d.ts +1 -1
- package/dist-types/commands/ListPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListPolicyGenerationAssetsCommand.d.ts +1 -1
- package/dist-types/commands/ListPolicyGenerationSummariesCommand.d.ts +1 -1
- package/dist-types/commands/ListPolicyGenerationsCommand.d.ts +1 -1
- package/dist-types/commands/ListPolicySummariesCommand.d.ts +1 -1
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +1 -1
- package/dist-types/commands/StartPolicyGenerationCommand.d.ts +1 -1
- package/dist-types/commands/SynchronizeGatewayTargetsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgentRuntimeCommand.d.ts +7 -0
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +101 -0
- package/dist-types/commands/UpdateGatewayRateLimitCommand.d.ts +149 -0
- package/dist-types/commands/UpdateHarnessCommand.d.ts +8 -0
- package/dist-types/commands/UpdateHarnessEndpointCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePolicyCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +12 -0
- package/dist-types/models/enums.d.ts +111 -0
- package/dist-types/models/errors.d.ts +13 -0
- package/dist-types/models/models_0.d.ts +2568 -2358
- package/dist-types/models/models_1.d.ts +4322 -4707
- package/dist-types/models/models_2.d.ts +1440 -3
- package/dist-types/pagination/ListAgentRuntimeVersionsByCapacityProviderPaginator.d.ts +7 -0
- package/dist-types/pagination/ListCapacityProvidersPaginator.d.ts +7 -0
- package/dist-types/pagination/ListGatewayRateLimitsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/schemas/schemas_0.d.ts +61 -0
- package/dist-types/ts3.4/BedrockAgentCoreControl.d.ts +226 -0
- package/dist-types/ts3.4/BedrockAgentCoreControlClient.d.ts +72 -0
- package/dist-types/ts3.4/commands/BatchPutGatewayRateLimitsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateCapacityProviderCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateGatewayRateLimitCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateHarnessEndpointCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreatePolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteCapacityProviderCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteGatewayRateLimitCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteGatewayTargetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteHarnessEndpointCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetCapacityProviderCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetGatewayRateLimitCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetGatewayTargetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetHarnessEndpointCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetPolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetPolicyGenerationCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetPolicyGenerationSummaryCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetPolicySummaryCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetTokenVaultCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAgentRuntimeVersionsByCapacityProviderCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListCapacityProvidersCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListGatewayRateLimitsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListGatewayTargetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListHarnessEndpointsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPoliciesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPolicyGenerationAssetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPolicyGenerationSummariesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPolicyGenerationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPolicySummariesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartPolicyGenerationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SynchronizeGatewayTargetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateCapacityProviderCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateGatewayRateLimitCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateHarnessEndpointCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +12 -0
- package/dist-types/ts3.4/models/enums.d.ts +59 -0
- package/dist-types/ts3.4/models/errors.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +345 -323
- package/dist-types/ts3.4/models/models_1.d.ts +325 -404
- package/dist-types/ts3.4/models/models_2.d.ts +403 -13
- package/dist-types/ts3.4/pagination/ListAgentRuntimeVersionsByCapacityProviderPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListCapacityProvidersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListGatewayRateLimitsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +61 -0
- package/package.json +1 -1
|
@@ -1,6 +1,1443 @@
|
|
|
1
|
-
import type { DescriptorType, RegistryAuthorizerType, RegistryRecordStatus, RegistryStatus, SchemaType, SynchronizationType, TargetProtocolType, TargetStatus } from "./enums";
|
|
2
|
-
import type { A2aDescriptor,
|
|
3
|
-
import type {
|
|
1
|
+
import type { DescriptorType, EnforcementMode, FindingType, PolicyGenerationStatus, PolicyStatus, PolicyValidationMode, RegistryAuthorizerType, RegistryRecordCredentialProviderType, RegistryRecordOAuthGrantType, RegistryRecordStatus, RegistryStatus, SchemaType, SynchronizationType, TargetProtocolType, TargetStatus } from "./enums";
|
|
2
|
+
import type { A2aDescriptor, AgentSkillsDescriptor, ApiSchemaConfiguration, AuthorizerConfiguration, CredentialProviderConfiguration, HttpTargetConfiguration, MetadataConfiguration, PrivateEndpoint, S3Configuration, SkillDefinition, SkillMdDefinition, UpdatedDescription } from "./models_0";
|
|
3
|
+
import type { ApiGatewayTargetConfiguration, AuthorizationData, ConnectorTargetConfiguration, InferenceTargetConfiguration, KmsConfiguration, ManagedResourceDetails, McpServerTargetConfiguration, UpdatedAuthorizerConfiguration } from "./models_1";
|
|
4
|
+
/**
|
|
5
|
+
* <p>Represents a resource within the AgentCore Policy system. Resources are the targets of policy evaluation. Currently, only AgentCore Gateways are supported as resources for policy enforcement.</p>
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type Resource = Resource.ArnMember | Resource.$UnknownMember;
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
export declare namespace Resource {
|
|
13
|
+
/**
|
|
14
|
+
* <p>The Amazon Resource Name (ARN) of the resource. This globally unique identifier specifies the exact resource that policies will be evaluated against for access control decisions. </p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
interface ArnMember {
|
|
18
|
+
arn: string;
|
|
19
|
+
$unknown?: never;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
interface $UnknownMember {
|
|
25
|
+
arn?: never;
|
|
26
|
+
$unknown: [string, any];
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* @deprecated unused in schema-serde mode.
|
|
30
|
+
*
|
|
31
|
+
*/
|
|
32
|
+
interface Visitor<T> {
|
|
33
|
+
arn: (value: string) => T;
|
|
34
|
+
_: (name: string, value: any) => T;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
export interface GetPolicyGenerationResponse {
|
|
41
|
+
/**
|
|
42
|
+
* <p>The identifier of the policy engine associated with this policy generation. This confirms the policy engine context for the generation operation.</p>
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
policyEngineId: string | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* <p>The unique identifier of the policy generation request. This matches the generation ID provided in the request and serves as the tracking identifier.</p>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
policyGenerationId: string | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* <p>The customer-assigned name for the policy generation request. This helps identify and track generation operations across multiple requests.</p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
name: string | undefined;
|
|
56
|
+
/**
|
|
57
|
+
* <p>The Amazon Resource Name (ARN) of the policy generation. This globally unique identifier can be used for tracking, auditing, and cross-service references.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
policyGenerationArn: string | undefined;
|
|
61
|
+
/**
|
|
62
|
+
* <p>The resource information associated with the policy generation. This provides context about the target resources for which the policies are being generated.</p>
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
resource: Resource | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* <p>The timestamp when the policy generation request was created. This is used for tracking and auditing generation operations and their lifecycle.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
createdAt: Date | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* <p>The timestamp when the policy generation was last updated. This tracks the progress of the generation process and any status changes.</p>
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
updatedAt: Date | undefined;
|
|
76
|
+
/**
|
|
77
|
+
* <p>The current status of the policy generation. This indicates whether the generation is in progress, completed successfully, or failed during processing.</p>
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
status: PolicyGenerationStatus | undefined;
|
|
81
|
+
/**
|
|
82
|
+
* <p>The findings and results from the policy generation process. This includes any issues, recommendations, validation results, or insights from the generated policies.</p>
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
findings?: string | undefined;
|
|
86
|
+
/**
|
|
87
|
+
* <p>Additional information about the generation status. This provides details about any failures, warnings, or the current state of the generation process.</p>
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
statusReasons: string[] | undefined;
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
export interface GetPolicyGenerationSummaryRequest {
|
|
96
|
+
/**
|
|
97
|
+
* <p>The unique identifier of the policy generation request to retrieve the summary for.</p>
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
policyGenerationId: string | undefined;
|
|
101
|
+
/**
|
|
102
|
+
* <p>The identifier of the policy engine associated with the policy generation request.</p>
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
policyEngineId: string | undefined;
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export interface GetPolicyGenerationSummaryResponse {
|
|
111
|
+
/**
|
|
112
|
+
* <p>The identifier of the policy engine associated with this policy generation.</p>
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
policyEngineId: string | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* <p>The unique identifier of the policy generation request.</p>
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
policyGenerationId: string | undefined;
|
|
121
|
+
/**
|
|
122
|
+
* <p>The customer-assigned name for the policy generation request.</p>
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
name: string | undefined;
|
|
126
|
+
/**
|
|
127
|
+
* <p>The Amazon Resource Name (ARN) of the policy generation request.</p>
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
policyGenerationArn: string | undefined;
|
|
131
|
+
/**
|
|
132
|
+
* <p>The resource information associated with the policy generation.</p>
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
resource: Resource | undefined;
|
|
136
|
+
/**
|
|
137
|
+
* <p>The timestamp when the policy generation request was created.</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
createdAt: Date | undefined;
|
|
141
|
+
/**
|
|
142
|
+
* <p>The timestamp when the policy generation was last updated.</p>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
updatedAt: Date | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* <p>The current status of the policy generation request.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
status: PolicyGenerationStatus | undefined;
|
|
151
|
+
/**
|
|
152
|
+
* <p>The findings from the policy generation process, if available.</p>
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
findings?: string | undefined;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
export interface ListPolicyGenerationAssetsRequest {
|
|
161
|
+
/**
|
|
162
|
+
* <p>The unique identifier of the policy generation request whose assets are to be retrieved. This must be a valid generation ID from a previous <a href="https://docs.aws.amazon.com/bedrock-agentcore-control/latest/APIReference/API_StartPolicyGeneration.html">StartPolicyGeneration</a> call that has completed processing.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
policyGenerationId: string | undefined;
|
|
166
|
+
/**
|
|
167
|
+
* <p>The unique identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and ensures assets are retrieved from the correct policy engine.</p>
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
policyEngineId: string | undefined;
|
|
171
|
+
/**
|
|
172
|
+
* <p>A pagination token returned from a previous <a href="https://docs.aws.amazon.com/bedrock-agentcore-control/latest/APIReference/API_ListPolicyGenerationAssets.html">ListPolicyGenerationAssets</a> call. Use this token to retrieve the next page of assets when the response is paginated due to large numbers of generated policy options.</p>
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
nextToken?: string | undefined;
|
|
176
|
+
/**
|
|
177
|
+
* <p>The maximum number of policy generation assets to return in a single response. If not specified, the default is 10 assets per page, with a maximum of 100 per page. This helps control response size when dealing with policy generations that produce many alternative policy options.</p>
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
maxResults?: number | undefined;
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* <p>Represents a Cedar policy statement within the AgentCore Policy system. Cedar is a policy language designed for authorization that provides human-readable, analyzable, and high-performance policy evaluation for controlling agent behavior and access decisions. </p>
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
186
|
+
export interface CedarPolicy {
|
|
187
|
+
/**
|
|
188
|
+
* <p>The Cedar policy statement that defines the authorization logic. This statement follows Cedar syntax and specifies principals, actions, resources, and conditions that determine when access should be allowed or denied.</p>
|
|
189
|
+
* @public
|
|
190
|
+
*/
|
|
191
|
+
statement: string | undefined;
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* <p>An AgentCore policy statement, which supports plain Cedar policies as well as guardrails definitions.</p>
|
|
195
|
+
* @public
|
|
196
|
+
*/
|
|
197
|
+
export interface PolicyStatement {
|
|
198
|
+
/**
|
|
199
|
+
* <p>The body of the AgentCore policy statement. Contains the policy logic, which can be a Cedar policy or a guardrails definition.</p>
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
202
|
+
statement: string | undefined;
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
* <p>Represents the information identifying a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option.</p>
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
208
|
+
export interface PolicyGenerationDetails {
|
|
209
|
+
/**
|
|
210
|
+
* <p>The unique identifier for this policy generation request.</p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
policyGenerationId: string | undefined;
|
|
214
|
+
/**
|
|
215
|
+
* <p>The unique identifier for this generated policy asset within the policy generation request.</p>
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
policyGenerationAssetId: string | undefined;
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* <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>
|
|
222
|
+
* @public
|
|
223
|
+
*/
|
|
224
|
+
export type PolicyDefinition = PolicyDefinition.CedarMember | PolicyDefinition.PolicyMember | PolicyDefinition.PolicyGenerationMember | PolicyDefinition.$UnknownMember;
|
|
225
|
+
/**
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
export declare namespace PolicyDefinition {
|
|
229
|
+
/**
|
|
230
|
+
* <p>The Cedar policy definition within the policy definition structure. This contains the Cedar policy statement that defines the authorization logic using Cedar's human-readable, analyzable policy language. Cedar policies specify principals (who can access), actions (what operations are allowed), resources (what can be accessed), and optional conditions for fine-grained control. Cedar provides a formal policy language designed for authorization with deterministic evaluation, making policies testable, reviewable, and auditable. All Cedar policies follow a default-deny model where actions are denied unless explicitly permitted, and forbid policies always override permit policies.</p>
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
interface CedarMember {
|
|
234
|
+
cedar: CedarPolicy;
|
|
235
|
+
policyGeneration?: never;
|
|
236
|
+
policy?: never;
|
|
237
|
+
$unknown?: never;
|
|
238
|
+
}
|
|
239
|
+
/**
|
|
240
|
+
* <p>The generated policy asset information within the policy definition structure. This contains information identifying a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option.</p>
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
interface PolicyGenerationMember {
|
|
244
|
+
cedar?: never;
|
|
245
|
+
policyGeneration: PolicyGenerationDetails;
|
|
246
|
+
policy?: never;
|
|
247
|
+
$unknown?: never;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* <p>An AgentCore policy statement that defines the access control rules. The statement can be a Cedar policy or a guardrails definition.</p>
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
interface PolicyMember {
|
|
254
|
+
cedar?: never;
|
|
255
|
+
policyGeneration?: never;
|
|
256
|
+
policy: PolicyStatement;
|
|
257
|
+
$unknown?: never;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* @public
|
|
261
|
+
*/
|
|
262
|
+
interface $UnknownMember {
|
|
263
|
+
cedar?: never;
|
|
264
|
+
policyGeneration?: never;
|
|
265
|
+
policy?: never;
|
|
266
|
+
$unknown: [string, any];
|
|
267
|
+
}
|
|
268
|
+
/**
|
|
269
|
+
* @deprecated unused in schema-serde mode.
|
|
270
|
+
*
|
|
271
|
+
*/
|
|
272
|
+
interface Visitor<T> {
|
|
273
|
+
cedar: (value: CedarPolicy) => T;
|
|
274
|
+
policyGeneration: (value: PolicyGenerationDetails) => T;
|
|
275
|
+
policy: (value: PolicyStatement) => T;
|
|
276
|
+
_: (name: string, value: any) => T;
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* <p>Represents a finding or issue discovered during policy generation or validation. Findings provide insights about potential problems, recommendations, or validation results from policy analysis operations. Finding types include: VALID (policy is ready to use), INVALID (policy has validation errors that must be fixed), NOT_TRANSLATABLE (input couldn't be converted to policy), ALLOW_ALL (policy would allow all actions, potential security risk), ALLOW_NONE (policy would allow no actions, unusable), DENY_ALL (policy would deny all actions, may be too restrictive), and DENY_NONE (policy would deny no actions, ineffective). Review all findings before creating policies from generated assets to ensure they match your security requirements.</p>
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
export interface Finding {
|
|
284
|
+
/**
|
|
285
|
+
* <p>The type or category of the finding. This classifies the finding as an error, warning, recommendation, or informational message to help users understand the severity and nature of the issue.</p>
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
type?: FindingType | undefined;
|
|
289
|
+
/**
|
|
290
|
+
* <p>A human-readable description of the finding. This provides detailed information about the issue, recommendation, or validation result to help users understand and address the finding. </p>
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
description?: string | undefined;
|
|
294
|
+
}
|
|
295
|
+
/**
|
|
296
|
+
* <p>Represents a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option.</p>
|
|
297
|
+
* @public
|
|
298
|
+
*/
|
|
299
|
+
export interface PolicyGenerationAsset {
|
|
300
|
+
/**
|
|
301
|
+
* <p>The unique identifier for this generated policy asset within the policy generation request. This ID can be used to reference specific generated policy options when creating actual policies from the generation results.</p>
|
|
302
|
+
* @public
|
|
303
|
+
*/
|
|
304
|
+
policyGenerationAssetId: string | undefined;
|
|
305
|
+
/**
|
|
306
|
+
* <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>
|
|
307
|
+
* @public
|
|
308
|
+
*/
|
|
309
|
+
definition?: PolicyDefinition | undefined;
|
|
310
|
+
/**
|
|
311
|
+
* <p>The portion of the original natural language input that this generated policy asset addresses. This helps users understand which part of their policy description was translated into this specific Cedar policy statement, enabling better policy selection and refinement. When a single natural language input describes multiple authorization requirements, the generation process creates separate policy assets for each requirement, with each asset's rawTextFragment showing which requirement it addresses. Use this mapping to verify that all parts of your natural language input were correctly translated into Cedar policies.</p>
|
|
312
|
+
* @public
|
|
313
|
+
*/
|
|
314
|
+
rawTextFragment: string | undefined;
|
|
315
|
+
/**
|
|
316
|
+
* <p>Analysis findings and insights related to this specific generated policy asset. These findings may include validation results, potential issues, or recommendations for improvement to help users evaluate the quality and appropriateness of the generated policy.</p>
|
|
317
|
+
* @public
|
|
318
|
+
*/
|
|
319
|
+
findings: Finding[] | undefined;
|
|
320
|
+
}
|
|
321
|
+
/**
|
|
322
|
+
* @public
|
|
323
|
+
*/
|
|
324
|
+
export interface ListPolicyGenerationAssetsResponse {
|
|
325
|
+
/**
|
|
326
|
+
* <p>An array of generated policy assets including Cedar policies and related artifacts from the AI-powered policy generation process. Each asset represents a different policy option or variation generated from the original natural language input.</p>
|
|
327
|
+
* @public
|
|
328
|
+
*/
|
|
329
|
+
policyGenerationAssets?: PolicyGenerationAsset[] | undefined;
|
|
330
|
+
/**
|
|
331
|
+
* <p>A pagination token that can be used in subsequent <a href="https://docs.aws.amazon.com/bedrock-agentcore-control/latest/APIReference/API_ListPolicyGenerationAssets.html">ListPolicyGenerationAssets</a> calls to retrieve additional assets. This token is only present when there are more generated policy assets available beyond the current response.</p>
|
|
332
|
+
* @public
|
|
333
|
+
*/
|
|
334
|
+
nextToken?: string | undefined;
|
|
335
|
+
}
|
|
336
|
+
/**
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
339
|
+
export interface ListPolicyGenerationsRequest {
|
|
340
|
+
/**
|
|
341
|
+
* <p>A pagination token for retrieving additional policy generations when results are paginated.</p>
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
nextToken?: string | undefined;
|
|
345
|
+
/**
|
|
346
|
+
* <p>The maximum number of policy generations to return in a single response.</p>
|
|
347
|
+
* @public
|
|
348
|
+
*/
|
|
349
|
+
maxResults?: number | undefined;
|
|
350
|
+
/**
|
|
351
|
+
* <p>The identifier of the policy engine whose policy generations to retrieve.</p>
|
|
352
|
+
* @public
|
|
353
|
+
*/
|
|
354
|
+
policyEngineId: string | undefined;
|
|
355
|
+
}
|
|
356
|
+
/**
|
|
357
|
+
* <p>Represents a policy generation request within the AgentCore Policy system. Tracks the AI-powered conversion of natural language descriptions into Cedar policy statements, enabling users to author policies by describing authorization requirements in plain English. The generation process analyzes the natural language input along with the Gateway's tool context and Cedar schema to produce one or more validated policy options. Each generation request tracks the status of the conversion process and maintains findings about the generated policies, including validation results and potential issues. Generated policy assets remain available for one week after successful generation, allowing time to review and create policies from the generated options.</p>
|
|
358
|
+
* @public
|
|
359
|
+
*/
|
|
360
|
+
export interface PolicyGeneration {
|
|
361
|
+
/**
|
|
362
|
+
* <p>The identifier of the policy engine associated with this generation request.</p>
|
|
363
|
+
* @public
|
|
364
|
+
*/
|
|
365
|
+
policyEngineId: string | undefined;
|
|
366
|
+
/**
|
|
367
|
+
* <p>The unique identifier for this policy generation request.</p>
|
|
368
|
+
* @public
|
|
369
|
+
*/
|
|
370
|
+
policyGenerationId: string | undefined;
|
|
371
|
+
/**
|
|
372
|
+
* <p>The customer-assigned name for this policy generation request.</p>
|
|
373
|
+
* @public
|
|
374
|
+
*/
|
|
375
|
+
name: string | undefined;
|
|
376
|
+
/**
|
|
377
|
+
* <p>The ARN of this policy generation request.</p>
|
|
378
|
+
* @public
|
|
379
|
+
*/
|
|
380
|
+
policyGenerationArn: string | undefined;
|
|
381
|
+
/**
|
|
382
|
+
* <p>The resource information associated with this policy generation.</p>
|
|
383
|
+
* @public
|
|
384
|
+
*/
|
|
385
|
+
resource: Resource | undefined;
|
|
386
|
+
/**
|
|
387
|
+
* <p>The timestamp when this policy generation request was created.</p>
|
|
388
|
+
* @public
|
|
389
|
+
*/
|
|
390
|
+
createdAt: Date | undefined;
|
|
391
|
+
/**
|
|
392
|
+
* <p>The timestamp when this policy generation was last updated.</p>
|
|
393
|
+
* @public
|
|
394
|
+
*/
|
|
395
|
+
updatedAt: Date | undefined;
|
|
396
|
+
/**
|
|
397
|
+
* <p>The current status of this policy generation request.</p>
|
|
398
|
+
* @public
|
|
399
|
+
*/
|
|
400
|
+
status: PolicyGenerationStatus | undefined;
|
|
401
|
+
/**
|
|
402
|
+
* <p>Findings and insights from this policy generation process.</p>
|
|
403
|
+
* @public
|
|
404
|
+
*/
|
|
405
|
+
findings?: string | undefined;
|
|
406
|
+
/**
|
|
407
|
+
* <p>Additional information about the generation status.</p>
|
|
408
|
+
* @public
|
|
409
|
+
*/
|
|
410
|
+
statusReasons: string[] | undefined;
|
|
411
|
+
}
|
|
412
|
+
/**
|
|
413
|
+
* @public
|
|
414
|
+
*/
|
|
415
|
+
export interface ListPolicyGenerationsResponse {
|
|
416
|
+
/**
|
|
417
|
+
* <p>An array of policy generation objects that match the specified criteria.</p>
|
|
418
|
+
* @public
|
|
419
|
+
*/
|
|
420
|
+
policyGenerations: PolicyGeneration[] | undefined;
|
|
421
|
+
/**
|
|
422
|
+
* <p>A pagination token for retrieving additional policy generations if more results are available.</p>
|
|
423
|
+
* @public
|
|
424
|
+
*/
|
|
425
|
+
nextToken?: string | undefined;
|
|
426
|
+
}
|
|
427
|
+
/**
|
|
428
|
+
* @public
|
|
429
|
+
*/
|
|
430
|
+
export interface ListPolicyGenerationSummariesRequest {
|
|
431
|
+
/**
|
|
432
|
+
* <p>A pagination token returned from a previous <a href="https://docs.aws.amazon.com/bedrock-agentcore-control/latest/APIReference/API_ListPolicyGenerationSummaries.html">ListPolicyGenerationSummaries</a> call. Use this token to retrieve the next page of results when the response is paginated.</p>
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
nextToken?: string | undefined;
|
|
436
|
+
/**
|
|
437
|
+
* <p>The maximum number of policy generation summaries to return in a single response.</p>
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
maxResults?: number | undefined;
|
|
441
|
+
/**
|
|
442
|
+
* <p>The identifier of the policy engine whose policy generation summaries to retrieve.</p>
|
|
443
|
+
* @public
|
|
444
|
+
*/
|
|
445
|
+
policyEngineId: string | undefined;
|
|
446
|
+
}
|
|
447
|
+
/**
|
|
448
|
+
* <p>Represents a metadata-only summary of a policy generation resource. This structure contains resource identifiers, status, timestamps, and findings without customer-encrypted fields such as status reasons. Policy generation summaries are returned by operations that do not require access to the customer's KMS key.</p>
|
|
449
|
+
* @public
|
|
450
|
+
*/
|
|
451
|
+
export interface PolicyGenerationSummary {
|
|
452
|
+
/**
|
|
453
|
+
* <p>The identifier of the policy engine associated with this generation request.</p>
|
|
454
|
+
* @public
|
|
455
|
+
*/
|
|
456
|
+
policyEngineId: string | undefined;
|
|
457
|
+
/**
|
|
458
|
+
* <p>The unique identifier for this policy generation request.</p>
|
|
459
|
+
* @public
|
|
460
|
+
*/
|
|
461
|
+
policyGenerationId: string | undefined;
|
|
462
|
+
/**
|
|
463
|
+
* <p>The customer-assigned name for this policy generation request.</p>
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
466
|
+
name: string | undefined;
|
|
467
|
+
/**
|
|
468
|
+
* <p>The ARN of this policy generation request.</p>
|
|
469
|
+
* @public
|
|
470
|
+
*/
|
|
471
|
+
policyGenerationArn: string | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* <p>The resource information associated with this policy generation.</p>
|
|
474
|
+
* @public
|
|
475
|
+
*/
|
|
476
|
+
resource: Resource | undefined;
|
|
477
|
+
/**
|
|
478
|
+
* <p>The timestamp when this policy generation request was created.</p>
|
|
479
|
+
* @public
|
|
480
|
+
*/
|
|
481
|
+
createdAt: Date | undefined;
|
|
482
|
+
/**
|
|
483
|
+
* <p>The timestamp when this policy generation was last updated.</p>
|
|
484
|
+
* @public
|
|
485
|
+
*/
|
|
486
|
+
updatedAt: Date | undefined;
|
|
487
|
+
/**
|
|
488
|
+
* <p>The current status of this policy generation request.</p>
|
|
489
|
+
* @public
|
|
490
|
+
*/
|
|
491
|
+
status: PolicyGenerationStatus | undefined;
|
|
492
|
+
/**
|
|
493
|
+
* <p>Findings and insights from this policy generation process.</p>
|
|
494
|
+
* @public
|
|
495
|
+
*/
|
|
496
|
+
findings?: string | undefined;
|
|
497
|
+
}
|
|
498
|
+
/**
|
|
499
|
+
* @public
|
|
500
|
+
*/
|
|
501
|
+
export interface ListPolicyGenerationSummariesResponse {
|
|
502
|
+
/**
|
|
503
|
+
* <p>An array of policy generation summary objects that match the specified criteria. Each summary contains resource identifiers, status, timestamps, and findings without customer-encrypted content.</p>
|
|
504
|
+
* @public
|
|
505
|
+
*/
|
|
506
|
+
policyGenerations: PolicyGenerationSummary[] | undefined;
|
|
507
|
+
/**
|
|
508
|
+
* <p>A pagination token that can be used in subsequent <a href="https://docs.aws.amazon.com/bedrock-agentcore-control/latest/APIReference/API_ListPolicyGenerationSummaries.html">ListPolicyGenerationSummaries</a> calls to retrieve additional results. This token is only present when there are more results available.</p>
|
|
509
|
+
* @public
|
|
510
|
+
*/
|
|
511
|
+
nextToken?: string | undefined;
|
|
512
|
+
}
|
|
513
|
+
/**
|
|
514
|
+
* <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>
|
|
515
|
+
* @public
|
|
516
|
+
*/
|
|
517
|
+
export type Content = Content.RawTextMember | Content.$UnknownMember;
|
|
518
|
+
/**
|
|
519
|
+
* @public
|
|
520
|
+
*/
|
|
521
|
+
export declare namespace Content {
|
|
522
|
+
/**
|
|
523
|
+
* <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>
|
|
524
|
+
* @public
|
|
525
|
+
*/
|
|
526
|
+
interface RawTextMember {
|
|
527
|
+
rawText: string;
|
|
528
|
+
$unknown?: never;
|
|
529
|
+
}
|
|
530
|
+
/**
|
|
531
|
+
* @public
|
|
532
|
+
*/
|
|
533
|
+
interface $UnknownMember {
|
|
534
|
+
rawText?: never;
|
|
535
|
+
$unknown: [string, any];
|
|
536
|
+
}
|
|
537
|
+
/**
|
|
538
|
+
* @deprecated unused in schema-serde mode.
|
|
539
|
+
*
|
|
540
|
+
*/
|
|
541
|
+
interface Visitor<T> {
|
|
542
|
+
rawText: (value: string) => T;
|
|
543
|
+
_: (name: string, value: any) => T;
|
|
544
|
+
}
|
|
545
|
+
}
|
|
546
|
+
/**
|
|
547
|
+
* @public
|
|
548
|
+
*/
|
|
549
|
+
export interface StartPolicyGenerationRequest {
|
|
550
|
+
/**
|
|
551
|
+
* <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>
|
|
552
|
+
* @public
|
|
553
|
+
*/
|
|
554
|
+
policyEngineId: string | undefined;
|
|
555
|
+
/**
|
|
556
|
+
* <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>
|
|
557
|
+
* @public
|
|
558
|
+
*/
|
|
559
|
+
resource: Resource | undefined;
|
|
560
|
+
/**
|
|
561
|
+
* <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>
|
|
562
|
+
* @public
|
|
563
|
+
*/
|
|
564
|
+
content: Content | undefined;
|
|
565
|
+
/**
|
|
566
|
+
* <p>A customer-assigned name for the policy generation request. This helps track and identify generation operations, especially when running multiple generations simultaneously.</p>
|
|
567
|
+
* @public
|
|
568
|
+
*/
|
|
569
|
+
name: string | undefined;
|
|
570
|
+
/**
|
|
571
|
+
* <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>
|
|
572
|
+
* @public
|
|
573
|
+
*/
|
|
574
|
+
clientToken?: string | undefined;
|
|
575
|
+
}
|
|
576
|
+
/**
|
|
577
|
+
* @public
|
|
578
|
+
*/
|
|
579
|
+
export interface StartPolicyGenerationResponse {
|
|
580
|
+
/**
|
|
581
|
+
* <p>The identifier of the policy engine associated with the started policy generation. </p>
|
|
582
|
+
* @public
|
|
583
|
+
*/
|
|
584
|
+
policyEngineId: string | undefined;
|
|
585
|
+
/**
|
|
586
|
+
* <p>The unique identifier assigned to the policy generation request for tracking progress. </p>
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
policyGenerationId: string | undefined;
|
|
590
|
+
/**
|
|
591
|
+
* <p>The customer-assigned name for the policy generation request.</p>
|
|
592
|
+
* @public
|
|
593
|
+
*/
|
|
594
|
+
name: string | undefined;
|
|
595
|
+
/**
|
|
596
|
+
* <p>The ARN of the created policy generation request.</p>
|
|
597
|
+
* @public
|
|
598
|
+
*/
|
|
599
|
+
policyGenerationArn: string | undefined;
|
|
600
|
+
/**
|
|
601
|
+
* <p>The resource information associated with the policy generation request.</p>
|
|
602
|
+
* @public
|
|
603
|
+
*/
|
|
604
|
+
resource: Resource | undefined;
|
|
605
|
+
/**
|
|
606
|
+
* <p>The timestamp when the policy generation request was created.</p>
|
|
607
|
+
* @public
|
|
608
|
+
*/
|
|
609
|
+
createdAt: Date | undefined;
|
|
610
|
+
/**
|
|
611
|
+
* <p>The timestamp when the policy generation was last updated.</p>
|
|
612
|
+
* @public
|
|
613
|
+
*/
|
|
614
|
+
updatedAt: Date | undefined;
|
|
615
|
+
/**
|
|
616
|
+
* <p>The initial status of the policy generation request.</p>
|
|
617
|
+
* @public
|
|
618
|
+
*/
|
|
619
|
+
status: PolicyGenerationStatus | undefined;
|
|
620
|
+
/**
|
|
621
|
+
* <p>Initial findings from the policy generation process.</p>
|
|
622
|
+
* @public
|
|
623
|
+
*/
|
|
624
|
+
findings?: string | undefined;
|
|
625
|
+
/**
|
|
626
|
+
* <p>Additional information about the generation status.</p>
|
|
627
|
+
* @public
|
|
628
|
+
*/
|
|
629
|
+
statusReasons: string[] | undefined;
|
|
630
|
+
}
|
|
631
|
+
/**
|
|
632
|
+
* @public
|
|
633
|
+
*/
|
|
634
|
+
export interface CreatePolicyRequest {
|
|
635
|
+
/**
|
|
636
|
+
* <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>
|
|
637
|
+
* @public
|
|
638
|
+
*/
|
|
639
|
+
name: string | undefined;
|
|
640
|
+
/**
|
|
641
|
+
* <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>
|
|
642
|
+
* @public
|
|
643
|
+
*/
|
|
644
|
+
definition: PolicyDefinition | undefined;
|
|
645
|
+
/**
|
|
646
|
+
* <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>
|
|
647
|
+
* @public
|
|
648
|
+
*/
|
|
649
|
+
description?: string | undefined;
|
|
650
|
+
/**
|
|
651
|
+
* <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>
|
|
652
|
+
* @public
|
|
653
|
+
*/
|
|
654
|
+
validationMode?: PolicyValidationMode | undefined;
|
|
655
|
+
/**
|
|
656
|
+
* <p>The enforcement mode for the policy. Run this policy in <code>LOG_ONLY</code> mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to <code>ACTIVE</code>. Defaults to <code>ACTIVE</code>.</p>
|
|
657
|
+
* @public
|
|
658
|
+
*/
|
|
659
|
+
enforcementMode?: EnforcementMode | undefined;
|
|
660
|
+
/**
|
|
661
|
+
* <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>
|
|
662
|
+
* @public
|
|
663
|
+
*/
|
|
664
|
+
policyEngineId: string | undefined;
|
|
665
|
+
/**
|
|
666
|
+
* <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>
|
|
667
|
+
* @public
|
|
668
|
+
*/
|
|
669
|
+
clientToken?: string | undefined;
|
|
670
|
+
}
|
|
671
|
+
/**
|
|
672
|
+
* @public
|
|
673
|
+
*/
|
|
674
|
+
export interface CreatePolicyResponse {
|
|
675
|
+
/**
|
|
676
|
+
* <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>
|
|
677
|
+
* @public
|
|
678
|
+
*/
|
|
679
|
+
policyId: string | undefined;
|
|
680
|
+
/**
|
|
681
|
+
* <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>
|
|
682
|
+
* @public
|
|
683
|
+
*/
|
|
684
|
+
name: string | undefined;
|
|
685
|
+
/**
|
|
686
|
+
* <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>
|
|
687
|
+
* @public
|
|
688
|
+
*/
|
|
689
|
+
policyEngineId: string | undefined;
|
|
690
|
+
/**
|
|
691
|
+
* <p>The timestamp when the policy was created. This is automatically set by the service and used for auditing and lifecycle management.</p>
|
|
692
|
+
* @public
|
|
693
|
+
*/
|
|
694
|
+
createdAt: Date | undefined;
|
|
695
|
+
/**
|
|
696
|
+
* <p>The timestamp when the policy was last updated. For newly created policies, this matches the createdAt timestamp.</p>
|
|
697
|
+
* @public
|
|
698
|
+
*/
|
|
699
|
+
updatedAt: Date | undefined;
|
|
700
|
+
/**
|
|
701
|
+
* <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>
|
|
702
|
+
* @public
|
|
703
|
+
*/
|
|
704
|
+
policyArn: string | undefined;
|
|
705
|
+
/**
|
|
706
|
+
* <p>The current status of the policy. A status of <code>ACTIVE</code> indicates the policy is ready for use.</p>
|
|
707
|
+
* @public
|
|
708
|
+
*/
|
|
709
|
+
status: PolicyStatus | undefined;
|
|
710
|
+
/**
|
|
711
|
+
* <p>The enforcement mode of the created policy.</p>
|
|
712
|
+
* @public
|
|
713
|
+
*/
|
|
714
|
+
enforcementMode?: EnforcementMode | undefined;
|
|
715
|
+
/**
|
|
716
|
+
* <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>
|
|
717
|
+
* @public
|
|
718
|
+
*/
|
|
719
|
+
definition: PolicyDefinition | undefined;
|
|
720
|
+
/**
|
|
721
|
+
* <p>The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.</p>
|
|
722
|
+
* @public
|
|
723
|
+
*/
|
|
724
|
+
description?: string | undefined;
|
|
725
|
+
/**
|
|
726
|
+
* <p>Additional information about the policy status. This provides details about any failures or the current state of the policy creation process.</p>
|
|
727
|
+
* @public
|
|
728
|
+
*/
|
|
729
|
+
statusReasons: string[] | undefined;
|
|
730
|
+
}
|
|
731
|
+
/**
|
|
732
|
+
* @public
|
|
733
|
+
*/
|
|
734
|
+
export interface DeletePolicyRequest {
|
|
735
|
+
/**
|
|
736
|
+
* <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>
|
|
737
|
+
* @public
|
|
738
|
+
*/
|
|
739
|
+
policyEngineId: string | undefined;
|
|
740
|
+
/**
|
|
741
|
+
* <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>
|
|
742
|
+
* @public
|
|
743
|
+
*/
|
|
744
|
+
policyId: string | undefined;
|
|
745
|
+
}
|
|
746
|
+
/**
|
|
747
|
+
* @public
|
|
748
|
+
*/
|
|
749
|
+
export interface DeletePolicyResponse {
|
|
750
|
+
/**
|
|
751
|
+
* <p>The unique identifier of the policy being deleted. This confirms which policy the deletion operation targets.</p>
|
|
752
|
+
* @public
|
|
753
|
+
*/
|
|
754
|
+
policyId: string | undefined;
|
|
755
|
+
/**
|
|
756
|
+
* <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>
|
|
757
|
+
* @public
|
|
758
|
+
*/
|
|
759
|
+
name: string | undefined;
|
|
760
|
+
/**
|
|
761
|
+
* <p>The identifier of the policy engine from which the policy was deleted. This confirms the policy engine context for the deletion operation.</p>
|
|
762
|
+
* @public
|
|
763
|
+
*/
|
|
764
|
+
policyEngineId: string | undefined;
|
|
765
|
+
/**
|
|
766
|
+
* <p>The timestamp when the deleted policy was originally created.</p>
|
|
767
|
+
* @public
|
|
768
|
+
*/
|
|
769
|
+
createdAt: Date | undefined;
|
|
770
|
+
/**
|
|
771
|
+
* <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>
|
|
772
|
+
* @public
|
|
773
|
+
*/
|
|
774
|
+
updatedAt: Date | undefined;
|
|
775
|
+
/**
|
|
776
|
+
* <p>The Amazon Resource Name (ARN) of the deleted policy. This globally unique identifier confirms which policy resource was successfully removed.</p>
|
|
777
|
+
* @public
|
|
778
|
+
*/
|
|
779
|
+
policyArn: string | undefined;
|
|
780
|
+
/**
|
|
781
|
+
* <p>The status of the policy deletion operation. This provides information about any issues that occurred during the deletion process.</p>
|
|
782
|
+
* @public
|
|
783
|
+
*/
|
|
784
|
+
status: PolicyStatus | undefined;
|
|
785
|
+
/**
|
|
786
|
+
* <p>The enforcement mode of the deleted policy.</p>
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
enforcementMode?: EnforcementMode | undefined;
|
|
790
|
+
/**
|
|
791
|
+
* <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>
|
|
792
|
+
* @public
|
|
793
|
+
*/
|
|
794
|
+
definition: PolicyDefinition | undefined;
|
|
795
|
+
/**
|
|
796
|
+
* <p>The human-readable description of the deleted policy.</p>
|
|
797
|
+
* @public
|
|
798
|
+
*/
|
|
799
|
+
description?: string | undefined;
|
|
800
|
+
/**
|
|
801
|
+
* <p>Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.</p>
|
|
802
|
+
* @public
|
|
803
|
+
*/
|
|
804
|
+
statusReasons: string[] | undefined;
|
|
805
|
+
}
|
|
806
|
+
/**
|
|
807
|
+
* @public
|
|
808
|
+
*/
|
|
809
|
+
export interface GetPolicyRequest {
|
|
810
|
+
/**
|
|
811
|
+
* <p>The identifier of the policy engine that manages the policy to be retrieved.</p>
|
|
812
|
+
* @public
|
|
813
|
+
*/
|
|
814
|
+
policyEngineId: string | undefined;
|
|
815
|
+
/**
|
|
816
|
+
* <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>
|
|
817
|
+
* @public
|
|
818
|
+
*/
|
|
819
|
+
policyId: string | undefined;
|
|
820
|
+
}
|
|
821
|
+
/**
|
|
822
|
+
* @public
|
|
823
|
+
*/
|
|
824
|
+
export interface GetPolicyResponse {
|
|
825
|
+
/**
|
|
826
|
+
* <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>
|
|
827
|
+
* @public
|
|
828
|
+
*/
|
|
829
|
+
policyId: string | undefined;
|
|
830
|
+
/**
|
|
831
|
+
* <p>The customer-assigned name of the policy. This is the human-readable identifier that was specified when the policy was created.</p>
|
|
832
|
+
* @public
|
|
833
|
+
*/
|
|
834
|
+
name: string | undefined;
|
|
835
|
+
/**
|
|
836
|
+
* <p>The identifier of the policy engine that manages this policy. This confirms the policy engine context for the retrieved policy.</p>
|
|
837
|
+
* @public
|
|
838
|
+
*/
|
|
839
|
+
policyEngineId: string | undefined;
|
|
840
|
+
/**
|
|
841
|
+
* <p>The timestamp when the policy was originally created.</p>
|
|
842
|
+
* @public
|
|
843
|
+
*/
|
|
844
|
+
createdAt: Date | undefined;
|
|
845
|
+
/**
|
|
846
|
+
* <p>The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration.</p>
|
|
847
|
+
* @public
|
|
848
|
+
*/
|
|
849
|
+
updatedAt: Date | undefined;
|
|
850
|
+
/**
|
|
851
|
+
* <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>
|
|
852
|
+
* @public
|
|
853
|
+
*/
|
|
854
|
+
policyArn: string | undefined;
|
|
855
|
+
/**
|
|
856
|
+
* <p>The current status of the policy.</p>
|
|
857
|
+
* @public
|
|
858
|
+
*/
|
|
859
|
+
status: PolicyStatus | undefined;
|
|
860
|
+
/**
|
|
861
|
+
* <p>The current enforcement mode of the policy.</p>
|
|
862
|
+
* @public
|
|
863
|
+
*/
|
|
864
|
+
enforcementMode?: EnforcementMode | undefined;
|
|
865
|
+
/**
|
|
866
|
+
* <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>
|
|
867
|
+
* @public
|
|
868
|
+
*/
|
|
869
|
+
definition: PolicyDefinition | undefined;
|
|
870
|
+
/**
|
|
871
|
+
* <p>The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.</p>
|
|
872
|
+
* @public
|
|
873
|
+
*/
|
|
874
|
+
description?: string | undefined;
|
|
875
|
+
/**
|
|
876
|
+
* <p>Additional information about the policy status. This provides details about any failures or the current state of the policy.</p>
|
|
877
|
+
* @public
|
|
878
|
+
*/
|
|
879
|
+
statusReasons: string[] | undefined;
|
|
880
|
+
}
|
|
881
|
+
/**
|
|
882
|
+
* @public
|
|
883
|
+
*/
|
|
884
|
+
export interface GetPolicySummaryRequest {
|
|
885
|
+
/**
|
|
886
|
+
* <p>The identifier of the policy engine that manages the policy to retrieve the summary for.</p>
|
|
887
|
+
* @public
|
|
888
|
+
*/
|
|
889
|
+
policyEngineId: string | undefined;
|
|
890
|
+
/**
|
|
891
|
+
* <p>The unique identifier of the policy to retrieve the summary for. This must be a valid policy ID that exists within the specified policy engine.</p>
|
|
892
|
+
* @public
|
|
893
|
+
*/
|
|
894
|
+
policyId: string | undefined;
|
|
895
|
+
}
|
|
896
|
+
/**
|
|
897
|
+
* @public
|
|
898
|
+
*/
|
|
899
|
+
export interface GetPolicySummaryResponse {
|
|
900
|
+
/**
|
|
901
|
+
* <p>The unique identifier of the policy.</p>
|
|
902
|
+
* @public
|
|
903
|
+
*/
|
|
904
|
+
policyId: string | undefined;
|
|
905
|
+
/**
|
|
906
|
+
* <p>The customer-assigned name of the policy.</p>
|
|
907
|
+
* @public
|
|
908
|
+
*/
|
|
909
|
+
name: string | undefined;
|
|
910
|
+
/**
|
|
911
|
+
* <p>The identifier of the policy engine that manages this policy.</p>
|
|
912
|
+
* @public
|
|
913
|
+
*/
|
|
914
|
+
policyEngineId: string | undefined;
|
|
915
|
+
/**
|
|
916
|
+
* <p>The timestamp when the policy was originally created.</p>
|
|
917
|
+
* @public
|
|
918
|
+
*/
|
|
919
|
+
createdAt: Date | undefined;
|
|
920
|
+
/**
|
|
921
|
+
* <p>The timestamp when the policy was last modified.</p>
|
|
922
|
+
* @public
|
|
923
|
+
*/
|
|
924
|
+
updatedAt: Date | undefined;
|
|
925
|
+
/**
|
|
926
|
+
* <p>The Amazon Resource Name (ARN) of the policy.</p>
|
|
927
|
+
* @public
|
|
928
|
+
*/
|
|
929
|
+
policyArn: string | undefined;
|
|
930
|
+
/**
|
|
931
|
+
* <p>The current status of the policy.</p>
|
|
932
|
+
* @public
|
|
933
|
+
*/
|
|
934
|
+
status: PolicyStatus | undefined;
|
|
935
|
+
/**
|
|
936
|
+
* <p>The current enforcement mode of the policy.</p>
|
|
937
|
+
* @public
|
|
938
|
+
*/
|
|
939
|
+
enforcementMode?: EnforcementMode | undefined;
|
|
940
|
+
}
|
|
941
|
+
/**
|
|
942
|
+
* @public
|
|
943
|
+
*/
|
|
944
|
+
export interface ListPoliciesRequest {
|
|
945
|
+
/**
|
|
946
|
+
* <p>A pagination token returned from a previous <a href="https://docs.aws.amazon.com/bedrock-agentcore-control/latest/APIReference/API_ListPolicies.html">ListPolicies</a> call. Use this token to retrieve the next page of results when the response is paginated.</p>
|
|
947
|
+
* @public
|
|
948
|
+
*/
|
|
949
|
+
nextToken?: string | undefined;
|
|
950
|
+
/**
|
|
951
|
+
* <p>The maximum number of policies to return in a single response. If not specified, the default is 10 policies per page, with a maximum of 100 per page.</p>
|
|
952
|
+
* @public
|
|
953
|
+
*/
|
|
954
|
+
maxResults?: number | undefined;
|
|
955
|
+
/**
|
|
956
|
+
* <p>The identifier of the policy engine whose policies to retrieve.</p>
|
|
957
|
+
* @public
|
|
958
|
+
*/
|
|
959
|
+
policyEngineId: string | undefined;
|
|
960
|
+
/**
|
|
961
|
+
* <p>Optional filter to list policies that apply to a specific resource scope or resource type. This helps narrow down policy results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.</p>
|
|
962
|
+
* @public
|
|
963
|
+
*/
|
|
964
|
+
targetResourceScope?: string | undefined;
|
|
965
|
+
}
|
|
966
|
+
/**
|
|
967
|
+
* <p>Represents a complete policy resource within the AgentCore Policy system. Policies are ARN-able resources that contain Cedar policy statements and associated metadata for controlling agent behavior and access decisions. Each policy belongs to a policy engine and defines fine-grained authorization rules that are evaluated in real-time as agents interact with tools through Gateway. Policies use the Cedar policy language to specify who (principals based on OAuth claims like username, role, or scope) can perform what actions (tool calls) on which resources (Gateways), with optional conditions for attribute-based access control. Multiple policies can apply to a single request, with Cedar's forbid-wins semantics ensuring that security restrictions are never accidentally overridden.</p>
|
|
968
|
+
* @public
|
|
969
|
+
*/
|
|
970
|
+
export interface Policy {
|
|
971
|
+
/**
|
|
972
|
+
* <p>The unique identifier for the policy. This system-generated identifier consists of the user name plus a 10-character generated suffix and serves as the primary key for policy operations.</p>
|
|
973
|
+
* @public
|
|
974
|
+
*/
|
|
975
|
+
policyId: string | undefined;
|
|
976
|
+
/**
|
|
977
|
+
* <p>The customer-assigned immutable name for the policy. This human-readable identifier must be unique within the account and cannot exceed 48 characters.</p>
|
|
978
|
+
* @public
|
|
979
|
+
*/
|
|
980
|
+
name: string | undefined;
|
|
981
|
+
/**
|
|
982
|
+
* <p>The identifier of the policy engine that manages this policy. This establishes the policy engine context for policy evaluation and management.</p>
|
|
983
|
+
* @public
|
|
984
|
+
*/
|
|
985
|
+
policyEngineId: string | undefined;
|
|
986
|
+
/**
|
|
987
|
+
* <p>The timestamp when the policy was originally created. This is automatically set by the service and used for auditing and lifecycle management.</p>
|
|
988
|
+
* @public
|
|
989
|
+
*/
|
|
990
|
+
createdAt: Date | undefined;
|
|
991
|
+
/**
|
|
992
|
+
* <p>The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration or metadata.</p>
|
|
993
|
+
* @public
|
|
994
|
+
*/
|
|
995
|
+
updatedAt: Date | undefined;
|
|
996
|
+
/**
|
|
997
|
+
* <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>
|
|
998
|
+
* @public
|
|
999
|
+
*/
|
|
1000
|
+
policyArn: string | undefined;
|
|
1001
|
+
/**
|
|
1002
|
+
* <p>The current status of the policy.</p>
|
|
1003
|
+
* @public
|
|
1004
|
+
*/
|
|
1005
|
+
status: PolicyStatus | undefined;
|
|
1006
|
+
/**
|
|
1007
|
+
* <p>The current enforcement mode of the policy.</p>
|
|
1008
|
+
* @public
|
|
1009
|
+
*/
|
|
1010
|
+
enforcementMode?: EnforcementMode | undefined;
|
|
1011
|
+
/**
|
|
1012
|
+
* <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>
|
|
1013
|
+
* @public
|
|
1014
|
+
*/
|
|
1015
|
+
definition: PolicyDefinition | undefined;
|
|
1016
|
+
/**
|
|
1017
|
+
* <p>A human-readable description of the policy's purpose and functionality. Limited to 4,096 characters, this helps administrators understand and manage the policy.</p>
|
|
1018
|
+
* @public
|
|
1019
|
+
*/
|
|
1020
|
+
description?: string | undefined;
|
|
1021
|
+
/**
|
|
1022
|
+
* <p>Additional information about the policy status. This provides details about any failures or the current state of the policy lifecycle.</p>
|
|
1023
|
+
* @public
|
|
1024
|
+
*/
|
|
1025
|
+
statusReasons: string[] | undefined;
|
|
1026
|
+
}
|
|
1027
|
+
/**
|
|
1028
|
+
* @public
|
|
1029
|
+
*/
|
|
1030
|
+
export interface ListPoliciesResponse {
|
|
1031
|
+
/**
|
|
1032
|
+
* <p>An array of policy objects that match the specified criteria. Each policy object contains the policy metadata, status, and key identifiers for further operations.</p>
|
|
1033
|
+
* @public
|
|
1034
|
+
*/
|
|
1035
|
+
policies: Policy[] | undefined;
|
|
1036
|
+
/**
|
|
1037
|
+
* <p>A pagination token that can be used in subsequent ListPolicies calls to retrieve additional results. This token is only present when there are more results available.</p>
|
|
1038
|
+
* @public
|
|
1039
|
+
*/
|
|
1040
|
+
nextToken?: string | undefined;
|
|
1041
|
+
}
|
|
1042
|
+
/**
|
|
1043
|
+
* @public
|
|
1044
|
+
*/
|
|
1045
|
+
export interface ListPolicySummariesRequest {
|
|
1046
|
+
/**
|
|
1047
|
+
* <p>A pagination token returned from a previous <a href="https://docs.aws.amazon.com/bedrock-agentcore-control/latest/APIReference/API_ListPolicySummaries.html">ListPolicySummaries</a> call. Use this token to retrieve the next page of results when the response is paginated.</p>
|
|
1048
|
+
* @public
|
|
1049
|
+
*/
|
|
1050
|
+
nextToken?: string | undefined;
|
|
1051
|
+
/**
|
|
1052
|
+
* <p>The maximum number of policy summaries to return in a single response.</p>
|
|
1053
|
+
* @public
|
|
1054
|
+
*/
|
|
1055
|
+
maxResults?: number | undefined;
|
|
1056
|
+
/**
|
|
1057
|
+
* <p>The identifier of the policy engine whose policy summaries to retrieve.</p>
|
|
1058
|
+
* @public
|
|
1059
|
+
*/
|
|
1060
|
+
policyEngineId: string | undefined;
|
|
1061
|
+
/**
|
|
1062
|
+
* <p>Optional filter to list policy summaries that apply to a specific resource scope or resource type. This helps narrow down results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.</p>
|
|
1063
|
+
* @public
|
|
1064
|
+
*/
|
|
1065
|
+
targetResourceScope?: string | undefined;
|
|
1066
|
+
}
|
|
1067
|
+
/**
|
|
1068
|
+
* <p>Represents a metadata-only summary of a policy resource. This structure contains resource identifiers, status, and timestamps without customer-encrypted fields such as definition, description, or status reasons. Policy summaries are returned by operations that do not require access to the customer's KMS key.</p>
|
|
1069
|
+
* @public
|
|
1070
|
+
*/
|
|
1071
|
+
export interface PolicySummary {
|
|
1072
|
+
/**
|
|
1073
|
+
* <p>The unique identifier for the policy.</p>
|
|
1074
|
+
* @public
|
|
1075
|
+
*/
|
|
1076
|
+
policyId: string | undefined;
|
|
1077
|
+
/**
|
|
1078
|
+
* <p>The customer-assigned name of the policy.</p>
|
|
1079
|
+
* @public
|
|
1080
|
+
*/
|
|
1081
|
+
name: string | undefined;
|
|
1082
|
+
/**
|
|
1083
|
+
* <p>The identifier of the policy engine that manages this policy.</p>
|
|
1084
|
+
* @public
|
|
1085
|
+
*/
|
|
1086
|
+
policyEngineId: string | undefined;
|
|
1087
|
+
/**
|
|
1088
|
+
* <p>The timestamp when the policy was originally created.</p>
|
|
1089
|
+
* @public
|
|
1090
|
+
*/
|
|
1091
|
+
createdAt: Date | undefined;
|
|
1092
|
+
/**
|
|
1093
|
+
* <p>The timestamp when the policy was last modified.</p>
|
|
1094
|
+
* @public
|
|
1095
|
+
*/
|
|
1096
|
+
updatedAt: Date | undefined;
|
|
1097
|
+
/**
|
|
1098
|
+
* <p>The Amazon Resource Name (ARN) of the policy.</p>
|
|
1099
|
+
* @public
|
|
1100
|
+
*/
|
|
1101
|
+
policyArn: string | undefined;
|
|
1102
|
+
/**
|
|
1103
|
+
* <p>The current status of the policy.</p>
|
|
1104
|
+
* @public
|
|
1105
|
+
*/
|
|
1106
|
+
status: PolicyStatus | undefined;
|
|
1107
|
+
/**
|
|
1108
|
+
* <p>The current enforcement mode of the policy.</p>
|
|
1109
|
+
* @public
|
|
1110
|
+
*/
|
|
1111
|
+
enforcementMode?: EnforcementMode | undefined;
|
|
1112
|
+
}
|
|
1113
|
+
/**
|
|
1114
|
+
* @public
|
|
1115
|
+
*/
|
|
1116
|
+
export interface ListPolicySummariesResponse {
|
|
1117
|
+
/**
|
|
1118
|
+
* <p>An array of policy summary objects that match the specified criteria. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.</p>
|
|
1119
|
+
* @public
|
|
1120
|
+
*/
|
|
1121
|
+
policies: PolicySummary[] | undefined;
|
|
1122
|
+
/**
|
|
1123
|
+
* <p>A pagination token that can be used in subsequent <a href="https://docs.aws.amazon.com/bedrock-agentcore-control/latest/APIReference/API_ListPolicySummaries.html">ListPolicySummaries</a> calls to retrieve additional results. This token is only present when there are more results available.</p>
|
|
1124
|
+
* @public
|
|
1125
|
+
*/
|
|
1126
|
+
nextToken?: string | undefined;
|
|
1127
|
+
}
|
|
1128
|
+
/**
|
|
1129
|
+
* @public
|
|
1130
|
+
*/
|
|
1131
|
+
export interface UpdatePolicyRequest {
|
|
1132
|
+
/**
|
|
1133
|
+
* <p>The identifier of the policy engine that manages the policy to be updated. This ensures the policy is updated within the correct policy engine context.</p>
|
|
1134
|
+
* @public
|
|
1135
|
+
*/
|
|
1136
|
+
policyEngineId: string | undefined;
|
|
1137
|
+
/**
|
|
1138
|
+
* <p>The unique identifier of the policy to be updated. This must be a valid policy ID that exists within the specified policy engine.</p>
|
|
1139
|
+
* @public
|
|
1140
|
+
*/
|
|
1141
|
+
policyId: string | undefined;
|
|
1142
|
+
/**
|
|
1143
|
+
* <p>The new human-readable description for the policy. This optional field allows updating the policy's documentation while keeping the same policy logic.</p>
|
|
1144
|
+
* @public
|
|
1145
|
+
*/
|
|
1146
|
+
description?: UpdatedDescription | undefined;
|
|
1147
|
+
/**
|
|
1148
|
+
* <p>The new Cedar policy statement that defines the access control rules. This replaces the existing policy definition with new logic while maintaining the policy's identity.</p>
|
|
1149
|
+
* @public
|
|
1150
|
+
*/
|
|
1151
|
+
definition?: PolicyDefinition | undefined;
|
|
1152
|
+
/**
|
|
1153
|
+
* <p>The validation mode for the policy update. Determines how Cedar analyzer validation results are handled during policy updates. FAIL_ON_ANY_FINDINGS runs the Cedar analyzer and fails the update if validation issues are detected, ensuring the policy conforms to the Cedar schema and tool context. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows updates despite validation warnings. Use FAIL_ON_ANY_FINDINGS to ensure policy correctness during updates, especially when modifying policy logic or conditions.</p>
|
|
1154
|
+
* @public
|
|
1155
|
+
*/
|
|
1156
|
+
validationMode?: PolicyValidationMode | undefined;
|
|
1157
|
+
/**
|
|
1158
|
+
* <p>The enforcement mode for the policy. Run this policy in <code>LOG_ONLY</code> mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to <code>ACTIVE</code>. If you omit this field, the policy's existing enforcement mode is unchanged.</p>
|
|
1159
|
+
* @public
|
|
1160
|
+
*/
|
|
1161
|
+
enforcementMode?: EnforcementMode | undefined;
|
|
1162
|
+
}
|
|
1163
|
+
/**
|
|
1164
|
+
* @public
|
|
1165
|
+
*/
|
|
1166
|
+
export interface UpdatePolicyResponse {
|
|
1167
|
+
/**
|
|
1168
|
+
* <p>The unique identifier of the updated policy.</p>
|
|
1169
|
+
* @public
|
|
1170
|
+
*/
|
|
1171
|
+
policyId: string | undefined;
|
|
1172
|
+
/**
|
|
1173
|
+
* <p>The name of the updated policy.</p>
|
|
1174
|
+
* @public
|
|
1175
|
+
*/
|
|
1176
|
+
name: string | undefined;
|
|
1177
|
+
/**
|
|
1178
|
+
* <p>The identifier of the policy engine managing the updated policy.</p>
|
|
1179
|
+
* @public
|
|
1180
|
+
*/
|
|
1181
|
+
policyEngineId: string | undefined;
|
|
1182
|
+
/**
|
|
1183
|
+
* <p>The original creation timestamp of the policy.</p>
|
|
1184
|
+
* @public
|
|
1185
|
+
*/
|
|
1186
|
+
createdAt: Date | undefined;
|
|
1187
|
+
/**
|
|
1188
|
+
* <p>The timestamp when the policy was last updated.</p>
|
|
1189
|
+
* @public
|
|
1190
|
+
*/
|
|
1191
|
+
updatedAt: Date | undefined;
|
|
1192
|
+
/**
|
|
1193
|
+
* <p>The ARN of the updated policy.</p>
|
|
1194
|
+
* @public
|
|
1195
|
+
*/
|
|
1196
|
+
policyArn: string | undefined;
|
|
1197
|
+
/**
|
|
1198
|
+
* <p>The current status of the updated policy.</p>
|
|
1199
|
+
* @public
|
|
1200
|
+
*/
|
|
1201
|
+
status: PolicyStatus | undefined;
|
|
1202
|
+
/**
|
|
1203
|
+
* <p>The current enforcement mode of the updated policy.</p>
|
|
1204
|
+
* @public
|
|
1205
|
+
*/
|
|
1206
|
+
enforcementMode?: EnforcementMode | undefined;
|
|
1207
|
+
/**
|
|
1208
|
+
* <p>The updated Cedar policy statement.</p>
|
|
1209
|
+
* @public
|
|
1210
|
+
*/
|
|
1211
|
+
definition: PolicyDefinition | undefined;
|
|
1212
|
+
/**
|
|
1213
|
+
* <p>The updated description of the policy.</p>
|
|
1214
|
+
* @public
|
|
1215
|
+
*/
|
|
1216
|
+
description?: string | undefined;
|
|
1217
|
+
/**
|
|
1218
|
+
* <p>Additional information about the update status.</p>
|
|
1219
|
+
* @public
|
|
1220
|
+
*/
|
|
1221
|
+
statusReasons: string[] | undefined;
|
|
1222
|
+
}
|
|
1223
|
+
/**
|
|
1224
|
+
* @public
|
|
1225
|
+
*/
|
|
1226
|
+
export interface PutResourcePolicyRequest {
|
|
1227
|
+
/**
|
|
1228
|
+
* <p>The Amazon Resource Name (ARN) of the resource for which to create or update the resource policy.</p>
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1231
|
+
resourceArn: string | undefined;
|
|
1232
|
+
/**
|
|
1233
|
+
* <p>The resource policy to create or update.</p>
|
|
1234
|
+
* @public
|
|
1235
|
+
*/
|
|
1236
|
+
policy: string | undefined;
|
|
1237
|
+
}
|
|
1238
|
+
/**
|
|
1239
|
+
* @public
|
|
1240
|
+
*/
|
|
1241
|
+
export interface PutResourcePolicyResponse {
|
|
1242
|
+
/**
|
|
1243
|
+
* <p>The resource policy that was created or updated.</p>
|
|
1244
|
+
* @public
|
|
1245
|
+
*/
|
|
1246
|
+
policy: string | undefined;
|
|
1247
|
+
}
|
|
1248
|
+
/**
|
|
1249
|
+
* <p>A custom descriptor for a registry record. Use this for resources such as APIs, Lambda functions, or servers that do not conform to a standard protocol like MCP or A2A.</p>
|
|
1250
|
+
* @public
|
|
1251
|
+
*/
|
|
1252
|
+
export interface CustomDescriptor {
|
|
1253
|
+
/**
|
|
1254
|
+
* <p>The custom descriptor content as a valid JSON document. You can define any custom schema that describes your resource.</p>
|
|
1255
|
+
* @public
|
|
1256
|
+
*/
|
|
1257
|
+
inlineContent?: string | undefined;
|
|
1258
|
+
}
|
|
1259
|
+
/**
|
|
1260
|
+
* <p>The server definition for an MCP descriptor. Contains the schema version and inline content for the MCP server configuration.</p>
|
|
1261
|
+
* @public
|
|
1262
|
+
*/
|
|
1263
|
+
export interface ServerDefinition {
|
|
1264
|
+
/**
|
|
1265
|
+
* <p>The schema version of the server definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.</p>
|
|
1266
|
+
* @public
|
|
1267
|
+
*/
|
|
1268
|
+
schemaVersion?: string | undefined;
|
|
1269
|
+
/**
|
|
1270
|
+
* <p>The JSON content containing the MCP server definition, conforming to the MCP protocol specification.</p>
|
|
1271
|
+
* @public
|
|
1272
|
+
*/
|
|
1273
|
+
inlineContent?: string | undefined;
|
|
1274
|
+
}
|
|
1275
|
+
/**
|
|
1276
|
+
* <p>The tools definition for an MCP descriptor. Contains the protocol version and inline content describing the available tools.</p>
|
|
1277
|
+
* @public
|
|
1278
|
+
*/
|
|
1279
|
+
export interface ToolsDefinition {
|
|
1280
|
+
/**
|
|
1281
|
+
* <p>The protocol version of the tools definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.</p>
|
|
1282
|
+
* @public
|
|
1283
|
+
*/
|
|
1284
|
+
protocolVersion?: string | undefined;
|
|
1285
|
+
/**
|
|
1286
|
+
* <p>The JSON content containing the MCP tools definition, conforming to the MCP protocol specification.</p>
|
|
1287
|
+
* @public
|
|
1288
|
+
*/
|
|
1289
|
+
inlineContent?: string | undefined;
|
|
1290
|
+
}
|
|
1291
|
+
/**
|
|
1292
|
+
* <p>The Model Context Protocol (MCP) descriptor for a registry record. Contains the server definition and tools definition for an MCP-compatible server. The schema is validated against the MCP protocol specification.</p>
|
|
1293
|
+
* @public
|
|
1294
|
+
*/
|
|
1295
|
+
export interface McpDescriptor {
|
|
1296
|
+
/**
|
|
1297
|
+
* <p>The MCP server definition, containing the server configuration and schema as defined by the MCP protocol specification.</p>
|
|
1298
|
+
* @public
|
|
1299
|
+
*/
|
|
1300
|
+
server?: ServerDefinition | undefined;
|
|
1301
|
+
/**
|
|
1302
|
+
* <p>The MCP tools definition, containing the tools available on the MCP server as defined by the MCP protocol specification.</p>
|
|
1303
|
+
* @public
|
|
1304
|
+
*/
|
|
1305
|
+
tools?: ToolsDefinition | undefined;
|
|
1306
|
+
}
|
|
1307
|
+
/**
|
|
1308
|
+
* <p>Contains descriptor-type-specific configurations for a registry record. Only the descriptor matching the record's <code>descriptorType</code> should be populated.</p>
|
|
1309
|
+
* @public
|
|
1310
|
+
*/
|
|
1311
|
+
export interface Descriptors {
|
|
1312
|
+
/**
|
|
1313
|
+
* <p>The Model Context Protocol (MCP) descriptor configuration. Use this when the <code>descriptorType</code> is <code>MCP</code>.</p>
|
|
1314
|
+
* @public
|
|
1315
|
+
*/
|
|
1316
|
+
mcp?: McpDescriptor | undefined;
|
|
1317
|
+
/**
|
|
1318
|
+
* <p>The Agent-to-Agent (A2A) protocol descriptor configuration. Use this when the <code>descriptorType</code> is <code>A2A</code>.</p>
|
|
1319
|
+
* @public
|
|
1320
|
+
*/
|
|
1321
|
+
a2a?: A2aDescriptor | undefined;
|
|
1322
|
+
/**
|
|
1323
|
+
* <p>The custom descriptor configuration. Use this when the <code>descriptorType</code> is <code>CUSTOM</code>.</p>
|
|
1324
|
+
* @public
|
|
1325
|
+
*/
|
|
1326
|
+
custom?: CustomDescriptor | undefined;
|
|
1327
|
+
/**
|
|
1328
|
+
* <p>The agent skills descriptor configuration. Use this when the <code>descriptorType</code> is <code>AGENT_SKILLS</code>.</p>
|
|
1329
|
+
* @public
|
|
1330
|
+
*/
|
|
1331
|
+
agentSkills?: AgentSkillsDescriptor | undefined;
|
|
1332
|
+
}
|
|
1333
|
+
/**
|
|
1334
|
+
* <p>IAM credential provider configuration for authenticating with an external source using SigV4 signing during synchronization.</p>
|
|
1335
|
+
* @public
|
|
1336
|
+
*/
|
|
1337
|
+
export interface RegistryRecordIamCredentialProvider {
|
|
1338
|
+
/**
|
|
1339
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role to assume for SigV4 signing.</p>
|
|
1340
|
+
* @public
|
|
1341
|
+
*/
|
|
1342
|
+
roleArn?: string | undefined;
|
|
1343
|
+
/**
|
|
1344
|
+
* <p>The SigV4 signing service name (for example, <code>execute-api</code> or <code>bedrock-agentcore</code>).</p>
|
|
1345
|
+
* @public
|
|
1346
|
+
*/
|
|
1347
|
+
service?: string | undefined;
|
|
1348
|
+
/**
|
|
1349
|
+
* <p>The Amazon Web Services region for SigV4 signing (for example, <code>us-west-2</code>). If not specified, the region is extracted from the MCP server URL hostname, with fallback to the service's own region.</p>
|
|
1350
|
+
* @public
|
|
1351
|
+
*/
|
|
1352
|
+
region?: string | undefined;
|
|
1353
|
+
}
|
|
1354
|
+
/**
|
|
1355
|
+
* <p>OAuth credential provider configuration for authenticating with an external source during synchronization.</p>
|
|
1356
|
+
* @public
|
|
1357
|
+
*/
|
|
1358
|
+
export interface RegistryRecordOAuthCredentialProvider {
|
|
1359
|
+
/**
|
|
1360
|
+
* <p>The Amazon Resource Name (ARN) of the OAuth credential provider resource.</p>
|
|
1361
|
+
* @public
|
|
1362
|
+
*/
|
|
1363
|
+
providerArn: string | undefined;
|
|
1364
|
+
/**
|
|
1365
|
+
* <p>The OAuth grant type. Currently only <code>CLIENT_CREDENTIALS</code> is supported.</p>
|
|
1366
|
+
* @public
|
|
1367
|
+
*/
|
|
1368
|
+
grantType?: RegistryRecordOAuthGrantType | undefined;
|
|
1369
|
+
/**
|
|
1370
|
+
* <p>The OAuth scopes to request during authentication.</p>
|
|
1371
|
+
* @public
|
|
1372
|
+
*/
|
|
1373
|
+
scopes?: string[] | undefined;
|
|
1374
|
+
/**
|
|
1375
|
+
* <p>Additional custom parameters for the OAuth flow.</p>
|
|
1376
|
+
* @public
|
|
1377
|
+
*/
|
|
1378
|
+
customParameters?: Record<string, string> | undefined;
|
|
1379
|
+
}
|
|
1380
|
+
/**
|
|
1381
|
+
* <p>Union of supported credential provider types for registry record synchronization.</p>
|
|
1382
|
+
* @public
|
|
1383
|
+
*/
|
|
1384
|
+
export type RegistryRecordCredentialProviderUnion = RegistryRecordCredentialProviderUnion.IamCredentialProviderMember | RegistryRecordCredentialProviderUnion.OauthCredentialProviderMember | RegistryRecordCredentialProviderUnion.$UnknownMember;
|
|
1385
|
+
/**
|
|
1386
|
+
* @public
|
|
1387
|
+
*/
|
|
1388
|
+
export declare namespace RegistryRecordCredentialProviderUnion {
|
|
1389
|
+
/**
|
|
1390
|
+
* <p>The OAuth credential provider configuration for authenticating with the external source.</p>
|
|
1391
|
+
* @public
|
|
1392
|
+
*/
|
|
1393
|
+
interface OauthCredentialProviderMember {
|
|
1394
|
+
oauthCredentialProvider: RegistryRecordOAuthCredentialProvider;
|
|
1395
|
+
iamCredentialProvider?: never;
|
|
1396
|
+
$unknown?: never;
|
|
1397
|
+
}
|
|
1398
|
+
/**
|
|
1399
|
+
* <p>The IAM credential provider configuration for authenticating with the external source using SigV4 signing.</p>
|
|
1400
|
+
* @public
|
|
1401
|
+
*/
|
|
1402
|
+
interface IamCredentialProviderMember {
|
|
1403
|
+
oauthCredentialProvider?: never;
|
|
1404
|
+
iamCredentialProvider: RegistryRecordIamCredentialProvider;
|
|
1405
|
+
$unknown?: never;
|
|
1406
|
+
}
|
|
1407
|
+
/**
|
|
1408
|
+
* @public
|
|
1409
|
+
*/
|
|
1410
|
+
interface $UnknownMember {
|
|
1411
|
+
oauthCredentialProvider?: never;
|
|
1412
|
+
iamCredentialProvider?: never;
|
|
1413
|
+
$unknown: [string, any];
|
|
1414
|
+
}
|
|
1415
|
+
/**
|
|
1416
|
+
* @deprecated unused in schema-serde mode.
|
|
1417
|
+
*
|
|
1418
|
+
*/
|
|
1419
|
+
interface Visitor<T> {
|
|
1420
|
+
oauthCredentialProvider: (value: RegistryRecordOAuthCredentialProvider) => T;
|
|
1421
|
+
iamCredentialProvider: (value: RegistryRecordIamCredentialProvider) => T;
|
|
1422
|
+
_: (name: string, value: any) => T;
|
|
1423
|
+
}
|
|
1424
|
+
}
|
|
1425
|
+
/**
|
|
1426
|
+
* <p>A pairing of a credential provider type with its corresponding provider details for authenticating with external sources.</p>
|
|
1427
|
+
* @public
|
|
1428
|
+
*/
|
|
1429
|
+
export interface RegistryRecordCredentialProviderConfiguration {
|
|
1430
|
+
/**
|
|
1431
|
+
* <p>The type of credential provider.</p> <ul> <li> <p> <code>OAUTH</code> - OAuth-based authentication.</p> </li> <li> <p> <code>IAM</code> - Amazon Web Services IAM-based authentication using SigV4 signing.</p> </li> </ul>
|
|
1432
|
+
* @public
|
|
1433
|
+
*/
|
|
1434
|
+
credentialProviderType: RegistryRecordCredentialProviderType | undefined;
|
|
1435
|
+
/**
|
|
1436
|
+
* <p>The credential provider configuration details. The structure depends on the <code>credentialProviderType</code>.</p>
|
|
1437
|
+
* @public
|
|
1438
|
+
*/
|
|
1439
|
+
credentialProvider: RegistryRecordCredentialProviderUnion | undefined;
|
|
1440
|
+
}
|
|
4
1441
|
/**
|
|
5
1442
|
* <p>Configuration for synchronizing from a URL-based MCP server.</p>
|
|
6
1443
|
* @public
|