aws-sdk-bedrockagentcorecontrol 1.67.0 → 1.69.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagentcorecontrol/client.rb +360 -37
- data/lib/aws-sdk-bedrockagentcorecontrol/client_api.rb +219 -3
- data/lib/aws-sdk-bedrockagentcorecontrol/types.rb +546 -46
- data/lib/aws-sdk-bedrockagentcorecontrol.rb +1 -1
- data/sig/client.rbs +124 -3
- data/sig/types.rbs +122 -0
- metadata +1 -1
|
@@ -1268,6 +1268,13 @@ module Aws::BedrockAgentCoreControl
|
|
|
1268
1268
|
# The list of CloudWatch log group names to monitor for agent traces.
|
|
1269
1269
|
# @return [Array<String>]
|
|
1270
1270
|
#
|
|
1271
|
+
# @!attribute [rw] log_group_name_prefixes
|
|
1272
|
+
# The list of CloudWatch log group name prefixes to monitor for agent
|
|
1273
|
+
# traces. Specify this instead of `logGroupNames` to match log groups
|
|
1274
|
+
# by prefix. Specify either `logGroupNames` or `logGroupNamePrefixes`,
|
|
1275
|
+
# not both. One of the two is required.
|
|
1276
|
+
# @return [Array<String>]
|
|
1277
|
+
#
|
|
1271
1278
|
# @!attribute [rw] service_names
|
|
1272
1279
|
# The list of service names to filter traces within the specified log
|
|
1273
1280
|
# groups. Used to identify relevant agent sessions.
|
|
@@ -1277,6 +1284,7 @@ module Aws::BedrockAgentCoreControl
|
|
|
1277
1284
|
#
|
|
1278
1285
|
class CloudWatchLogsInputConfig < Struct.new(
|
|
1279
1286
|
:log_group_names,
|
|
1287
|
+
:log_group_name_prefixes,
|
|
1280
1288
|
:service_names)
|
|
1281
1289
|
SENSITIVE = []
|
|
1282
1290
|
include Aws::Structure
|
|
@@ -1287,13 +1295,39 @@ module Aws::BedrockAgentCoreControl
|
|
|
1287
1295
|
#
|
|
1288
1296
|
# @!attribute [rw] log_group_name
|
|
1289
1297
|
# The name of the CloudWatch log group where evaluation results will
|
|
1290
|
-
# be written.
|
|
1298
|
+
# be written. An existing log group is used as-is; otherwise the
|
|
1299
|
+
# service creates it, which requires the evaluation execution role to
|
|
1300
|
+
# grant `logs:CreateLogGroup` on the log group. Don't specify this
|
|
1301
|
+
# value when `resultDestination` is `SOURCE_LOG_GROUP`. The name
|
|
1302
|
+
# can't be under the service-reserved
|
|
1303
|
+
# `/aws/bedrock-agentcore/evaluations/` namespace, apart from this
|
|
1304
|
+
# configuration's own service-managed default group.
|
|
1305
|
+
# @return [String]
|
|
1306
|
+
#
|
|
1307
|
+
# @!attribute [rw] metrics_namespace
|
|
1308
|
+
# The CloudWatch metrics namespace where evaluation result metrics are
|
|
1309
|
+
# published. If you omit this value, the service publishes metrics to
|
|
1310
|
+
# `Bedrock-AgentCore/Evaluations`. This value can't begin with
|
|
1311
|
+
# `AWS/`.
|
|
1312
|
+
# @return [String]
|
|
1313
|
+
#
|
|
1314
|
+
# @!attribute [rw] result_destination
|
|
1315
|
+
# The destination where evaluation results are written. Valid values:
|
|
1316
|
+
#
|
|
1317
|
+
# * `DEDICATED_LOG_GROUP` (default) – Writes results to a dedicated
|
|
1318
|
+
# result log group.
|
|
1319
|
+
#
|
|
1320
|
+
# * `SOURCE_LOG_GROUP` – Writes results back to the log group that the
|
|
1321
|
+
# agent traces were read from. If you use this value, don't specify
|
|
1322
|
+
# `logGroupName`.
|
|
1291
1323
|
# @return [String]
|
|
1292
1324
|
#
|
|
1293
1325
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/CloudWatchOutputConfig AWS API Documentation
|
|
1294
1326
|
#
|
|
1295
1327
|
class CloudWatchOutputConfig < Struct.new(
|
|
1296
|
-
:log_group_name
|
|
1328
|
+
:log_group_name,
|
|
1329
|
+
:metrics_namespace,
|
|
1330
|
+
:result_destination)
|
|
1297
1331
|
SENSITIVE = []
|
|
1298
1332
|
include Aws::Structure
|
|
1299
1333
|
end
|
|
@@ -1894,6 +1928,108 @@ module Aws::BedrockAgentCoreControl
|
|
|
1894
1928
|
include Aws::Structure
|
|
1895
1929
|
end
|
|
1896
1930
|
|
|
1931
|
+
# The identity provider configuration used to authenticate end users to
|
|
1932
|
+
# the consent portal.
|
|
1933
|
+
#
|
|
1934
|
+
# @!attribute [rw] credential_provider_arn
|
|
1935
|
+
# The Amazon Resource Name (ARN) of the OAuth2 credential provider
|
|
1936
|
+
# used to authenticate end users to the consent portal.
|
|
1937
|
+
# @return [String]
|
|
1938
|
+
#
|
|
1939
|
+
# @!attribute [rw] scopes
|
|
1940
|
+
# The OAuth2 scopes that the consent portal requests when
|
|
1941
|
+
# authenticating end users.
|
|
1942
|
+
# @return [Array<String>]
|
|
1943
|
+
#
|
|
1944
|
+
# @!attribute [rw] audience
|
|
1945
|
+
# The audience value that the consent portal includes when requesting
|
|
1946
|
+
# tokens from the identity provider.
|
|
1947
|
+
# @return [String]
|
|
1948
|
+
#
|
|
1949
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/ConsentPortalIdpConfig AWS API Documentation
|
|
1950
|
+
#
|
|
1951
|
+
class ConsentPortalIdpConfig < Struct.new(
|
|
1952
|
+
:credential_provider_arn,
|
|
1953
|
+
:scopes,
|
|
1954
|
+
:audience)
|
|
1955
|
+
SENSITIVE = []
|
|
1956
|
+
include Aws::Structure
|
|
1957
|
+
end
|
|
1958
|
+
|
|
1959
|
+
# A resource served by the consent portal.
|
|
1960
|
+
#
|
|
1961
|
+
# @!attribute [rw] identifier
|
|
1962
|
+
# The identifier of the source resource. For an `agentcore-gateway`
|
|
1963
|
+
# source, this is the gateway ID or its Amazon Resource Name (ARN).
|
|
1964
|
+
# @return [String]
|
|
1965
|
+
#
|
|
1966
|
+
# @!attribute [rw] type
|
|
1967
|
+
# The type of the source resource.
|
|
1968
|
+
# @return [String]
|
|
1969
|
+
#
|
|
1970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/ConsentPortalSource AWS API Documentation
|
|
1971
|
+
#
|
|
1972
|
+
class ConsentPortalSource < Struct.new(
|
|
1973
|
+
:identifier,
|
|
1974
|
+
:type)
|
|
1975
|
+
SENSITIVE = []
|
|
1976
|
+
include Aws::Structure
|
|
1977
|
+
end
|
|
1978
|
+
|
|
1979
|
+
# Summary information about a consent portal.
|
|
1980
|
+
#
|
|
1981
|
+
# @!attribute [rw] sources
|
|
1982
|
+
# The resources served by the consent portal.
|
|
1983
|
+
# @return [Array<Types::ConsentPortalSource>]
|
|
1984
|
+
#
|
|
1985
|
+
# @!attribute [rw] consent_portal_arn
|
|
1986
|
+
# The Amazon Resource Name (ARN) of the consent portal.
|
|
1987
|
+
# @return [String]
|
|
1988
|
+
#
|
|
1989
|
+
# @!attribute [rw] consent_portal_id
|
|
1990
|
+
# The unique identifier of the consent portal.
|
|
1991
|
+
# @return [String]
|
|
1992
|
+
#
|
|
1993
|
+
# @!attribute [rw] created_at
|
|
1994
|
+
# The timestamp for when the consent portal was created.
|
|
1995
|
+
# @return [Time]
|
|
1996
|
+
#
|
|
1997
|
+
# @!attribute [rw] description
|
|
1998
|
+
# The description of the consent portal.
|
|
1999
|
+
# @return [String]
|
|
2000
|
+
#
|
|
2001
|
+
# @!attribute [rw] name
|
|
2002
|
+
# The name of the consent portal.
|
|
2003
|
+
# @return [String]
|
|
2004
|
+
#
|
|
2005
|
+
# @!attribute [rw] portal_url
|
|
2006
|
+
# The URL used to access the consent portal.
|
|
2007
|
+
# @return [String]
|
|
2008
|
+
#
|
|
2009
|
+
# @!attribute [rw] status
|
|
2010
|
+
# The current status of the consent portal.
|
|
2011
|
+
# @return [String]
|
|
2012
|
+
#
|
|
2013
|
+
# @!attribute [rw] updated_at
|
|
2014
|
+
# The timestamp for when the consent portal was last updated.
|
|
2015
|
+
# @return [Time]
|
|
2016
|
+
#
|
|
2017
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/ConsentPortalSummary AWS API Documentation
|
|
2018
|
+
#
|
|
2019
|
+
class ConsentPortalSummary < Struct.new(
|
|
2020
|
+
:sources,
|
|
2021
|
+
:consent_portal_arn,
|
|
2022
|
+
:consent_portal_id,
|
|
2023
|
+
:created_at,
|
|
2024
|
+
:description,
|
|
2025
|
+
:name,
|
|
2026
|
+
:portal_url,
|
|
2027
|
+
:status,
|
|
2028
|
+
:updated_at)
|
|
2029
|
+
SENSITIVE = []
|
|
2030
|
+
include Aws::Structure
|
|
2031
|
+
end
|
|
2032
|
+
|
|
1897
2033
|
# Contains consolidation configuration information for a memory
|
|
1898
2034
|
# strategy.
|
|
1899
2035
|
#
|
|
@@ -1940,7 +2076,7 @@ module Aws::BedrockAgentCoreControl
|
|
|
1940
2076
|
# @!attribute [rw] raw_text
|
|
1941
2077
|
# The raw text content containing natural language descriptions of
|
|
1942
2078
|
# desired policy behavior. This text is processed by AI to generate
|
|
1943
|
-
# corresponding
|
|
2079
|
+
# corresponding Dogwood policy statements that match the described
|
|
1944
2080
|
# intent.
|
|
1945
2081
|
# @return [String]
|
|
1946
2082
|
#
|
|
@@ -2713,6 +2849,119 @@ module Aws::BedrockAgentCoreControl
|
|
|
2713
2849
|
include Aws::Structure
|
|
2714
2850
|
end
|
|
2715
2851
|
|
|
2852
|
+
# @!attribute [rw] execution_role_arn
|
|
2853
|
+
# The Amazon Resource Name (ARN) of the IAM role that the consent
|
|
2854
|
+
# portal assumes to access the resources defined in its sources.
|
|
2855
|
+
# @return [String]
|
|
2856
|
+
#
|
|
2857
|
+
# @!attribute [rw] idp_config
|
|
2858
|
+
# The identity provider configuration that the consent portal uses to
|
|
2859
|
+
# authenticate end users.
|
|
2860
|
+
# @return [Types::ConsentPortalIdpConfig]
|
|
2861
|
+
#
|
|
2862
|
+
# @!attribute [rw] name
|
|
2863
|
+
# The name of the consent portal. The name must be unique within your
|
|
2864
|
+
# account.
|
|
2865
|
+
# @return [String]
|
|
2866
|
+
#
|
|
2867
|
+
# @!attribute [rw] sources
|
|
2868
|
+
# The resources served by the consent portal. Currently, we only
|
|
2869
|
+
# support type `agentcore-gateway`.
|
|
2870
|
+
# @return [Array<Types::ConsentPortalSource>]
|
|
2871
|
+
#
|
|
2872
|
+
# @!attribute [rw] description
|
|
2873
|
+
# The description of the consent portal.
|
|
2874
|
+
# @return [String]
|
|
2875
|
+
#
|
|
2876
|
+
# @!attribute [rw] tags
|
|
2877
|
+
# A map of tag keys and values to assign to the consent portal. Tags
|
|
2878
|
+
# enable you to categorize your resources in different ways, for
|
|
2879
|
+
# example, by purpose, owner, or environment.
|
|
2880
|
+
# @return [Hash<String,String>]
|
|
2881
|
+
#
|
|
2882
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/CreateConsentPortalRequest AWS API Documentation
|
|
2883
|
+
#
|
|
2884
|
+
class CreateConsentPortalRequest < Struct.new(
|
|
2885
|
+
:execution_role_arn,
|
|
2886
|
+
:idp_config,
|
|
2887
|
+
:name,
|
|
2888
|
+
:sources,
|
|
2889
|
+
:description,
|
|
2890
|
+
:tags)
|
|
2891
|
+
SENSITIVE = []
|
|
2892
|
+
include Aws::Structure
|
|
2893
|
+
end
|
|
2894
|
+
|
|
2895
|
+
# @!attribute [rw] sources
|
|
2896
|
+
# The resources served by the consent portal.
|
|
2897
|
+
# @return [Array<Types::ConsentPortalSource>]
|
|
2898
|
+
#
|
|
2899
|
+
# @!attribute [rw] consent_portal_arn
|
|
2900
|
+
# The Amazon Resource Name (ARN) of the consent portal.
|
|
2901
|
+
# @return [String]
|
|
2902
|
+
#
|
|
2903
|
+
# @!attribute [rw] consent_portal_id
|
|
2904
|
+
# The unique identifier of the consent portal.
|
|
2905
|
+
# @return [String]
|
|
2906
|
+
#
|
|
2907
|
+
# @!attribute [rw] created_at
|
|
2908
|
+
# The timestamp for when the consent portal was created.
|
|
2909
|
+
# @return [Time]
|
|
2910
|
+
#
|
|
2911
|
+
# @!attribute [rw] description
|
|
2912
|
+
# The description of the consent portal.
|
|
2913
|
+
# @return [String]
|
|
2914
|
+
#
|
|
2915
|
+
# @!attribute [rw] execution_role_arn
|
|
2916
|
+
# The Amazon Resource Name (ARN) of the IAM role that the consent
|
|
2917
|
+
# portal assumes to access the resources defined in its sources.
|
|
2918
|
+
# @return [String]
|
|
2919
|
+
#
|
|
2920
|
+
# @!attribute [rw] idp_config
|
|
2921
|
+
# The identity provider configuration that the consent portal uses to
|
|
2922
|
+
# authenticate end users.
|
|
2923
|
+
# @return [Types::ConsentPortalIdpConfig]
|
|
2924
|
+
#
|
|
2925
|
+
# @!attribute [rw] name
|
|
2926
|
+
# The name of the consent portal.
|
|
2927
|
+
# @return [String]
|
|
2928
|
+
#
|
|
2929
|
+
# @!attribute [rw] portal_url
|
|
2930
|
+
# The URL used to access the consent portal.
|
|
2931
|
+
# @return [String]
|
|
2932
|
+
#
|
|
2933
|
+
# @!attribute [rw] status
|
|
2934
|
+
# The current status of the consent portal.
|
|
2935
|
+
# @return [String]
|
|
2936
|
+
#
|
|
2937
|
+
# @!attribute [rw] status_reason
|
|
2938
|
+
# A message that provides additional information about the current
|
|
2939
|
+
# status of the consent portal.
|
|
2940
|
+
# @return [String]
|
|
2941
|
+
#
|
|
2942
|
+
# @!attribute [rw] updated_at
|
|
2943
|
+
# The timestamp for when the consent portal was last updated.
|
|
2944
|
+
# @return [Time]
|
|
2945
|
+
#
|
|
2946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/CreateConsentPortalResponse AWS API Documentation
|
|
2947
|
+
#
|
|
2948
|
+
class CreateConsentPortalResponse < Struct.new(
|
|
2949
|
+
:sources,
|
|
2950
|
+
:consent_portal_arn,
|
|
2951
|
+
:consent_portal_id,
|
|
2952
|
+
:created_at,
|
|
2953
|
+
:description,
|
|
2954
|
+
:execution_role_arn,
|
|
2955
|
+
:idp_config,
|
|
2956
|
+
:name,
|
|
2957
|
+
:portal_url,
|
|
2958
|
+
:status,
|
|
2959
|
+
:status_reason,
|
|
2960
|
+
:updated_at)
|
|
2961
|
+
SENSITIVE = []
|
|
2962
|
+
include Aws::Structure
|
|
2963
|
+
end
|
|
2964
|
+
|
|
2716
2965
|
# @!attribute [rw] client_token
|
|
2717
2966
|
# A unique, case-sensitive identifier to ensure that the API request
|
|
2718
2967
|
# completes no more than one time. If you don't specify this field, a
|
|
@@ -3977,6 +4226,11 @@ module Aws::BedrockAgentCoreControl
|
|
|
3977
4226
|
# results.
|
|
3978
4227
|
# @return [Types::ClusteringConfig]
|
|
3979
4228
|
#
|
|
4229
|
+
# @!attribute [rw] output_config
|
|
4230
|
+
# The configuration that specifies where evaluation results should be
|
|
4231
|
+
# written for monitoring and analysis.
|
|
4232
|
+
# @return [Types::OutputConfig]
|
|
4233
|
+
#
|
|
3980
4234
|
# @!attribute [rw] evaluation_execution_role_arn
|
|
3981
4235
|
# The Amazon Resource Name (ARN) of the IAM role that grants
|
|
3982
4236
|
# permissions to read from CloudWatch logs, write evaluation results,
|
|
@@ -4014,6 +4268,7 @@ module Aws::BedrockAgentCoreControl
|
|
|
4014
4268
|
:evaluators,
|
|
4015
4269
|
:insights,
|
|
4016
4270
|
:clustering_config,
|
|
4271
|
+
:output_config,
|
|
4017
4272
|
:evaluation_execution_role_arn,
|
|
4018
4273
|
:enable_on_create,
|
|
4019
4274
|
:tags)
|
|
@@ -4499,10 +4754,10 @@ module Aws::BedrockAgentCoreControl
|
|
|
4499
4754
|
# @return [String]
|
|
4500
4755
|
#
|
|
4501
4756
|
# @!attribute [rw] definition
|
|
4502
|
-
# The Cedar policy statement that defines the access
|
|
4503
|
-
# This contains the actual policy logic written in
|
|
4504
|
-
#
|
|
4505
|
-
# resources, and conditions for agent behavior control.
|
|
4757
|
+
# The Cedar or Dogwood policy statement that defines the access
|
|
4758
|
+
# control rules. This contains the actual policy logic written in
|
|
4759
|
+
# Cedar or Dogwood, specifying effect (permit or forbid), principals,
|
|
4760
|
+
# actions, resources, and conditions for agent behavior control.
|
|
4506
4761
|
# @return [Types::PolicyDefinition]
|
|
4507
4762
|
#
|
|
4508
4763
|
# @!attribute [rw] description
|
|
@@ -4612,9 +4867,9 @@ module Aws::BedrockAgentCoreControl
|
|
|
4612
4867
|
# @return [String]
|
|
4613
4868
|
#
|
|
4614
4869
|
# @!attribute [rw] definition
|
|
4615
|
-
# The Cedar policy statement that was created. This is the
|
|
4616
|
-
# policy definition that will be used for agent behavior
|
|
4617
|
-
# access decisions.
|
|
4870
|
+
# The Cedar or Dogwood policy statement that was created. This is the
|
|
4871
|
+
# validated policy definition that will be used for agent behavior
|
|
4872
|
+
# control and access decisions.
|
|
4618
4873
|
# @return [Types::PolicyDefinition]
|
|
4619
4874
|
#
|
|
4620
4875
|
# @!attribute [rw] description
|
|
@@ -5990,6 +6245,23 @@ module Aws::BedrockAgentCoreControl
|
|
|
5990
6245
|
include Aws::Structure
|
|
5991
6246
|
end
|
|
5992
6247
|
|
|
6248
|
+
# @!attribute [rw] consent_portal_identifier
|
|
6249
|
+
# The identifier of the consent portal. You can specify either the
|
|
6250
|
+
# consent portal ID or its Amazon Resource Name (ARN).
|
|
6251
|
+
# @return [String]
|
|
6252
|
+
#
|
|
6253
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/DeleteConsentPortalRequest AWS API Documentation
|
|
6254
|
+
#
|
|
6255
|
+
class DeleteConsentPortalRequest < Struct.new(
|
|
6256
|
+
:consent_portal_identifier)
|
|
6257
|
+
SENSITIVE = []
|
|
6258
|
+
include Aws::Structure
|
|
6259
|
+
end
|
|
6260
|
+
|
|
6261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/DeleteConsentPortalResponse AWS API Documentation
|
|
6262
|
+
#
|
|
6263
|
+
class DeleteConsentPortalResponse < Aws::EmptyStructure; end
|
|
6264
|
+
|
|
5993
6265
|
# @!attribute [rw] dataset_id
|
|
5994
6266
|
# The unique identifier of the dataset.
|
|
5995
6267
|
# @return [String]
|
|
@@ -7880,10 +8152,10 @@ module Aws::BedrockAgentCoreControl
|
|
|
7880
8152
|
# allow or deny each action based on the defined policies.
|
|
7881
8153
|
#
|
|
7882
8154
|
# @!attribute [rw] arn
|
|
7883
|
-
# The ARN of the policy engine. The policy engine contains Cedar
|
|
7884
|
-
# policies that define fine-grained authorization rules
|
|
7885
|
-
# can perform what actions on which resources as agents
|
|
7886
|
-
# through the gateway.
|
|
8155
|
+
# The ARN of the policy engine. The policy engine contains Cedar or
|
|
8156
|
+
# Dogwood policies that define fine-grained authorization rules
|
|
8157
|
+
# specifying who can perform what actions on which resources as agents
|
|
8158
|
+
# interact through the gateway.
|
|
7887
8159
|
# @return [String]
|
|
7888
8160
|
#
|
|
7889
8161
|
# @!attribute [rw] mode
|
|
@@ -8953,6 +9225,89 @@ module Aws::BedrockAgentCoreControl
|
|
|
8953
9225
|
include Aws::Structure
|
|
8954
9226
|
end
|
|
8955
9227
|
|
|
9228
|
+
# @!attribute [rw] consent_portal_identifier
|
|
9229
|
+
# The identifier of the consent portal. You can specify either the
|
|
9230
|
+
# consent portal ID or its Amazon Resource Name (ARN).
|
|
9231
|
+
# @return [String]
|
|
9232
|
+
#
|
|
9233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/GetConsentPortalRequest AWS API Documentation
|
|
9234
|
+
#
|
|
9235
|
+
class GetConsentPortalRequest < Struct.new(
|
|
9236
|
+
:consent_portal_identifier)
|
|
9237
|
+
SENSITIVE = []
|
|
9238
|
+
include Aws::Structure
|
|
9239
|
+
end
|
|
9240
|
+
|
|
9241
|
+
# @!attribute [rw] sources
|
|
9242
|
+
# The resources served by the consent portal.
|
|
9243
|
+
# @return [Array<Types::ConsentPortalSource>]
|
|
9244
|
+
#
|
|
9245
|
+
# @!attribute [rw] consent_portal_arn
|
|
9246
|
+
# The Amazon Resource Name (ARN) of the consent portal.
|
|
9247
|
+
# @return [String]
|
|
9248
|
+
#
|
|
9249
|
+
# @!attribute [rw] consent_portal_id
|
|
9250
|
+
# The unique identifier of the consent portal.
|
|
9251
|
+
# @return [String]
|
|
9252
|
+
#
|
|
9253
|
+
# @!attribute [rw] created_at
|
|
9254
|
+
# The timestamp for when the consent portal was created.
|
|
9255
|
+
# @return [Time]
|
|
9256
|
+
#
|
|
9257
|
+
# @!attribute [rw] description
|
|
9258
|
+
# The description of the consent portal.
|
|
9259
|
+
# @return [String]
|
|
9260
|
+
#
|
|
9261
|
+
# @!attribute [rw] execution_role_arn
|
|
9262
|
+
# The Amazon Resource Name (ARN) of the IAM role that the consent
|
|
9263
|
+
# portal assumes to access the resources defined in its sources.
|
|
9264
|
+
# @return [String]
|
|
9265
|
+
#
|
|
9266
|
+
# @!attribute [rw] idp_config
|
|
9267
|
+
# The identity provider configuration that the consent portal uses to
|
|
9268
|
+
# authenticate end users.
|
|
9269
|
+
# @return [Types::ConsentPortalIdpConfig]
|
|
9270
|
+
#
|
|
9271
|
+
# @!attribute [rw] name
|
|
9272
|
+
# The name of the consent portal.
|
|
9273
|
+
# @return [String]
|
|
9274
|
+
#
|
|
9275
|
+
# @!attribute [rw] portal_url
|
|
9276
|
+
# The URL used to access the consent portal.
|
|
9277
|
+
# @return [String]
|
|
9278
|
+
#
|
|
9279
|
+
# @!attribute [rw] status
|
|
9280
|
+
# The current status of the consent portal.
|
|
9281
|
+
# @return [String]
|
|
9282
|
+
#
|
|
9283
|
+
# @!attribute [rw] status_reason
|
|
9284
|
+
# A message that provides additional information about the current
|
|
9285
|
+
# status of the consent portal.
|
|
9286
|
+
# @return [String]
|
|
9287
|
+
#
|
|
9288
|
+
# @!attribute [rw] updated_at
|
|
9289
|
+
# The timestamp for when the consent portal was last updated.
|
|
9290
|
+
# @return [Time]
|
|
9291
|
+
#
|
|
9292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/GetConsentPortalResponse AWS API Documentation
|
|
9293
|
+
#
|
|
9294
|
+
class GetConsentPortalResponse < Struct.new(
|
|
9295
|
+
:sources,
|
|
9296
|
+
:consent_portal_arn,
|
|
9297
|
+
:consent_portal_id,
|
|
9298
|
+
:created_at,
|
|
9299
|
+
:description,
|
|
9300
|
+
:execution_role_arn,
|
|
9301
|
+
:idp_config,
|
|
9302
|
+
:name,
|
|
9303
|
+
:portal_url,
|
|
9304
|
+
:status,
|
|
9305
|
+
:status_reason,
|
|
9306
|
+
:updated_at)
|
|
9307
|
+
SENSITIVE = []
|
|
9308
|
+
include Aws::Structure
|
|
9309
|
+
end
|
|
9310
|
+
|
|
8956
9311
|
# @!attribute [rw] dataset_id
|
|
8957
9312
|
# The unique identifier of the dataset to retrieve.
|
|
8958
9313
|
# @return [String]
|
|
@@ -10449,9 +10804,9 @@ module Aws::BedrockAgentCoreControl
|
|
|
10449
10804
|
# @return [String]
|
|
10450
10805
|
#
|
|
10451
10806
|
# @!attribute [rw] definition
|
|
10452
|
-
# The Cedar policy statement that defines the access
|
|
10453
|
-
# This contains the actual policy logic used for agent
|
|
10454
|
-
# control and access decisions.
|
|
10807
|
+
# The Cedar or Dogwood policy statement that defines the access
|
|
10808
|
+
# control rules. This contains the actual policy logic used for agent
|
|
10809
|
+
# behavior control and access decisions.
|
|
10455
10810
|
# @return [Types::PolicyDefinition]
|
|
10456
10811
|
#
|
|
10457
10812
|
# @!attribute [rw] description
|
|
@@ -13571,6 +13926,43 @@ module Aws::BedrockAgentCoreControl
|
|
|
13571
13926
|
include Aws::Structure
|
|
13572
13927
|
end
|
|
13573
13928
|
|
|
13929
|
+
# @!attribute [rw] max_results
|
|
13930
|
+
# The maximum number of consent portals to return in a single call.
|
|
13931
|
+
# @return [Integer]
|
|
13932
|
+
#
|
|
13933
|
+
# @!attribute [rw] next_token
|
|
13934
|
+
# A token to retrieve the next page of results. Use the value returned
|
|
13935
|
+
# in a previous response to request the next page.
|
|
13936
|
+
# @return [String]
|
|
13937
|
+
#
|
|
13938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/ListConsentPortalsRequest AWS API Documentation
|
|
13939
|
+
#
|
|
13940
|
+
class ListConsentPortalsRequest < Struct.new(
|
|
13941
|
+
:max_results,
|
|
13942
|
+
:next_token)
|
|
13943
|
+
SENSITIVE = []
|
|
13944
|
+
include Aws::Structure
|
|
13945
|
+
end
|
|
13946
|
+
|
|
13947
|
+
# @!attribute [rw] consent_portals
|
|
13948
|
+
# The list of consent portals.
|
|
13949
|
+
# @return [Array<Types::ConsentPortalSummary>]
|
|
13950
|
+
#
|
|
13951
|
+
# @!attribute [rw] next_token
|
|
13952
|
+
# The token to use in a subsequent request to retrieve the next page
|
|
13953
|
+
# of results. This value is null when there are no more results to
|
|
13954
|
+
# return.
|
|
13955
|
+
# @return [String]
|
|
13956
|
+
#
|
|
13957
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/ListConsentPortalsResponse AWS API Documentation
|
|
13958
|
+
#
|
|
13959
|
+
class ListConsentPortalsResponse < Struct.new(
|
|
13960
|
+
:consent_portals,
|
|
13961
|
+
:next_token)
|
|
13962
|
+
SENSITIVE = []
|
|
13963
|
+
include Aws::Structure
|
|
13964
|
+
end
|
|
13965
|
+
|
|
13574
13966
|
# @!attribute [rw] dataset_id
|
|
13575
13967
|
# The unique identifier of the dataset.
|
|
13576
13968
|
# @return [String]
|
|
@@ -14480,7 +14872,7 @@ module Aws::BedrockAgentCoreControl
|
|
|
14480
14872
|
end
|
|
14481
14873
|
|
|
14482
14874
|
# @!attribute [rw] policy_generation_assets
|
|
14483
|
-
# An array of generated policy assets including
|
|
14875
|
+
# An array of generated policy assets including Dogwood policies and
|
|
14484
14876
|
# related artifacts from the AI-powered policy generation process.
|
|
14485
14877
|
# Each asset represents a different policy option or variation
|
|
14486
14878
|
# generated from the original natural language input.
|
|
@@ -16762,17 +17154,17 @@ module Aws::BedrockAgentCoreControl
|
|
|
16762
17154
|
end
|
|
16763
17155
|
|
|
16764
17156
|
# Represents a complete policy resource within the AgentCore Policy
|
|
16765
|
-
# system. Policies are ARN-able resources that contain Cedar
|
|
16766
|
-
# statements and associated metadata for controlling agent
|
|
16767
|
-
# access decisions. Each policy belongs to a policy engine
|
|
16768
|
-
# fine-grained authorization rules that are evaluated in
|
|
16769
|
-
# agents interact with tools through Gateway. Policies use
|
|
16770
|
-
#
|
|
17157
|
+
# system. Policies are ARN-able resources that contain Cedar or Dogwood
|
|
17158
|
+
# policy statements and associated metadata for controlling agent
|
|
17159
|
+
# behavior and access decisions. Each policy belongs to a policy engine
|
|
17160
|
+
# and defines fine-grained authorization rules that are evaluated in
|
|
17161
|
+
# real-time as agents interact with tools through Gateway. Policies use
|
|
17162
|
+
# Cedar or Dogwood to specify who (principals based on OAuth claims like
|
|
16771
17163
|
# username, role, or scope) can perform what actions (tool calls) on
|
|
16772
17164
|
# which resources (Gateways), with optional conditions for
|
|
16773
17165
|
# attribute-based access control. Multiple policies can apply to a
|
|
16774
|
-
# single request, with
|
|
16775
|
-
#
|
|
17166
|
+
# single request, with forbid-wins semantics ensuring that security
|
|
17167
|
+
# restrictions are never accidentally overridden.
|
|
16776
17168
|
#
|
|
16777
17169
|
# @!attribute [rw] policy_id
|
|
16778
17170
|
# The unique identifier for the policy. This system-generated
|
|
@@ -16818,9 +17210,9 @@ module Aws::BedrockAgentCoreControl
|
|
|
16818
17210
|
# @return [String]
|
|
16819
17211
|
#
|
|
16820
17212
|
# @!attribute [rw] definition
|
|
16821
|
-
# The Cedar policy statement that defines the access
|
|
16822
|
-
# This contains the actual policy logic used for agent
|
|
16823
|
-
# control and access decisions.
|
|
17213
|
+
# The Cedar or Dogwood policy statement that defines the access
|
|
17214
|
+
# control rules. This contains the actual policy logic used for agent
|
|
17215
|
+
# behavior control and access decisions.
|
|
16824
17216
|
# @return [Types::PolicyDefinition]
|
|
16825
17217
|
#
|
|
16826
17218
|
# @!attribute [rw] description
|
|
@@ -16879,15 +17271,16 @@ module Aws::BedrockAgentCoreControl
|
|
|
16879
17271
|
# The generated policy asset information within the policy definition
|
|
16880
17272
|
# structure. This contains information identifying a generated policy
|
|
16881
17273
|
# asset from the AI-powered policy generation process within the
|
|
16882
|
-
# AgentCore Policy system. Each asset contains a
|
|
17274
|
+
# AgentCore Policy system. Each asset contains a Dogwood policy
|
|
16883
17275
|
# statement generated from natural language input, along with
|
|
16884
17276
|
# associated metadata and analysis findings to help users evaluate and
|
|
16885
17277
|
# select the most appropriate policy option.
|
|
16886
17278
|
# @return [Types::PolicyGenerationDetails]
|
|
16887
17279
|
#
|
|
16888
17280
|
# @!attribute [rw] policy
|
|
16889
|
-
#
|
|
16890
|
-
#
|
|
17281
|
+
# The Dogwood policy statement that defines the access control rules.
|
|
17282
|
+
# This policy definition can include Dogwood policies and supports
|
|
17283
|
+
# temporal conditions and information providers such as guardrails.
|
|
16891
17284
|
# @return [Types::PolicyStatement]
|
|
16892
17285
|
#
|
|
16893
17286
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/PolicyDefinition AWS API Documentation
|
|
@@ -17040,7 +17433,7 @@ module Aws::BedrockAgentCoreControl
|
|
|
17040
17433
|
|
|
17041
17434
|
# Represents a policy generation request within the AgentCore Policy
|
|
17042
17435
|
# system. Tracks the AI-powered conversion of natural language
|
|
17043
|
-
# descriptions into
|
|
17436
|
+
# descriptions into Dogwood policy statements, enabling users to author
|
|
17044
17437
|
# policies by describing authorization requirements in plain English.
|
|
17045
17438
|
# The generation process analyzes the natural language input along with
|
|
17046
17439
|
# the Gateway's tool context and Cedar schema to produce one or more
|
|
@@ -17111,7 +17504,7 @@ module Aws::BedrockAgentCoreControl
|
|
|
17111
17504
|
|
|
17112
17505
|
# Represents a generated policy asset from the AI-powered policy
|
|
17113
17506
|
# generation process within the AgentCore Policy system. Each asset
|
|
17114
|
-
# contains a
|
|
17507
|
+
# contains a Dogwood policy statement generated from natural language
|
|
17115
17508
|
# input, along with associated metadata and analysis findings to help
|
|
17116
17509
|
# users evaluate and select the most appropriate policy option.
|
|
17117
17510
|
#
|
|
@@ -17133,13 +17526,13 @@ module Aws::BedrockAgentCoreControl
|
|
|
17133
17526
|
# The portion of the original natural language input that this
|
|
17134
17527
|
# generated policy asset addresses. This helps users understand which
|
|
17135
17528
|
# part of their policy description was translated into this specific
|
|
17136
|
-
#
|
|
17529
|
+
# Dogwood policy statement, enabling better policy selection and
|
|
17137
17530
|
# refinement. When a single natural language input describes multiple
|
|
17138
17531
|
# authorization requirements, the generation process creates separate
|
|
17139
17532
|
# policy assets for each requirement, with each asset's
|
|
17140
17533
|
# rawTextFragment showing which requirement it addresses. Use this
|
|
17141
17534
|
# mapping to verify that all parts of your natural language input were
|
|
17142
|
-
# correctly translated into
|
|
17535
|
+
# correctly translated into Dogwood policies.
|
|
17143
17536
|
# @return [String]
|
|
17144
17537
|
#
|
|
17145
17538
|
# @!attribute [rw] findings
|
|
@@ -17162,7 +17555,7 @@ module Aws::BedrockAgentCoreControl
|
|
|
17162
17555
|
|
|
17163
17556
|
# Represents the information identifying a generated policy asset from
|
|
17164
17557
|
# the AI-powered policy generation process within the AgentCore Policy
|
|
17165
|
-
# system. Each asset contains a
|
|
17558
|
+
# system. Each asset contains a Dogwood policy statement generated from
|
|
17166
17559
|
# natural language input, along with associated metadata and analysis
|
|
17167
17560
|
# findings to help users evaluate and select the most appropriate policy
|
|
17168
17561
|
# option.
|
|
@@ -17244,12 +17637,13 @@ module Aws::BedrockAgentCoreControl
|
|
|
17244
17637
|
include Aws::Structure
|
|
17245
17638
|
end
|
|
17246
17639
|
|
|
17247
|
-
# An AgentCore policy statement, which supports plain
|
|
17248
|
-
#
|
|
17640
|
+
# An AgentCore Cedar or Dogwood policy statement, which supports plain
|
|
17641
|
+
# Cedar policies, temporal policies, and guardrails definitions.
|
|
17249
17642
|
#
|
|
17250
17643
|
# @!attribute [rw] statement
|
|
17251
|
-
# The body of the AgentCore policy statement.
|
|
17252
|
-
# logic, which can be a Cedar policy
|
|
17644
|
+
# The body of the AgentCore Cedar or Dogwood policy statement.
|
|
17645
|
+
# Contains the policy logic, which can be a Cedar policy, a temporal
|
|
17646
|
+
# policy, or a guardrails definition.
|
|
17253
17647
|
# @return [String]
|
|
17254
17648
|
#
|
|
17255
17649
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/PolicyStatement AWS API Documentation
|
|
@@ -18870,7 +19264,7 @@ module Aws::BedrockAgentCoreControl
|
|
|
18870
19264
|
#
|
|
18871
19265
|
# @!attribute [rw] content
|
|
18872
19266
|
# The natural language description of the desired policy behavior.
|
|
18873
|
-
# This content is processed by AI to generate corresponding
|
|
19267
|
+
# This content is processed by AI to generate corresponding Dogwood
|
|
18874
19268
|
# policy statements that match the described intent.
|
|
18875
19269
|
# @return [Types::Content]
|
|
18876
19270
|
#
|
|
@@ -20496,6 +20890,106 @@ module Aws::BedrockAgentCoreControl
|
|
|
20496
20890
|
include Aws::Structure
|
|
20497
20891
|
end
|
|
20498
20892
|
|
|
20893
|
+
# @!attribute [rw] consent_portal_identifier
|
|
20894
|
+
# The identifier of the consent portal. You can specify either the
|
|
20895
|
+
# consent portal ID or its Amazon Resource Name (ARN).
|
|
20896
|
+
# @return [String]
|
|
20897
|
+
#
|
|
20898
|
+
# @!attribute [rw] execution_role_arn
|
|
20899
|
+
# The Amazon Resource Name (ARN) of the IAM role that the consent
|
|
20900
|
+
# portal assumes to access the resources defined in its sources.
|
|
20901
|
+
# @return [String]
|
|
20902
|
+
#
|
|
20903
|
+
# @!attribute [rw] idp_config
|
|
20904
|
+
# The identity provider configuration that the consent portal uses to
|
|
20905
|
+
# authenticate end users.
|
|
20906
|
+
# @return [Types::ConsentPortalIdpConfig]
|
|
20907
|
+
#
|
|
20908
|
+
# @!attribute [rw] description
|
|
20909
|
+
# The description of the consent portal.
|
|
20910
|
+
# @return [String]
|
|
20911
|
+
#
|
|
20912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/UpdateConsentPortalRequest AWS API Documentation
|
|
20913
|
+
#
|
|
20914
|
+
class UpdateConsentPortalRequest < Struct.new(
|
|
20915
|
+
:consent_portal_identifier,
|
|
20916
|
+
:execution_role_arn,
|
|
20917
|
+
:idp_config,
|
|
20918
|
+
:description)
|
|
20919
|
+
SENSITIVE = []
|
|
20920
|
+
include Aws::Structure
|
|
20921
|
+
end
|
|
20922
|
+
|
|
20923
|
+
# @!attribute [rw] sources
|
|
20924
|
+
# The resources served by the consent portal.
|
|
20925
|
+
# @return [Array<Types::ConsentPortalSource>]
|
|
20926
|
+
#
|
|
20927
|
+
# @!attribute [rw] consent_portal_arn
|
|
20928
|
+
# The Amazon Resource Name (ARN) of the consent portal.
|
|
20929
|
+
# @return [String]
|
|
20930
|
+
#
|
|
20931
|
+
# @!attribute [rw] consent_portal_id
|
|
20932
|
+
# The unique identifier of the consent portal.
|
|
20933
|
+
# @return [String]
|
|
20934
|
+
#
|
|
20935
|
+
# @!attribute [rw] created_at
|
|
20936
|
+
# The timestamp for when the consent portal was created.
|
|
20937
|
+
# @return [Time]
|
|
20938
|
+
#
|
|
20939
|
+
# @!attribute [rw] description
|
|
20940
|
+
# The description of the consent portal.
|
|
20941
|
+
# @return [String]
|
|
20942
|
+
#
|
|
20943
|
+
# @!attribute [rw] execution_role_arn
|
|
20944
|
+
# The Amazon Resource Name (ARN) of the IAM role that the consent
|
|
20945
|
+
# portal assumes to access the resources defined in its sources.
|
|
20946
|
+
# @return [String]
|
|
20947
|
+
#
|
|
20948
|
+
# @!attribute [rw] idp_config
|
|
20949
|
+
# The identity provider configuration that the consent portal uses to
|
|
20950
|
+
# authenticate end users.
|
|
20951
|
+
# @return [Types::ConsentPortalIdpConfig]
|
|
20952
|
+
#
|
|
20953
|
+
# @!attribute [rw] name
|
|
20954
|
+
# The name of the consent portal.
|
|
20955
|
+
# @return [String]
|
|
20956
|
+
#
|
|
20957
|
+
# @!attribute [rw] portal_url
|
|
20958
|
+
# The URL used to access the consent portal.
|
|
20959
|
+
# @return [String]
|
|
20960
|
+
#
|
|
20961
|
+
# @!attribute [rw] status
|
|
20962
|
+
# The current status of the consent portal.
|
|
20963
|
+
# @return [String]
|
|
20964
|
+
#
|
|
20965
|
+
# @!attribute [rw] status_reason
|
|
20966
|
+
# A message that provides additional information about the current
|
|
20967
|
+
# status of the consent portal.
|
|
20968
|
+
# @return [String]
|
|
20969
|
+
#
|
|
20970
|
+
# @!attribute [rw] updated_at
|
|
20971
|
+
# The timestamp for when the consent portal was last updated.
|
|
20972
|
+
# @return [Time]
|
|
20973
|
+
#
|
|
20974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/UpdateConsentPortalResponse AWS API Documentation
|
|
20975
|
+
#
|
|
20976
|
+
class UpdateConsentPortalResponse < Struct.new(
|
|
20977
|
+
:sources,
|
|
20978
|
+
:consent_portal_arn,
|
|
20979
|
+
:consent_portal_id,
|
|
20980
|
+
:created_at,
|
|
20981
|
+
:description,
|
|
20982
|
+
:execution_role_arn,
|
|
20983
|
+
:idp_config,
|
|
20984
|
+
:name,
|
|
20985
|
+
:portal_url,
|
|
20986
|
+
:status,
|
|
20987
|
+
:status_reason,
|
|
20988
|
+
:updated_at)
|
|
20989
|
+
SENSITIVE = []
|
|
20990
|
+
include Aws::Structure
|
|
20991
|
+
end
|
|
20992
|
+
|
|
20499
20993
|
# @!attribute [rw] dataset_id
|
|
20500
20994
|
# The unique identifier of the dataset.
|
|
20501
20995
|
# @return [String]
|
|
@@ -21646,6 +22140,11 @@ module Aws::BedrockAgentCoreControl
|
|
|
21646
22140
|
# The updated clustering configuration for periodic batch evaluation.
|
|
21647
22141
|
# @return [Types::ClusteringConfig]
|
|
21648
22142
|
#
|
|
22143
|
+
# @!attribute [rw] output_config
|
|
22144
|
+
# The configuration that specifies where evaluation results should be
|
|
22145
|
+
# written for monitoring and analysis.
|
|
22146
|
+
# @return [Types::OutputConfig]
|
|
22147
|
+
#
|
|
21649
22148
|
# @!attribute [rw] evaluation_execution_role_arn
|
|
21650
22149
|
# The updated Amazon Resource Name (ARN) of the IAM role used for
|
|
21651
22150
|
# evaluation execution.
|
|
@@ -21667,6 +22166,7 @@ module Aws::BedrockAgentCoreControl
|
|
|
21667
22166
|
:evaluators,
|
|
21668
22167
|
:insights,
|
|
21669
22168
|
:clustering_config,
|
|
22169
|
+
:output_config,
|
|
21670
22170
|
:evaluation_execution_role_arn,
|
|
21671
22171
|
:execution_status)
|
|
21672
22172
|
SENSITIVE = [:description]
|
|
@@ -22079,9 +22579,9 @@ module Aws::BedrockAgentCoreControl
|
|
|
22079
22579
|
# @return [Types::UpdatedDescription]
|
|
22080
22580
|
#
|
|
22081
22581
|
# @!attribute [rw] definition
|
|
22082
|
-
# The new Cedar policy statement that defines the access
|
|
22083
|
-
# rules. This replaces the existing policy definition with new
|
|
22084
|
-
# while maintaining the policy's identity.
|
|
22582
|
+
# The new Cedar or Dogwood policy statement that defines the access
|
|
22583
|
+
# control rules. This replaces the existing policy definition with new
|
|
22584
|
+
# logic while maintaining the policy's identity.
|
|
22085
22585
|
# @return [Types::PolicyDefinition]
|
|
22086
22586
|
#
|
|
22087
22587
|
# @!attribute [rw] validation_mode
|
|
@@ -22149,7 +22649,7 @@ module Aws::BedrockAgentCoreControl
|
|
|
22149
22649
|
# @return [String]
|
|
22150
22650
|
#
|
|
22151
22651
|
# @!attribute [rw] definition
|
|
22152
|
-
# The updated Cedar policy statement.
|
|
22652
|
+
# The updated Cedar or Dogwood policy statement.
|
|
22153
22653
|
# @return [Types::PolicyDefinition]
|
|
22154
22654
|
#
|
|
22155
22655
|
# @!attribute [rw] description
|