pub struct Client { /* private fields */ }Expand description
Client for Amazon Bedrock AgentCore Control
Client for invoking operations on Amazon Bedrock AgentCore Control. Each operation on Amazon Bedrock AgentCore Control is a method on this
this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env() instead, which returns a ConfigLoader that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_bedrockagentcorecontrol::Client::new(&config);Occasionally, SDKs may have additional service-specific values that can be set on the Config that
is absent from SdkConfig, or slightly different settings for a specific client may be desired.
The Builder struct implements From<&SdkConfig>, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_bedrockagentcorecontrol::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();See the aws-config docs and Config for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AddDatasetExamples operation has
a Client::add_dataset_examples, function which returns a builder for that operation.
The fluent builder ultimately has a send() function that returns an async future that
returns a result, as illustrated below:
let result = client.add_dataset_examples()
.dataset_id("example")
.send()
.await;The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize module for more
information.
§Waiters
This client provides wait_until methods behind the Waiters trait.
To use them, simply import the trait, and then call one of the wait_until methods. This will
return a waiter fluent builder that takes various parameters, which are documented on the builder
type. Once parameters have been provided, the wait method can be called to initiate waiting.
For example, if there was a wait_until_thing method, it could look like:
let result = client.wait_until_thing()
.thing_id("someId")
.wait(Duration::from_secs(120))
.await;Implementations§
Source§impl Client
impl Client
Sourcepub fn add_dataset_examples(&self) -> AddDatasetExamplesFluentBuilder
pub fn add_dataset_examples(&self) -> AddDatasetExamplesFluentBuilder
Constructs a fluent builder for the AddDatasetExamples operation.
- The fluent builder is configurable:
dataset_id(impl Into<String>)/set_dataset_id(Option<String>):
required: trueThe unique identifier of the dataset to add examples to.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
source(DataSourceType)/set_source(Option<DataSourceType>):
required: true
Source of examples to add. Provide either inline examples or an S3 URI pointing to a JSONL file.
- On success, responds with
AddDatasetExamplesOutputwith field(s):dataset_arn(String):The Amazon Resource Name (ARN) of the dataset.
dataset_id(String):The unique identifier of the dataset.
status(DatasetStatus):The current status of the dataset.
added_count(i64):The number of examples added.
updated_at(DateTime):The timestamp when the examples were added.
example_ids(Vec::<String>): IDs of all added examples (auto-generated UUIDs).
- On failure, responds with
SdkError<AddDatasetExamplesError>
Source§impl Client
impl Client
Sourcepub fn create_agent_runtime(&self) -> CreateAgentRuntimeFluentBuilder
pub fn create_agent_runtime(&self) -> CreateAgentRuntimeFluentBuilder
Constructs a fluent builder for the CreateAgentRuntime operation.
- The fluent builder is configurable:
agent_runtime_name(impl Into<String>)/set_agent_runtime_name(Option<String>):
required: trueThe name of the AgentCore Runtime.
agent_runtime_artifact(AgentRuntimeArtifact)/set_agent_runtime_artifact(Option<AgentRuntimeArtifact>):
required: trueThe artifact of the AgentCore Runtime.
role_arn(impl Into<String>)/set_role_arn(Option<String>):
required: trueThe IAM role ARN that provides permissions for the AgentCore Runtime.
network_configuration(NetworkConfiguration)/set_network_configuration(Option<NetworkConfiguration>):
required: trueThe network configuration for the AgentCore Runtime.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency of the request.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the AgentCore Runtime.
authorizer_configuration(AuthorizerConfiguration)/set_authorizer_configuration(Option<AuthorizerConfiguration>):
required: falseThe authorizer configuration for the AgentCore Runtime.
request_header_configuration(RequestHeaderConfiguration)/set_request_header_configuration(Option<RequestHeaderConfiguration>):
required: falseConfiguration for HTTP request headers that will be passed through to the runtime.
protocol_configuration(ProtocolConfiguration)/set_protocol_configuration(Option<ProtocolConfiguration>):
required: falseThe protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.
lifecycle_configuration(LifecycleConfiguration)/set_lifecycle_configuration(Option<LifecycleConfiguration>):
required: falseThe life cycle configuration for the AgentCore Runtime.
environment_variables(impl Into<String>, impl Into<String>)/set_environment_variables(Option<HashMap::<String, String>>):
required: falseEnvironment variables to set in the AgentCore Runtime environment.
filesystem_configurations(FilesystemConfiguration)/set_filesystem_configurations(Option<Vec::<FilesystemConfiguration>>):
required: falseThe filesystem configurations to mount into the AgentCore Runtime. Use filesystem configurations to provide persistent storage to your AgentCore Runtime sessions.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to the agent runtime. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreateAgentRuntimeOutputwith field(s):agent_runtime_arn(String):The Amazon Resource Name (ARN) of the AgentCore Runtime.
workload_identity_details(Option<WorkloadIdentityDetails>):The workload identity details for the AgentCore Runtime.
agent_runtime_id(String):The unique identifier of the AgentCore Runtime.
agent_runtime_version(String):The version of the AgentCore Runtime.
created_at(DateTime):The timestamp when the AgentCore Runtime was created.
status(AgentRuntimeStatus):The current status of the AgentCore Runtime.
- On failure, responds with
SdkError<CreateAgentRuntimeError>
Source§impl Client
impl Client
Sourcepub fn create_agent_runtime_endpoint(
&self,
) -> CreateAgentRuntimeEndpointFluentBuilder
pub fn create_agent_runtime_endpoint( &self, ) -> CreateAgentRuntimeEndpointFluentBuilder
Constructs a fluent builder for the CreateAgentRuntimeEndpoint operation.
- The fluent builder is configurable:
agent_runtime_id(impl Into<String>)/set_agent_runtime_id(Option<String>):
required: trueThe unique identifier of the AgentCore Runtime to create an endpoint for.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the AgentCore Runtime endpoint.
agent_runtime_version(impl Into<String>)/set_agent_runtime_version(Option<String>):
required: falseThe version of the AgentCore Runtime to use for the endpoint.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the AgentCore Runtime endpoint.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency of the request.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to the agent runtime endpoint. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreateAgentRuntimeEndpointOutputwith field(s):target_version(String):The target version of the AgentCore Runtime for the endpoint.
agent_runtime_endpoint_arn(String):The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.
agent_runtime_arn(String):The Amazon Resource Name (ARN) of the AgentCore Runtime.
agent_runtime_id(Option<String>):The unique identifier of the AgentCore Runtime.
endpoint_name(Option<String>):The name of the AgentCore Runtime endpoint.
status(AgentRuntimeEndpointStatus):The current status of the AgentCore Runtime endpoint.
created_at(DateTime):The timestamp when the AgentCore Runtime endpoint was created.
- On failure, responds with
SdkError<CreateAgentRuntimeEndpointError>
Source§impl Client
impl Client
Sourcepub fn create_api_key_credential_provider(
&self,
) -> CreateApiKeyCredentialProviderFluentBuilder
pub fn create_api_key_credential_provider( &self, ) -> CreateApiKeyCredentialProviderFluentBuilder
Constructs a fluent builder for the CreateApiKeyCredentialProvider operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the API key credential provider. The name must be unique within your account.
api_key(impl Into<String>)/set_api_key(Option<String>):
required: falseThe API key to use for authentication. This value is encrypted and stored securely.
api_key_secret_config(SecretReference)/set_api_key_secret_config(Option<SecretReference>):
required: falseA reference to the AWS Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when
apiKeySecretSourceis set toEXTERNAL.api_key_secret_source(SecretSourceType)/set_api_key_secret_source(Option<SecretSourceType>):
required: falseThe source type of the API key secret. Use
MANAGEDif the secret is managed by the service, orEXTERNALif you manage the secret yourself in AWS Secrets Manager.tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreateApiKeyCredentialProviderOutputwith field(s):api_key_secret_arn(Option<Secret>):The Amazon Resource Name (ARN) of the secret containing the API key.
api_key_secret_json_key(Option<String>):The JSON key used to extract the API key value from the AWS Secrets Manager secret.
api_key_secret_source(Option<SecretSourceType>):The source type of the API key secret. Either
MANAGEDif the secret is managed by the service, orEXTERNALif managed by the user in AWS Secrets Manager.name(String):The name of the created API key credential provider.
credential_provider_arn(String):The Amazon Resource Name (ARN) of the created API key credential provider.
- On failure, responds with
SdkError<CreateApiKeyCredentialProviderError>
Source§impl Client
impl Client
Sourcepub fn create_browser(&self) -> CreateBrowserFluentBuilder
pub fn create_browser(&self) -> CreateBrowserFluentBuilder
Constructs a fluent builder for the CreateBrowser operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the browser. The name must be unique within your account.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the browser.
execution_role_arn(impl Into<String>)/set_execution_role_arn(Option<String>):
required: falseThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the browser to access Amazon Web Services services.
network_configuration(BrowserNetworkConfiguration)/set_network_configuration(Option<BrowserNetworkConfiguration>):
required: trueThe network configuration for the browser. This configuration specifies the network mode for the browser.
recording(RecordingConfig)/set_recording(Option<RecordingConfig>):
required: falseThe recording configuration for the browser. When enabled, browser sessions are recorded and stored in the specified Amazon S3 location.
browser_signing(BrowserSigningConfigInput)/set_browser_signing(Option<BrowserSigningConfigInput>):
required: falseThe browser signing configuration that enables cryptographic agent identification using HTTP message signatures for web bot authentication.
enterprise_policies(BrowserEnterprisePolicy)/set_enterprise_policies(Option<Vec::<BrowserEnterprisePolicy>>):
required: falseA list of enterprise policy files for the browser.
certificates(Certificate)/set_certificates(Option<Vec::<Certificate>>):
required: falseA list of certificates to install in the browser.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to the browser. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreateBrowserOutputwith field(s):browser_id(String):The unique identifier of the created browser.
browser_arn(String):The Amazon Resource Name (ARN) of the created browser.
created_at(DateTime):The timestamp when the browser was created.
status(BrowserStatus):The current status of the browser.
- On failure, responds with
SdkError<CreateBrowserError>
Source§impl Client
impl Client
Sourcepub fn create_browser_profile(&self) -> CreateBrowserProfileFluentBuilder
pub fn create_browser_profile(&self) -> CreateBrowserProfileFluentBuilder
Constructs a fluent builder for the CreateBrowserProfile operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the browser profile. The name must be unique within your account and can contain alphanumeric characters and underscores.
description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the browser profile. Use this field to describe the purpose or contents of the profile.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to the browser profile. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreateBrowserProfileOutputwith field(s):profile_id(String):The unique identifier of the created browser profile.
profile_arn(String):The Amazon Resource Name (ARN) of the created browser profile.
created_at(DateTime):The timestamp when the browser profile was created.
status(BrowserProfileStatus):The current status of the browser profile.
- On failure, responds with
SdkError<CreateBrowserProfileError>
Source§impl Client
impl Client
Sourcepub fn create_code_interpreter(&self) -> CreateCodeInterpreterFluentBuilder
pub fn create_code_interpreter(&self) -> CreateCodeInterpreterFluentBuilder
Constructs a fluent builder for the CreateCodeInterpreter operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the code interpreter. The name must be unique within your account.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the code interpreter.
execution_role_arn(impl Into<String>)/set_execution_role_arn(Option<String>):
required: falseThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the code interpreter to access Amazon Web Services services.
network_configuration(CodeInterpreterNetworkConfiguration)/set_network_configuration(Option<CodeInterpreterNetworkConfiguration>):
required: trueThe network configuration for the code interpreter. This configuration specifies the network mode for the code interpreter.
certificates(Certificate)/set_certificates(Option<Vec::<Certificate>>):
required: falseA list of certificates to install in the code interpreter.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to the code interpreter. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreateCodeInterpreterOutputwith field(s):code_interpreter_id(String):The unique identifier of the created code interpreter.
code_interpreter_arn(String):The Amazon Resource Name (ARN) of the created code interpreter.
created_at(DateTime):The timestamp when the code interpreter was created.
status(CodeInterpreterStatus):The current status of the code interpreter.
- On failure, responds with
SdkError<CreateCodeInterpreterError>
Source§impl Client
impl Client
Sourcepub fn create_configuration_bundle(
&self,
) -> CreateConfigurationBundleFluentBuilder
pub fn create_configuration_bundle( &self, ) -> CreateConfigurationBundleFluentBuilder
Constructs a fluent builder for the CreateConfigurationBundle operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
bundle_name(impl Into<String>)/set_bundle_name(Option<String>):
required: trueThe name for the configuration bundle. Names must be unique within your account.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description for the configuration bundle.
components(impl Into<String>, ComponentConfiguration)/set_components(Option<HashMap::<String, ComponentConfiguration>>):
required: trueA map of component identifiers to their configurations. Each component represents a configurable element within the bundle.
branch_name(impl Into<String>)/set_branch_name(Option<String>):
required: falseThe branch name for version tracking. Defaults to
mainlineif not specified.commit_message(impl Into<String>)/set_commit_message(Option<String>):
required: falseA commit message describing the initial version of the configuration bundle.
created_by(VersionCreatedBySource)/set_created_by(Option<VersionCreatedBySource>):
required: falseThe source that created this version, including the source name and optional ARN.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to the configuration bundle. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreateConfigurationBundleOutputwith field(s):bundle_arn(String):The Amazon Resource Name (ARN) of the created configuration bundle.
bundle_id(String):The unique identifier of the created configuration bundle.
version_id(String):The initial version identifier of the configuration bundle.
created_at(DateTime):The timestamp when the configuration bundle was created.
- On failure, responds with
SdkError<CreateConfigurationBundleError>
Source§impl Client
impl Client
Sourcepub fn create_dataset(&self) -> CreateDatasetFluentBuilder
pub fn create_dataset(&self) -> CreateDatasetFluentBuilder
Constructs a fluent builder for the CreateDataset operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: false
Optional idempotency token.dataset_name(impl Into<String>)/set_dataset_name(Option<String>):
required: true
Human-readable name for the dataset. Unique within the account (case-insensitive). Immutable after creation.description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the dataset.
source(DataSourceType)/set_source(Option<DataSourceType>):
required: true
Source of initial examples. Provide either inline examples or an S3 URI pointing to a JSONL file.schema_type(DatasetSchemaType)/set_schema_type(Option<DatasetSchemaType>):
required: true
Versioned schema type governing the structure of examples. Immutable after creation.kms_key_arn(impl Into<String>)/set_kms_key_arn(Option<String>):
required: false
Optional AWS KMS key ARN for SSE-KMS on service S3 writes.tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to the dataset.
- On success, responds with
CreateDatasetOutputwith field(s):dataset_arn(String):The Amazon Resource Name (ARN) of the created dataset.
dataset_id(String):The unique identifier of the created dataset.
status(DatasetStatus): Always CREATING immediately after this call. Poll GetDataset until status == ACTIVE (draftStatus=MODIFIED) or CREATE_FAILED.created_at(DateTime):The timestamp when the dataset was created.
- On failure, responds with
SdkError<CreateDatasetError>
Source§impl Client
impl Client
Sourcepub fn create_dataset_version(&self) -> CreateDatasetVersionFluentBuilder
pub fn create_dataset_version(&self) -> CreateDatasetVersionFluentBuilder
Constructs a fluent builder for the CreateDatasetVersion operation.
- The fluent builder is configurable:
dataset_id(impl Into<String>)/set_dataset_id(Option<String>):
required: trueThe unique identifier of the dataset to publish a version for.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
- On success, responds with
CreateDatasetVersionOutputwith field(s):dataset_arn(String):The Amazon Resource Name (ARN) of the dataset.
dataset_id(String):The unique identifier of the dataset.
status(DatasetStatus): Always UPDATING immediately after this call. Poll GetDataset until status == ACTIVE (draftStatus=UNMODIFIED) or UPDATE_FAILED.dataset_version(String): The version being created.created_at(DateTime):The timestamp when the version creation was initiated.
- On failure, responds with
SdkError<CreateDatasetVersionError>
Source§impl Client
impl Client
Sourcepub fn create_evaluator(&self) -> CreateEvaluatorFluentBuilder
pub fn create_evaluator(&self) -> CreateEvaluatorFluentBuilder
Constructs a fluent builder for the CreateEvaluator operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
evaluator_name(impl Into<String>)/set_evaluator_name(Option<String>):
required: trueThe name of the evaluator. Must be unique within your account.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the evaluator that explains its purpose and evaluation criteria.
evaluator_config(EvaluatorConfig)/set_evaluator_config(Option<EvaluatorConfig>):
required: trueThe configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.
level(EvaluatorLevel)/set_level(Option<EvaluatorLevel>):
required: trueThe evaluation level that determines the scope of evaluation. Valid values are
TOOL_CALLfor individual tool invocations,TRACEfor single request-response interactions, orSESSIONfor entire conversation sessions.kms_key_arn(impl Into<String>)/set_kms_key_arn(Option<String>):
required: falseThe Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data, including instructions and rating scale. If you don’t specify a KMS key, the evaluator data is encrypted with an Amazon Web Services owned key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to an AgentCore Evaluator. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreateEvaluatorOutputwith field(s):evaluator_arn(String):The Amazon Resource Name (ARN) of the created evaluator.
evaluator_id(String):The unique identifier of the created evaluator.
created_at(DateTime):The timestamp when the evaluator was created.
status(EvaluatorStatus):The status of the evaluator creation operation.
- On failure, responds with
SdkError<CreateEvaluatorError>
Source§impl Client
impl Client
Sourcepub fn create_gateway(&self) -> CreateGatewayFluentBuilder
pub fn create_gateway(&self) -> CreateGatewayFluentBuilder
Constructs a fluent builder for the CreateGateway operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the gateway. The name must be unique within your account.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the gateway.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
role_arn(impl Into<String>)/set_role_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.
protocol_type(GatewayProtocolType)/set_protocol_type(Option<GatewayProtocolType>):
required: falseThe protocol type for the gateway.
protocol_configuration(GatewayProtocolConfiguration)/set_protocol_configuration(Option<GatewayProtocolConfiguration>):
required: falseThe configuration settings for the protocol specified in the
protocolTypeparameter.authorizer_type(AuthorizerType)/set_authorizer_type(Option<AuthorizerType>):
required: trueThe type of authorizer to use for the gateway.
-
CUSTOM_JWT- Authorize with a bearer token. -
AWS_IAM- Authorize with your Amazon Web Services IAM credentials. -
NONE- No authorization
-
authorizer_configuration(AuthorizerConfiguration)/set_authorizer_configuration(Option<AuthorizerConfiguration>):
required: falseThe authorizer configuration for the gateway. Required if
authorizerTypeisCUSTOM_JWT.kms_key_arn(impl Into<String>)/set_kms_key_arn(Option<String>):
required: falseThe Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.
interceptor_configurations(GatewayInterceptorConfiguration)/set_interceptor_configurations(Option<Vec::<GatewayInterceptorConfiguration>>):
required: falseA list of configuration settings for a gateway interceptor. Gateway interceptors allow custom code to be invoked during gateway invocations.
policy_engine_configuration(GatewayPolicyEngineConfiguration)/set_policy_engine_configuration(Option<GatewayPolicyEngineConfiguration>):
required: falseThe policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.
exception_level(ExceptionLevel)/set_exception_level(Option<ExceptionLevel>):
required: falseThe level of detail in error messages returned when invoking the gateway.
-
If the value is
DEBUG, granular exception messages are returned to help a user debug the gateway. -
If the value is omitted, a generic error message is returned to the end user.
-
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of key-value pairs to associate with the gateway as metadata tags.
- On success, responds with
CreateGatewayOutputwith field(s):gateway_arn(String):The Amazon Resource Name (ARN) of the created gateway.
gateway_id(String):The unique identifier of the created gateway.
gateway_url(Option<String>):The URL endpoint for the created gateway.
created_at(DateTime):The timestamp when the gateway was created.
updated_at(DateTime):The timestamp when the gateway was last updated.
status(GatewayStatus):The current status of the gateway.
status_reasons(Option<Vec::<String>>):The reasons for the current status of the gateway.
name(String):The name of the gateway.
description(Option<String>):The description of the gateway.
role_arn(Option<String>):The Amazon Resource Name (ARN) of the IAM role associated with the gateway.
protocol_type(GatewayProtocolType):The protocol type of the gateway.
protocol_configuration(Option<GatewayProtocolConfiguration>):The configuration settings for the protocol used by the gateway.
authorizer_type(AuthorizerType):The type of authorizer used by the gateway.
authorizer_configuration(Option<AuthorizerConfiguration>):The authorizer configuration for the created gateway.
kms_key_arn(Option<String>):The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.
interceptor_configurations(Option<Vec::<GatewayInterceptorConfiguration>>):The list of interceptor configurations for the created gateway.
policy_engine_configuration(Option<GatewayPolicyEngineConfiguration>):The policy engine configuration for the created gateway.
workload_identity_details(Option<WorkloadIdentityDetails>):The workload identity details for the created gateway.
exception_level(Option<ExceptionLevel>):The level of detail in error messages returned when invoking the gateway.
-
If the value is
DEBUG, granular exception messages are returned to help a user debug the gateway. -
If the value is omitted, a generic error message is returned to the end user.
-
- On failure, responds with
SdkError<CreateGatewayError>
Source§impl Client
impl Client
Sourcepub fn create_gateway_rule(&self) -> CreateGatewayRuleFluentBuilder
pub fn create_gateway_rule(&self) -> CreateGatewayRuleFluentBuilder
Constructs a fluent builder for the CreateGatewayRule operation.
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe identifier of the gateway to create a rule for.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
priority(i32)/set_priority(Option<i32>):
required: trueThe priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first. Must be between 1 and 1,000,000.
conditions(Condition)/set_conditions(Option<Vec::<Condition>>):
required: falseThe conditions that must be met for the rule to apply. Conditions can match on principals (IAM ARNs) or request paths.
actions(Action)/set_actions(Option<Vec::<Action>>):
required: trueThe actions to take when the rule conditions are met. Actions can route to a specific target or apply a configuration bundle override.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the gateway rule.
- On success, responds with
CreateGatewayRuleOutputwith field(s):rule_id(String):The unique identifier of the gateway rule.
gateway_arn(String):The Amazon Resource Name (ARN) of the gateway that the rule belongs to.
priority(i32):The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.
conditions(Option<Vec::<Condition>>):The conditions that must be met for the rule to apply.
actions(Vec::<Action>):The actions to take when the rule conditions are met.
description(Option<String>):The description of the gateway rule.
created_at(DateTime):The timestamp when the rule was created.
status(GatewayRuleStatus):The current status of the rule.
system(Option<SystemManagedBlock>):System-managed metadata for rules created by automated processes.
- On failure, responds with
SdkError<CreateGatewayRuleError>
Source§impl Client
impl Client
Sourcepub fn create_gateway_target(&self) -> CreateGatewayTargetFluentBuilder
pub fn create_gateway_target(&self) -> CreateGatewayTargetFluentBuilder
Constructs a fluent builder for the CreateGatewayTarget operation.
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe identifier of the gateway to create a target for.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the gateway target. The name must be unique within the gateway.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the gateway target.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
target_configuration(TargetConfiguration)/set_target_configuration(Option<TargetConfiguration>):
required: trueThe configuration settings for the target, including endpoint information and schema definitions.
credential_provider_configurations(CredentialProviderConfiguration)/set_credential_provider_configurations(Option<Vec::<CredentialProviderConfiguration>>):
required: falseThe credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.
metadata_configuration(MetadataConfiguration)/set_metadata_configuration(Option<MetadataConfiguration>):
required: falseOptional configuration for HTTP header and query parameter propagation to and from the gateway target.
private_endpoint(PrivateEndpoint)/set_private_endpoint(Option<PrivateEndpoint>):
required: falseThe private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.
- On success, responds with
CreateGatewayTargetOutputwith field(s):gateway_arn(String):The Amazon Resource Name (ARN) of the gateway.
target_id(String):The unique identifier of the created target.
created_at(DateTime):The timestamp when the target was created.
updated_at(DateTime):The timestamp when the target was last updated.
status(TargetStatus):The current status of the target.
status_reasons(Option<Vec::<String>>):The reasons for the current status of the target.
name(String):The name of the target.
description(Option<String>):The description of the target.
target_configuration(Option<TargetConfiguration>):The configuration settings for the target.
credential_provider_configurations(Vec::<CredentialProviderConfiguration>):The credential provider configurations for the target.
last_synchronized_at(Option<DateTime>):The last synchronization of the target.
metadata_configuration(Option<MetadataConfiguration>):The metadata configuration that was applied to the created gateway target.
private_endpoint(Option<PrivateEndpoint>):The private endpoint configuration for the gateway target.
private_endpoint_managed_resources(Option<Vec::<ManagedResourceDetails>>):The managed resources created by the gateway for private endpoint connectivity.
authorization_data(Option<AuthorizationData>):OAuth2 authorization data for the created gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.
protocol_type(Option<TargetProtocolType>):The protocol type of the created gateway target.
- On failure, responds with
SdkError<CreateGatewayTargetError>
Source§impl Client
impl Client
Sourcepub fn create_harness(&self) -> CreateHarnessFluentBuilder
pub fn create_harness(&self) -> CreateHarnessFluentBuilder
Constructs a fluent builder for the CreateHarness operation.
- The fluent builder is configurable:
harness_name(impl Into<String>)/set_harness_name(Option<String>):
required: trueThe name of the harness. Must start with a letter and contain only alphanumeric characters and underscores.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency of the request.
execution_role_arn(impl Into<String>)/set_execution_role_arn(Option<String>):
required: trueThe ARN of the IAM role that the harness assumes when running. This role must have permissions for the services the agent needs to access, such as Amazon Bedrock for model invocation.
environment(HarnessEnvironmentProviderRequest)/set_environment(Option<HarnessEnvironmentProviderRequest>):
required: falseThe compute environment configuration for the harness, including network and lifecycle settings.
environment_artifact(HarnessEnvironmentArtifact)/set_environment_artifact(Option<HarnessEnvironmentArtifact>):
required: falseThe environment artifact for the harness, such as a custom container image containing additional dependencies.
environment_variables(impl Into<String>, impl Into<String>)/set_environment_variables(Option<HashMap::<String, String>>):
required: falseEnvironment variables to set in the harness runtime environment.
authorizer_configuration(AuthorizerConfiguration)/set_authorizer_configuration(Option<AuthorizerConfiguration>):
required: falseRepresents inbound authorization configuration options used to authenticate incoming requests.
model(HarnessModelConfiguration)/set_model(Option<HarnessModelConfiguration>):
required: falseThe model configuration for the harness. Supports Amazon Bedrock, OpenAI, and Google Gemini model providers.
system_prompt(HarnessSystemContentBlock)/set_system_prompt(Option<Vec::<HarnessSystemContentBlock>>):
required: falseThe system prompt that defines the agent’s behavior and instructions.
tools(HarnessTool)/set_tools(Option<Vec::<HarnessTool>>):
required: falseThe tools available to the agent, such as remote MCP servers, AgentCore Gateway, AgentCore Browser, Code Interpreter, or inline functions.
skills(HarnessSkill)/set_skills(Option<Vec::<HarnessSkill>>):
required: falseThe skills available to the agent. Skills are bundles of files that the agent can pull into its context on demand.
allowed_tools(impl Into<String>)/set_allowed_tools(Option<Vec::<String>>):
required: falseThe tools that the agent is allowed to use. Supports glob patterns such as * for all tools, @builtin for all built-in tools, or @serverName/toolName for specific MCP server tools.
memory(HarnessMemoryConfiguration)/set_memory(Option<HarnessMemoryConfiguration>):
required: falseThe AgentCore Memory configuration for persisting conversation context across sessions.
truncation(HarnessTruncationConfiguration)/set_truncation(Option<HarnessTruncationConfiguration>):
required: falseThe truncation configuration for managing conversation context when it exceeds model limits.
max_iterations(i32)/set_max_iterations(Option<i32>):
required: falseThe maximum number of iterations the agent loop can execute per invocation.
max_tokens(i32)/set_max_tokens(Option<i32>):
required: falseThe maximum total number of output tokens the agent can generate across all model calls within a single invocation.
timeout_seconds(i32)/set_timeout_seconds(Option<i32>):
required: falseThe maximum duration in seconds for the agent loop execution per invocation.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseTags to apply to the harness resource.
- On success, responds with
CreateHarnessOutputwith field(s):harness(Option<Harness>):The harness that was created.
- On failure, responds with
SdkError<CreateHarnessError>
Source§impl Client
impl Client
Sourcepub fn create_memory(&self) -> CreateMemoryFluentBuilder
pub fn create_memory(&self) -> CreateMemoryFluentBuilder
Constructs a fluent builder for the CreateMemory operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but does not return an error.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the memory. The name must be unique within your account.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the memory.
encryption_key_arn(impl Into<String>)/set_encryption_key_arn(Option<String>):
required: falseThe Amazon Resource Name (ARN) of the KMS key used to encrypt the memory data.
memory_execution_role_arn(impl Into<String>)/set_memory_execution_role_arn(Option<String>):
required: falseThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the memory to access Amazon Web Services services.
event_expiry_duration(i32)/set_event_expiry_duration(Option<i32>):
required: trueThe duration after which memory events expire. Specified as an ISO 8601 duration.
memory_strategies(MemoryStrategyInput)/set_memory_strategies(Option<Vec::<MemoryStrategyInput>>):
required: falseThe memory strategies to use for this memory. Strategies define how information is extracted, processed, and consolidated.
indexed_keys(IndexedKey)/set_indexed_keys(Option<Vec::<IndexedKey>>):
required: falseMetadata keys to index for filtering. Once declared, indexed keys cannot be removed.
stream_delivery_resources(StreamDeliveryResources)/set_stream_delivery_resources(Option<StreamDeliveryResources>):
required: falseConfiguration for streaming memory record data to external resources.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to an AgentCore Memory. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreateMemoryOutputwith field(s):memory(Option<Memory>):The details of the created memory, including its ID, ARN, name, description, and configuration settings.
- On failure, responds with
SdkError<CreateMemoryError>
Source§impl Client
impl Client
Sourcepub fn create_oauth2_credential_provider(
&self,
) -> CreateOauth2CredentialProviderFluentBuilder
pub fn create_oauth2_credential_provider( &self, ) -> CreateOauth2CredentialProviderFluentBuilder
Constructs a fluent builder for the CreateOauth2CredentialProvider operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the OAuth2 credential provider. The name must be unique within your account.
credential_provider_vendor(CredentialProviderVendorType)/set_credential_provider_vendor(Option<CredentialProviderVendorType>):
required: trueThe vendor of the OAuth2 credential provider. This specifies which OAuth2 implementation to use.
oauth2_provider_config_input(Oauth2ProviderConfigInput)/set_oauth2_provider_config_input(Option<Oauth2ProviderConfigInput>):
required: trueThe configuration settings for the OAuth2 provider, including client ID, client secret, and other vendor-specific settings.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to the OAuth2 credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreateOauth2CredentialProviderOutputwith field(s):client_secret_arn(Option<Secret>):The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager.
client_secret_json_key(Option<String>):The JSON key used to extract the client secret value from the AWS Secrets Manager secret.
client_secret_source(Option<SecretSourceType>):The source type of the client secret. Either
MANAGEDif the secret is managed by the service, orEXTERNALif managed by the user in AWS Secrets Manager.name(String):The name of the OAuth2 credential provider.
credential_provider_arn(String):The Amazon Resource Name (ARN) of the OAuth2 credential provider.
callback_url(Option<String>):Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.
oauth2_provider_config_output(Option<Oauth2ProviderConfigOutput>):Contains the output configuration for an OAuth2 provider.
status(Option<Status>):The current status of the OAuth2 credential provider.
- On failure, responds with
SdkError<CreateOauth2CredentialProviderError>
Source§impl Client
impl Client
Sourcepub fn create_online_evaluation_config(
&self,
) -> CreateOnlineEvaluationConfigFluentBuilder
pub fn create_online_evaluation_config( &self, ) -> CreateOnlineEvaluationConfigFluentBuilder
Constructs a fluent builder for the CreateOnlineEvaluationConfig operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
online_evaluation_config_name(impl Into<String>)/set_online_evaluation_config_name(Option<String>):
required: trueThe name of the online evaluation configuration. Must be unique within your account.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the online evaluation configuration that explains its monitoring purpose and scope.
rule(Rule)/set_rule(Option<Rule>):
required: trueThe evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.
data_source_config(DataSourceConfig)/set_data_source_config(Option<DataSourceConfig>):
required: trueThe data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.
evaluators(EvaluatorReference)/set_evaluators(Option<Vec::<EvaluatorReference>>):
required: trueThe list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with
CreateEvaluator.evaluation_execution_role_arn(impl Into<String>)/set_evaluation_execution_role_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation. If the configuration references evaluators encrypted with a customer managed KMS key, this role must also have
kms:Decryptpermission on the KMS key. The service validates this permission at configuration creation time. For more information, see Encryption at rest for AgentCore Evaluations.enable_on_create(bool)/set_enable_on_create(Option<bool>):
required: trueWhether to enable the online evaluation configuration immediately upon creation. If true, evaluation begins automatically.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to an AgentCore Online Evaluation Config. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreateOnlineEvaluationConfigOutputwith field(s):online_evaluation_config_arn(String):The Amazon Resource Name (ARN) of the created online evaluation configuration.
online_evaluation_config_id(String):The unique identifier of the created online evaluation configuration.
created_at(DateTime):The timestamp when the online evaluation configuration was created.
output_config(Option<OutputConfig>):The configuration that specifies where evaluation results should be written for monitoring and analysis.
status(OnlineEvaluationConfigStatus):The status of the online evaluation configuration.
execution_status(OnlineEvaluationExecutionStatus):The execution status indicating whether the online evaluation is currently running.
failure_reason(Option<String>):The reason for failure if the online evaluation configuration creation or execution failed.
- On failure, responds with
SdkError<CreateOnlineEvaluationConfigError>
Source§impl Client
impl Client
Sourcepub fn create_payment_connector(&self) -> CreatePaymentConnectorFluentBuilder
pub fn create_payment_connector(&self) -> CreatePaymentConnectorFluentBuilder
Constructs a fluent builder for the CreatePaymentConnector operation.
- The fluent builder is configurable:
payment_manager_id(impl Into<String>)/set_payment_manager_id(Option<String>):
required: trueThe unique identifier of the payment manager to create the connector for.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the payment connector.
description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the payment connector.
r#type(PaymentConnectorType)/set_type(Option<PaymentConnectorType>):
required: trueThe type of payment connector, which determines the payment provider integration.
credential_provider_configurations(CredentialsProviderConfiguration)/set_credential_provider_configurations(Option<Vec::<CredentialsProviderConfiguration>>):
required: trueThe credential provider configurations for the payment connector. These configurations specify how the connector authenticates with the payment provider.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
- On success, responds with
CreatePaymentConnectorOutputwith field(s):payment_connector_id(String):The unique identifier of the created payment connector.
payment_manager_id(String):The unique identifier of the parent payment manager.
name(String):The name of the created payment connector.
r#type(PaymentConnectorType):The type of the created payment connector.
credential_provider_configurations(Vec::<CredentialsProviderConfiguration>):The credential provider configurations for the created payment connector.
created_at(DateTime):The timestamp when the payment connector was created.
status(PaymentConnectorStatus):The current status of the payment connector. Possible values include
CREATING,READY,UPDATING,DELETING,CREATE_FAILED,UPDATE_FAILED, andDELETE_FAILED.
- On failure, responds with
SdkError<CreatePaymentConnectorError>
Source§impl Client
impl Client
Sourcepub fn create_payment_credential_provider(
&self,
) -> CreatePaymentCredentialProviderFluentBuilder
pub fn create_payment_credential_provider( &self, ) -> CreatePaymentCredentialProviderFluentBuilder
Constructs a fluent builder for the CreatePaymentCredentialProvider operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueUnique name for the payment credential provider.
credential_provider_vendor(PaymentCredentialProviderVendorType)/set_credential_provider_vendor(Option<PaymentCredentialProviderVendorType>):
required: trueThe vendor type for the payment credential provider (e.g., CoinbaseCDP, StripePrivy).
provider_configuration_input(PaymentProviderConfigurationInput)/set_provider_configuration_input(Option<PaymentProviderConfigurationInput>):
required: trueConfiguration specific to the vendor, including API credentials.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseOptional tags for resource organization.
- On success, responds with
CreatePaymentCredentialProviderOutputwith field(s):name(String):The name of the created payment credential provider.
credential_provider_vendor(PaymentCredentialProviderVendorType):The vendor type for the created payment credential provider.
credential_provider_arn(String):The Amazon Resource Name (ARN) of the created payment credential provider.
provider_configuration_output(Option<PaymentProviderConfigurationOutput>):Output configuration (contains secret ARNs, excludes actual secret values).
- On failure, responds with
SdkError<CreatePaymentCredentialProviderError>
Source§impl Client
impl Client
Sourcepub fn create_payment_manager(&self) -> CreatePaymentManagerFluentBuilder
pub fn create_payment_manager(&self) -> CreatePaymentManagerFluentBuilder
Constructs a fluent builder for the CreatePaymentManager operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the payment manager.
description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the payment manager.
authorizer_type(PaymentsAuthorizerType)/set_authorizer_type(Option<PaymentsAuthorizerType>):
required: trueThe type of authorizer to use for the payment manager.
-
CUSTOM_JWT- Authorize with a bearer token. -
AWS_IAM- Authorize with your Amazon Web Services IAM credentials.
-
authorizer_configuration(AuthorizerConfiguration)/set_authorizer_configuration(Option<AuthorizerConfiguration>):
required: falseThe authorizer configuration for the payment manager.
role_arn(impl Into<String>)/set_role_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the IAM role that the payment manager assumes to access resources on your behalf.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to the payment manager.
- On success, responds with
CreatePaymentManagerOutputwith field(s):payment_manager_arn(String):The Amazon Resource Name (ARN) of the created payment manager.
payment_manager_id(String):The unique identifier of the created payment manager.
name(String):The name of the created payment manager.
authorizer_type(PaymentsAuthorizerType):The type of authorizer for the created payment manager.
authorizer_configuration(Option<AuthorizerConfiguration>):Represents inbound authorization configuration options used to authenticate incoming requests.
role_arn(String):The Amazon Resource Name (ARN) of the IAM role associated with the created payment manager.
workload_identity_details(Option<WorkloadIdentityDetails>):The information about the workload identity.
created_at(DateTime):The timestamp when the payment manager was created.
status(PaymentManagerStatus):The current status of the payment manager. Possible values include
CREATING,READY,UPDATING,DELETING,CREATE_FAILED,UPDATE_FAILED, andDELETE_FAILED.tags(Option<HashMap::<String, String>>):The tags associated with the created payment manager.
- On failure, responds with
SdkError<CreatePaymentManagerError>
Source§impl Client
impl Client
Sourcepub fn create_policy(&self) -> CreatePolicyFluentBuilder
pub fn create_policy(&self) -> CreatePolicyFluentBuilder
Constructs a fluent builder for the CreatePolicy operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe 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.
definition(PolicyDefinition)/set_definition(Option<PolicyDefinition>):
required: trueThe 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.
description(impl Into<String>)/set_description(Option<String>):
required: falseA 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.
validation_mode(PolicyValidationMode)/set_validation_mode(Option<PolicyValidationMode>):
required: falseThe 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.
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe identifier of the policy engine which contains this policy. Policy engines group related policies and provide the execution context for policy evaluation.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA 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.
- On success, responds with
CreatePolicyOutputwith field(s):policy_id(String):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.
name(String):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.
policy_engine_id(String):The identifier of the policy engine that manages this policy. This confirms the policy engine assignment and is used for policy evaluation routing.
created_at(DateTime):The timestamp when the policy was created. This is automatically set by the service and used for auditing and lifecycle management.
updated_at(DateTime):The timestamp when the policy was last updated. For newly created policies, this matches the createdAt timestamp.
policy_arn(String):The Amazon Resource Name (ARN) of the created policy. This globally unique identifier can be used for cross-service references and IAM policy statements.
status(PolicyStatus):The current status of the policy. A status of
ACTIVEindicates the policy is ready for use.definition(Option<PolicyDefinition>):The Cedar policy statement that was created. This is the validated policy definition that will be used for agent behavior control and access decisions.
description(Option<String>):The human-readable description of the policy’s purpose and functionality. This helps administrators understand and manage the policy.
status_reasons(Vec::<String>):Additional information about the policy status. This provides details about any failures or the current state of the policy creation process.
- On failure, responds with
SdkError<CreatePolicyError>
Source§impl Client
impl Client
Sourcepub fn create_policy_engine(&self) -> CreatePolicyEngineFluentBuilder
pub fn create_policy_engine(&self) -> CreatePolicyEngineFluentBuilder
Constructs a fluent builder for the CreatePolicyEngine operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe customer-assigned immutable name for the policy engine. This name identifies the policy engine and cannot be changed after creation.
description(impl Into<String>)/set_description(Option<String>):
required: falseA human-readable description of the policy engine’s purpose and scope (1-4,096 characters). This helps administrators understand the policy engine’s role in the overall governance strategy. Document which Gateway this engine will be associated with, what types of tools or workflows it governs, and the team or service responsible for maintaining it. Clear descriptions are essential when managing multiple policy engines across different services or environments.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy engine.
encryption_key_arn(impl Into<String>)/set_encryption_key_arn(Option<String>):
required: falseThe Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to an AgentCore Policy. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreatePolicyEngineOutputwith field(s):policy_engine_id(String):The unique identifier for the created policy engine. This system-generated identifier consists of the user name plus a 10-character generated suffix and is used for all subsequent policy engine operations.
name(String):The customer-assigned name of the created policy engine. This matches the name provided in the request and serves as the human-readable identifier.
created_at(DateTime):The timestamp when the policy engine was created. This is automatically set by the service and used for auditing and lifecycle management.
updated_at(DateTime):The timestamp when the policy engine was last updated. For newly created policy engines, this matches the
createdAttimestamp.policy_engine_arn(String):The Amazon Resource Name (ARN) of the created policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.
status(PolicyEngineStatus):The current status of the policy engine. A status of
ACTIVEindicates the policy engine is ready for use.encryption_key_arn(Option<String>):The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
description(Option<String>):A human-readable description of the policy engine’s purpose.
status_reasons(Vec::<String>):Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine creation process.
- On failure, responds with
SdkError<CreatePolicyEngineError>
Source§impl Client
impl Client
Sourcepub fn create_registry(&self) -> CreateRegistryFluentBuilder
pub fn create_registry(&self) -> CreateRegistryFluentBuilder
Constructs a fluent builder for the CreateRegistry operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the registry. The name must be unique within your account and can contain alphanumeric characters and underscores.
description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the registry.
authorizer_type(RegistryAuthorizerType)/set_authorizer_type(Option<RegistryAuthorizerType>):
required: falseThe type of authorizer to use for the registry. This controls the authorization method for the Search and Invoke APIs used by consumers, and does not affect the standard CRUDL APIs for registry and registry record management used by administrators.
-
CUSTOM_JWT- Authorize with a bearer token. -
AWS_IAM- Authorize with your Amazon Web Services IAM credentials.
-
authorizer_configuration(AuthorizerConfiguration)/set_authorizer_configuration(Option<AuthorizerConfiguration>):
required: falseThe authorizer configuration for the registry. Required if
authorizerTypeisCUSTOM_JWT. For details, see theAuthorizerConfigurationdata type.client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
approval_configuration(ApprovalConfiguration)/set_approval_configuration(Option<ApprovalConfiguration>):
required: falseThe approval configuration for registry records. Controls whether records require explicit approval before becoming active. See the
ApprovalConfigurationdata type for supported configuration options.
- On success, responds with
CreateRegistryOutputwith field(s):registry_arn(String):The Amazon Resource Name (ARN) of the created registry.
- On failure, responds with
SdkError<CreateRegistryError>
Source§impl Client
impl Client
Sourcepub fn create_registry_record(&self) -> CreateRegistryRecordFluentBuilder
pub fn create_registry_record(&self) -> CreateRegistryRecordFluentBuilder
Constructs a fluent builder for the CreateRegistryRecord operation.
- The fluent builder is configurable:
registry_id(impl Into<String>)/set_registry_id(Option<String>):
required: trueThe identifier of the registry where the record will be created. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the registry record.
description(impl Into<String>)/set_description(Option<String>):
required: falseA description of the registry record.
descriptor_type(DescriptorType)/set_descriptor_type(Option<DescriptorType>):
required: trueThe descriptor type of the registry record.
-
MCP- Model Context Protocol descriptor for MCP-compatible servers and tools. -
A2A- Agent-to-Agent protocol descriptor. -
CUSTOM- Custom descriptor type for resources such as APIs, Lambda functions, or servers not conforming to a standard protocol. -
AGENT_SKILLS- Agent skills descriptor for defining agent skill definitions.
-
descriptors(Descriptors)/set_descriptors(Option<Descriptors>):
required: falseThe descriptor-type-specific configuration containing the resource schema and metadata. The structure of this field depends on the
descriptorTypeyou specify.record_version(impl Into<String>)/set_record_version(Option<String>):
required: falseThe version of the registry record. Use this to track different versions of the record’s content.
synchronization_type(SynchronizationType)/set_synchronization_type(Option<SynchronizationType>):
required: falseThe type of synchronization to use for keeping the record metadata up to date from an external source. Possible values include
FROM_URLandNONE.synchronization_configuration(SynchronizationConfiguration)/set_synchronization_configuration(Option<SynchronizationConfiguration>):
required: falseThe configuration for synchronizing registry record metadata from an external source, such as a URL-based MCP server.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
- On success, responds with
CreateRegistryRecordOutputwith field(s):record_arn(String):The Amazon Resource Name (ARN) of the created registry record.
status(RegistryRecordStatus):The status of the registry record. Set to
CREATINGwhile the asynchronous workflow is in progress.
- On failure, responds with
SdkError<CreateRegistryRecordError>
Source§impl Client
impl Client
Sourcepub fn create_workload_identity(&self) -> CreateWorkloadIdentityFluentBuilder
pub fn create_workload_identity(&self) -> CreateWorkloadIdentityFluentBuilder
Constructs a fluent builder for the CreateWorkloadIdentity operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the workload identity. The name must be unique within your account.
allowed_resource_oauth2_return_urls(impl Into<String>)/set_allowed_resource_oauth2_return_urls(Option<Vec::<String>>):
required: falseThe list of allowed OAuth2 return URLs for resources associated with this workload identity.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseA map of tag keys and values to assign to the workload identity. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
- On success, responds with
CreateWorkloadIdentityOutputwith field(s):name(String):The name of the workload identity.
workload_identity_arn(String):The Amazon Resource Name (ARN) of the workload identity.
allowed_resource_oauth2_return_urls(Option<Vec::<String>>):The list of allowed OAuth2 return URLs for resources associated with this workload identity.
- On failure, responds with
SdkError<CreateWorkloadIdentityError>
Source§impl Client
impl Client
Sourcepub fn delete_agent_runtime(&self) -> DeleteAgentRuntimeFluentBuilder
pub fn delete_agent_runtime(&self) -> DeleteAgentRuntimeFluentBuilder
Constructs a fluent builder for the DeleteAgentRuntime operation.
- The fluent builder is configurable:
agent_runtime_id(impl Into<String>)/set_agent_runtime_id(Option<String>):
required: trueThe unique identifier of the AgentCore Runtime to delete.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.
- On success, responds with
DeleteAgentRuntimeOutputwith field(s):status(AgentRuntimeStatus):The current status of the AgentCore Runtime deletion.
agent_runtime_id(Option<String>):The unique identifier of the AgentCore Runtime.
- On failure, responds with
SdkError<DeleteAgentRuntimeError>
Source§impl Client
impl Client
Sourcepub fn delete_agent_runtime_endpoint(
&self,
) -> DeleteAgentRuntimeEndpointFluentBuilder
pub fn delete_agent_runtime_endpoint( &self, ) -> DeleteAgentRuntimeEndpointFluentBuilder
Constructs a fluent builder for the DeleteAgentRuntimeEndpoint operation.
- The fluent builder is configurable:
agent_runtime_id(impl Into<String>)/set_agent_runtime_id(Option<String>):
required: trueThe unique identifier of the AgentCore Runtime associated with the endpoint.
endpoint_name(impl Into<String>)/set_endpoint_name(Option<String>):
required: trueThe name of the AgentCore Runtime endpoint to delete.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency of the request.
- On success, responds with
DeleteAgentRuntimeEndpointOutputwith field(s):status(AgentRuntimeEndpointStatus):The current status of the AgentCore Runtime endpoint deletion.
agent_runtime_id(Option<String>):The unique identifier of the AgentCore Runtime.
endpoint_name(Option<String>):The name of the AgentCore Runtime endpoint.
- On failure, responds with
SdkError<DeleteAgentRuntimeEndpointError>
Source§impl Client
impl Client
Sourcepub fn delete_api_key_credential_provider(
&self,
) -> DeleteApiKeyCredentialProviderFluentBuilder
pub fn delete_api_key_credential_provider( &self, ) -> DeleteApiKeyCredentialProviderFluentBuilder
Constructs a fluent builder for the DeleteApiKeyCredentialProvider operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the API key credential provider to delete.
- On success, responds with
DeleteApiKeyCredentialProviderOutput - On failure, responds with
SdkError<DeleteApiKeyCredentialProviderError>
Source§impl Client
impl Client
Sourcepub fn delete_browser(&self) -> DeleteBrowserFluentBuilder
pub fn delete_browser(&self) -> DeleteBrowserFluentBuilder
Constructs a fluent builder for the DeleteBrowser operation.
- The fluent builder is configurable:
browser_id(impl Into<String>)/set_browser_id(Option<String>):
required: trueThe unique identifier of the browser to delete.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency of the request.
- On success, responds with
DeleteBrowserOutputwith field(s):browser_id(String):The unique identifier of the deleted browser.
status(BrowserStatus):The current status of the browser deletion.
last_updated_at(DateTime):The timestamp when the browser was last updated.
- On failure, responds with
SdkError<DeleteBrowserError>
Source§impl Client
impl Client
Sourcepub fn delete_browser_profile(&self) -> DeleteBrowserProfileFluentBuilder
pub fn delete_browser_profile(&self) -> DeleteBrowserProfileFluentBuilder
Constructs a fluent builder for the DeleteBrowserProfile operation.
- The fluent builder is configurable:
profile_id(impl Into<String>)/set_profile_id(Option<String>):
required: trueThe unique identifier of the browser profile to delete.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency of the request.
- On success, responds with
DeleteBrowserProfileOutputwith field(s):profile_id(String):The unique identifier of the deleted browser profile.
profile_arn(String):The Amazon Resource Name (ARN) of the deleted browser profile.
status(BrowserProfileStatus):The current status of the browser profile deletion.
last_updated_at(DateTime):The timestamp when the browser profile was last updated.
last_saved_at(Option<DateTime>):The timestamp when browser session data was last saved to this profile before deletion.
- On failure, responds with
SdkError<DeleteBrowserProfileError>
Source§impl Client
impl Client
Sourcepub fn delete_code_interpreter(&self) -> DeleteCodeInterpreterFluentBuilder
pub fn delete_code_interpreter(&self) -> DeleteCodeInterpreterFluentBuilder
Constructs a fluent builder for the DeleteCodeInterpreter operation.
- The fluent builder is configurable:
code_interpreter_id(impl Into<String>)/set_code_interpreter_id(Option<String>):
required: trueThe unique identifier of the code interpreter to delete.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency of the request.
- On success, responds with
DeleteCodeInterpreterOutputwith field(s):code_interpreter_id(String):The unique identifier of the deleted code interpreter.
status(CodeInterpreterStatus):The current status of the code interpreter deletion.
last_updated_at(DateTime):The timestamp when the code interpreter was last updated.
- On failure, responds with
SdkError<DeleteCodeInterpreterError>
Source§impl Client
impl Client
Sourcepub fn delete_configuration_bundle(
&self,
) -> DeleteConfigurationBundleFluentBuilder
pub fn delete_configuration_bundle( &self, ) -> DeleteConfigurationBundleFluentBuilder
Constructs a fluent builder for the DeleteConfigurationBundle operation.
- The fluent builder is configurable:
bundle_id(impl Into<String>)/set_bundle_id(Option<String>):
required: trueThe unique identifier of the configuration bundle to delete.
- On success, responds with
DeleteConfigurationBundleOutputwith field(s):bundle_id(String):The unique identifier of the deleted configuration bundle.
status(ConfigurationBundleStatus):The status of the configuration bundle deletion operation.
- On failure, responds with
SdkError<DeleteConfigurationBundleError>
Source§impl Client
impl Client
Sourcepub fn delete_dataset(&self) -> DeleteDatasetFluentBuilder
pub fn delete_dataset(&self) -> DeleteDatasetFluentBuilder
Constructs a fluent builder for the DeleteDataset operation.
- The fluent builder is configurable:
dataset_id(impl Into<String>)/set_dataset_id(Option<String>):
required: trueThe unique identifier of the dataset to delete.
dataset_version(impl Into<String>)/set_dataset_version(Option<String>):
required: false
Optional version to delete. Use “DRAFT” or omit to delete the draft. Returns ResourceNotFoundException if the specified version does not exist.
- On success, responds with
DeleteDatasetOutputwith field(s):dataset_arn(String):The Amazon Resource Name (ARN) of the dataset.
dataset_id(String):The unique identifier of the dataset.
status(DatasetStatus):The current status of the dataset after the delete request.
dataset_version(String): The version deleted.updated_at(DateTime):The timestamp when the delete was initiated.
- On failure, responds with
SdkError<DeleteDatasetError>
Source§impl Client
impl Client
Sourcepub fn delete_dataset_examples(&self) -> DeleteDatasetExamplesFluentBuilder
pub fn delete_dataset_examples(&self) -> DeleteDatasetExamplesFluentBuilder
Constructs a fluent builder for the DeleteDatasetExamples operation.
- The fluent builder is configurable:
dataset_id(impl Into<String>)/set_dataset_id(Option<String>):
required: trueThe unique identifier of the dataset.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
example_ids(impl Into<String>)/set_example_ids(Option<Vec::<String>>):
required: trueThe IDs of the examples to delete.
- On success, responds with
DeleteDatasetExamplesOutputwith field(s):dataset_arn(String):The Amazon Resource Name (ARN) of the dataset.
dataset_id(String):The unique identifier of the dataset.
status(DatasetStatus):The current status of the dataset.
deleted_count(i64):The number of examples deleted.
updated_at(DateTime):The timestamp when the examples were deleted.
- On failure, responds with
SdkError<DeleteDatasetExamplesError>
Source§impl Client
impl Client
Sourcepub fn delete_evaluator(&self) -> DeleteEvaluatorFluentBuilder
pub fn delete_evaluator(&self) -> DeleteEvaluatorFluentBuilder
Constructs a fluent builder for the DeleteEvaluator operation.
- The fluent builder is configurable:
evaluator_id(impl Into<String>)/set_evaluator_id(Option<String>):
required: trueThe unique identifier of the evaluator to delete.
- On success, responds with
DeleteEvaluatorOutputwith field(s):evaluator_arn(String):The Amazon Resource Name (ARN) of the deleted evaluator.
evaluator_id(String):The unique identifier of the deleted evaluator.
status(EvaluatorStatus):The status of the evaluator deletion operation.
- On failure, responds with
SdkError<DeleteEvaluatorError>
Source§impl Client
impl Client
Sourcepub fn delete_gateway(&self) -> DeleteGatewayFluentBuilder
pub fn delete_gateway(&self) -> DeleteGatewayFluentBuilder
Constructs a fluent builder for the DeleteGateway operation.
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe identifier of the gateway to delete.
- On success, responds with
DeleteGatewayOutputwith field(s):gateway_id(String):The unique identifier of the deleted gateway.
status(GatewayStatus):The current status of the gateway deletion.
status_reasons(Option<Vec::<String>>):The reasons for the current status of the gateway deletion.
- On failure, responds with
SdkError<DeleteGatewayError>
Source§impl Client
impl Client
Sourcepub fn delete_gateway_rule(&self) -> DeleteGatewayRuleFluentBuilder
pub fn delete_gateway_rule(&self) -> DeleteGatewayRuleFluentBuilder
Constructs a fluent builder for the DeleteGatewayRule operation.
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe identifier of the gateway containing the rule.
rule_id(impl Into<String>)/set_rule_id(Option<String>):
required: trueThe unique identifier of the rule to delete.
- On success, responds with
DeleteGatewayRuleOutputwith field(s):rule_id(String):The unique identifier of the deleted rule.
status(GatewayRuleStatus):The status of the rule deletion operation.
- On failure, responds with
SdkError<DeleteGatewayRuleError>
Source§impl Client
impl Client
Sourcepub fn delete_gateway_target(&self) -> DeleteGatewayTargetFluentBuilder
pub fn delete_gateway_target(&self) -> DeleteGatewayTargetFluentBuilder
Constructs a fluent builder for the DeleteGatewayTarget operation.
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe unique identifier of the gateway associated with the target.
target_id(impl Into<String>)/set_target_id(Option<String>):
required: trueThe unique identifier of the gateway target to delete.
- On success, responds with
DeleteGatewayTargetOutputwith field(s):gateway_arn(String):The Amazon Resource Name (ARN) of the gateway.
target_id(String):The unique identifier of the deleted gateway target.
status(TargetStatus):The current status of the gateway target deletion.
status_reasons(Option<Vec::<String>>):The reasons for the current status of the gateway target deletion.
- On failure, responds with
SdkError<DeleteGatewayTargetError>
Source§impl Client
impl Client
Sourcepub fn delete_harness(&self) -> DeleteHarnessFluentBuilder
pub fn delete_harness(&self) -> DeleteHarnessFluentBuilder
Constructs a fluent builder for the DeleteHarness operation.
- The fluent builder is configurable:
harness_id(impl Into<String>)/set_harness_id(Option<String>):
required: trueThe ID of the harness to delete.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency of the request.
- On success, responds with
DeleteHarnessOutputwith field(s):harness(Option<Harness>):The harness that was deleted.
- On failure, responds with
SdkError<DeleteHarnessError>
Source§impl Client
impl Client
Sourcepub fn delete_memory(&self) -> DeleteMemoryFluentBuilder
pub fn delete_memory(&self) -> DeleteMemoryFluentBuilder
Constructs a fluent builder for the DeleteMemory operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique AWS identifier.
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe unique identifier of the memory to delete.
- On success, responds with
DeleteMemoryOutputwith field(s):memory_id(String):The unique identifier of the deleted AgentCore Memory resource.
status(Option<MemoryStatus>):The current status of the AgentCore Memory resource deletion.
- On failure, responds with
SdkError<DeleteMemoryError>
Source§impl Client
impl Client
Sourcepub fn delete_oauth2_credential_provider(
&self,
) -> DeleteOauth2CredentialProviderFluentBuilder
pub fn delete_oauth2_credential_provider( &self, ) -> DeleteOauth2CredentialProviderFluentBuilder
Constructs a fluent builder for the DeleteOauth2CredentialProvider operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the OAuth2 credential provider to delete.
- On success, responds with
DeleteOauth2CredentialProviderOutput - On failure, responds with
SdkError<DeleteOauth2CredentialProviderError>
Source§impl Client
impl Client
Sourcepub fn delete_online_evaluation_config(
&self,
) -> DeleteOnlineEvaluationConfigFluentBuilder
pub fn delete_online_evaluation_config( &self, ) -> DeleteOnlineEvaluationConfigFluentBuilder
Constructs a fluent builder for the DeleteOnlineEvaluationConfig operation.
- The fluent builder is configurable:
online_evaluation_config_id(impl Into<String>)/set_online_evaluation_config_id(Option<String>):
required: trueThe unique identifier of the online evaluation configuration to delete.
- On success, responds with
DeleteOnlineEvaluationConfigOutputwith field(s):online_evaluation_config_arn(String):The Amazon Resource Name (ARN) of the deleted online evaluation configuration.
online_evaluation_config_id(String):The unique identifier of the deleted online evaluation configuration.
status(OnlineEvaluationConfigStatus):The status of the online evaluation configuration deletion operation.
- On failure, responds with
SdkError<DeleteOnlineEvaluationConfigError>
Source§impl Client
impl Client
Sourcepub fn delete_payment_connector(&self) -> DeletePaymentConnectorFluentBuilder
pub fn delete_payment_connector(&self) -> DeletePaymentConnectorFluentBuilder
Constructs a fluent builder for the DeletePaymentConnector operation.
- The fluent builder is configurable:
payment_manager_id(impl Into<String>)/set_payment_manager_id(Option<String>):
required: trueThe unique identifier of the parent payment manager.
payment_connector_id(impl Into<String>)/set_payment_connector_id(Option<String>):
required: trueThe unique identifier of the payment connector to delete.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
- On success, responds with
DeletePaymentConnectorOutputwith field(s):status(PaymentConnectorStatus):The current status of the payment connector, set to
DELETINGwhen deletion is initiated. Possible values includeCREATING,READY,UPDATING,DELETING,CREATE_FAILED,UPDATE_FAILED, andDELETE_FAILED.payment_connector_id(Option<String>):The unique identifier of the deleted payment connector.
- On failure, responds with
SdkError<DeletePaymentConnectorError>
Source§impl Client
impl Client
Sourcepub fn delete_payment_credential_provider(
&self,
) -> DeletePaymentCredentialProviderFluentBuilder
pub fn delete_payment_credential_provider( &self, ) -> DeletePaymentCredentialProviderFluentBuilder
Constructs a fluent builder for the DeletePaymentCredentialProvider operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the payment credential provider to delete.
- On success, responds with
DeletePaymentCredentialProviderOutput - On failure, responds with
SdkError<DeletePaymentCredentialProviderError>
Source§impl Client
impl Client
Sourcepub fn delete_payment_manager(&self) -> DeletePaymentManagerFluentBuilder
pub fn delete_payment_manager(&self) -> DeletePaymentManagerFluentBuilder
Constructs a fluent builder for the DeletePaymentManager operation.
- The fluent builder is configurable:
payment_manager_id(impl Into<String>)/set_payment_manager_id(Option<String>):
required: trueThe unique identifier of the payment manager to delete.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
- On success, responds with
DeletePaymentManagerOutputwith field(s):status(PaymentManagerStatus):The current status of the payment manager, set to
DELETINGwhen deletion is initiated. Possible values includeCREATING,READY,UPDATING,DELETING,CREATE_FAILED,UPDATE_FAILED, andDELETE_FAILED.payment_manager_id(Option<String>):The unique identifier of the deleted payment manager.
- On failure, responds with
SdkError<DeletePaymentManagerError>
Source§impl Client
impl Client
Sourcepub fn delete_policy(&self) -> DeletePolicyFluentBuilder
pub fn delete_policy(&self) -> DeletePolicyFluentBuilder
Constructs a fluent builder for the DeletePolicy operation.
- The fluent builder is configurable:
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe identifier of the policy engine that manages the policy to be deleted. This ensures the policy is deleted from the correct policy engine context.
policy_id(impl Into<String>)/set_policy_id(Option<String>):
required: trueThe unique identifier of the policy to be deleted. This must be a valid policy ID that exists within the specified policy engine.
- On success, responds with
DeletePolicyOutputwith field(s):policy_id(String):The unique identifier of the policy being deleted. This confirms which policy the deletion operation targets.
name(String):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.
policy_engine_id(String):The identifier of the policy engine from which the policy was deleted. This confirms the policy engine context for the deletion operation.
created_at(DateTime):The timestamp when the deleted policy was originally created.
updated_at(DateTime):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.
policy_arn(String):The Amazon Resource Name (ARN) of the deleted policy. This globally unique identifier confirms which policy resource was successfully removed.
status(PolicyStatus):The status of the policy deletion operation. This provides information about any issues that occurred during the deletion process.
definition(Option<PolicyDefinition>):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.
description(Option<String>):The human-readable description of the deleted policy.
status_reasons(Vec::<String>):Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.
- On failure, responds with
SdkError<DeletePolicyError>
Source§impl Client
impl Client
Sourcepub fn delete_policy_engine(&self) -> DeletePolicyEngineFluentBuilder
pub fn delete_policy_engine(&self) -> DeletePolicyEngineFluentBuilder
Constructs a fluent builder for the DeletePolicyEngine operation.
- The fluent builder is configurable:
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe unique identifier of the policy engine to be deleted. This must be a valid policy engine ID that exists within the account.
- On success, responds with
DeletePolicyEngineOutputwith field(s):policy_engine_id(String):The unique identifier of the policy engine being deleted. This confirms which policy engine the deletion operation targets.
name(String):The customer-assigned name of the deleted policy engine.
created_at(DateTime):The timestamp when the deleted policy engine was originally created.
updated_at(DateTime):The timestamp when the deleted policy engine was last modified before deletion. This tracks the final state of the policy engine before it was removed from the system.
policy_engine_arn(String):The Amazon Resource Name (ARN) of the deleted policy engine. This globally unique identifier confirms which policy engine resource was successfully removed.
status(PolicyEngineStatus):The status of the policy engine deletion operation. This provides status about any issues that occurred during the deletion process.
encryption_key_arn(Option<String>):The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
description(Option<String>):The human-readable description of the deleted policy engine.
status_reasons(Vec::<String>):Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.
- On failure, responds with
SdkError<DeletePolicyEngineError>
Source§impl Client
impl Client
Sourcepub fn delete_registry(&self) -> DeleteRegistryFluentBuilder
pub fn delete_registry(&self) -> DeleteRegistryFluentBuilder
Constructs a fluent builder for the DeleteRegistry operation.
- The fluent builder is configurable:
registry_id(impl Into<String>)/set_registry_id(Option<String>):
required: trueThe identifier of the registry to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
- On success, responds with
DeleteRegistryOutputwith field(s):status(RegistryStatus):The current status of the registry, set to
DELETINGwhen deletion is initiated. For a list of all possible registry statuses, see theRegistryStatusdata type.
- On failure, responds with
SdkError<DeleteRegistryError>
Source§impl Client
impl Client
Sourcepub fn delete_registry_record(&self) -> DeleteRegistryRecordFluentBuilder
pub fn delete_registry_record(&self) -> DeleteRegistryRecordFluentBuilder
Constructs a fluent builder for the DeleteRegistryRecord operation.
- The fluent builder is configurable:
registry_id(impl Into<String>)/set_registry_id(Option<String>):
required: trueThe identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
record_id(impl Into<String>)/set_record_id(Option<String>):
required: trueThe identifier of the registry record to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
- On success, responds with
DeleteRegistryRecordOutput - On failure, responds with
SdkError<DeleteRegistryRecordError>
Source§impl Client
impl Client
Sourcepub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder
pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder
Constructs a fluent builder for the DeleteResourcePolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource for which to delete the resource policy.
- On success, responds with
DeleteResourcePolicyOutput - On failure, responds with
SdkError<DeleteResourcePolicyError>
Source§impl Client
impl Client
Sourcepub fn delete_workload_identity(&self) -> DeleteWorkloadIdentityFluentBuilder
pub fn delete_workload_identity(&self) -> DeleteWorkloadIdentityFluentBuilder
Constructs a fluent builder for the DeleteWorkloadIdentity operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the workload identity to delete.
- On success, responds with
DeleteWorkloadIdentityOutput - On failure, responds with
SdkError<DeleteWorkloadIdentityError>
Source§impl Client
impl Client
Sourcepub fn get_agent_runtime(&self) -> GetAgentRuntimeFluentBuilder
pub fn get_agent_runtime(&self) -> GetAgentRuntimeFluentBuilder
Constructs a fluent builder for the GetAgentRuntime operation.
- The fluent builder is configurable:
agent_runtime_id(impl Into<String>)/set_agent_runtime_id(Option<String>):
required: trueThe unique identifier of the AgentCore Runtime to retrieve.
agent_runtime_version(impl Into<String>)/set_agent_runtime_version(Option<String>):
required: falseThe version of the AgentCore Runtime to retrieve.
- On success, responds with
GetAgentRuntimeOutputwith field(s):agent_runtime_arn(String):The Amazon Resource Name (ARN) of the AgentCore Runtime.
agent_runtime_name(String):The name of the AgentCore Runtime.
agent_runtime_id(String):The unique identifier of the AgentCore Runtime.
agent_runtime_version(String):The version of the AgentCore Runtime.
created_at(DateTime):The timestamp when the AgentCore Runtime was created.
last_updated_at(DateTime):The timestamp when the AgentCore Runtime was last updated.
role_arn(String):The IAM role ARN that provides permissions for the AgentCore Runtime.
network_configuration(Option<NetworkConfiguration>):The network configuration for the AgentCore Runtime.
status(AgentRuntimeStatus):The current status of the AgentCore Runtime.
lifecycle_configuration(Option<LifecycleConfiguration>):The life cycle configuration for the AgentCore Runtime.
failure_reason(Option<String>):The reason for failure if the AgentCore Runtime is in a failed state.
description(Option<String>):The description of the AgentCore Runtime.
workload_identity_details(Option<WorkloadIdentityDetails>):The workload identity details for the AgentCore Runtime.
agent_runtime_artifact(Option<AgentRuntimeArtifact>):The artifact of the AgentCore Runtime.
protocol_configuration(Option<ProtocolConfiguration>):The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.
environment_variables(Option<HashMap::<String, String>>):Environment variables set in the AgentCore Runtime environment.
authorizer_configuration(Option<AuthorizerConfiguration>):The authorizer configuration for the AgentCore Runtime.
request_header_configuration(Option<RequestHeaderConfiguration>):Configuration for HTTP request headers that will be passed through to the runtime.
metadata_configuration(Option<RuntimeMetadataConfiguration>):Configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.
filesystem_configurations(Option<Vec::<FilesystemConfiguration>>):The filesystem configurations mounted into the AgentCore Runtime.
- On failure, responds with
SdkError<GetAgentRuntimeError>
Source§impl Client
impl Client
Sourcepub fn get_agent_runtime_endpoint(&self) -> GetAgentRuntimeEndpointFluentBuilder
pub fn get_agent_runtime_endpoint(&self) -> GetAgentRuntimeEndpointFluentBuilder
Constructs a fluent builder for the GetAgentRuntimeEndpoint operation.
- The fluent builder is configurable:
agent_runtime_id(impl Into<String>)/set_agent_runtime_id(Option<String>):
required: trueThe unique identifier of the AgentCore Runtime associated with the endpoint.
endpoint_name(impl Into<String>)/set_endpoint_name(Option<String>):
required: trueThe name of the AgentCore Runtime endpoint to retrieve.
- On success, responds with
GetAgentRuntimeEndpointOutputwith field(s):live_version(Option<String>):The currently deployed version of the AgentCore Runtime on the endpoint.
target_version(Option<String>):The target version of the AgentCore Runtime for the endpoint.
agent_runtime_endpoint_arn(String):The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.
agent_runtime_arn(String):The Amazon Resource Name (ARN) of the AgentCore Runtime.
description(Option<String>):The description of the AgentCore Runtime endpoint.
status(AgentRuntimeEndpointStatus):The current status of the AgentCore Runtime endpoint.
created_at(DateTime):The timestamp when the AgentCore Runtime endpoint was created.
last_updated_at(DateTime):The timestamp when the AgentCore Runtime endpoint was last updated.
failure_reason(Option<String>):The reason for failure if the AgentCore Runtime endpoint is in a failed state.
name(String):The name of the AgentCore Runtime endpoint.
id(String):The unique identifier of the AgentCore Runtime endpoint.
- On failure, responds with
SdkError<GetAgentRuntimeEndpointError>
Source§impl Client
impl Client
Sourcepub fn get_api_key_credential_provider(
&self,
) -> GetApiKeyCredentialProviderFluentBuilder
pub fn get_api_key_credential_provider( &self, ) -> GetApiKeyCredentialProviderFluentBuilder
Constructs a fluent builder for the GetApiKeyCredentialProvider operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the API key credential provider to retrieve.
- On success, responds with
GetApiKeyCredentialProviderOutputwith field(s):api_key_secret_arn(Option<Secret>):The Amazon Resource Name (ARN) of the API key secret in AWS Secrets Manager.
api_key_secret_json_key(Option<String>):The JSON key used to extract the API key value from the AWS Secrets Manager secret.
api_key_secret_source(Option<SecretSourceType>):The source type of the API key secret. Either
MANAGEDif the secret is managed by the service, orEXTERNALif managed by the user in AWS Secrets Manager.name(String):The name of the API key credential provider.
credential_provider_arn(String):The Amazon Resource Name (ARN) of the API key credential provider.
created_time(DateTime):The timestamp when the API key credential provider was created.
last_updated_time(DateTime):The timestamp when the API key credential provider was last updated.
- On failure, responds with
SdkError<GetApiKeyCredentialProviderError>
Source§impl Client
impl Client
Sourcepub fn get_browser(&self) -> GetBrowserFluentBuilder
pub fn get_browser(&self) -> GetBrowserFluentBuilder
Constructs a fluent builder for the GetBrowser operation.
- The fluent builder is configurable:
browser_id(impl Into<String>)/set_browser_id(Option<String>):
required: trueThe unique identifier of the browser to retrieve.
- On success, responds with
GetBrowserOutputwith field(s):browser_id(String):The unique identifier of the browser.
browser_arn(String):The Amazon Resource Name (ARN) of the browser.
name(String):The name of the browser.
description(Option<String>):The description of the browser.
execution_role_arn(Option<String>):The IAM role ARN that provides permissions for the browser.
network_configuration(Option<BrowserNetworkConfiguration>):The network configuration for a browser. This structure defines how the browser connects to the network.
recording(Option<RecordingConfig>):The recording configuration for a browser. This structure defines how browser sessions are recorded.
browser_signing(Option<BrowserSigningConfigOutput>):The browser signing configuration that shows whether cryptographic agent identification is enabled for web bot authentication.
enterprise_policies(Option<Vec::<BrowserEnterprisePolicy>>):The list of enterprise policy files configured for the browser.
certificates(Option<Vec::<Certificate>>):The list of certificates configured for the browser.
status(BrowserStatus):The current status of the browser.
failure_reason(Option<String>):The reason for failure if the browser is in a failed state.
created_at(DateTime):The timestamp when the browser was created.
last_updated_at(DateTime):The timestamp when the browser was last updated.
- On failure, responds with
SdkError<GetBrowserError>
Source§impl Client
impl Client
Sourcepub fn get_browser_profile(&self) -> GetBrowserProfileFluentBuilder
pub fn get_browser_profile(&self) -> GetBrowserProfileFluentBuilder
Constructs a fluent builder for the GetBrowserProfile operation.
- The fluent builder is configurable:
profile_id(impl Into<String>)/set_profile_id(Option<String>):
required: trueThe unique identifier of the browser profile to retrieve.
- On success, responds with
GetBrowserProfileOutputwith field(s):profile_id(String):The unique identifier of the browser profile.
profile_arn(String):The Amazon Resource Name (ARN) of the browser profile.
name(String):The name of the browser profile.
description(Option<String>):The description of the browser profile.
status(BrowserProfileStatus):The current status of the browser profile.
created_at(DateTime):The timestamp when the browser profile was created.
last_updated_at(DateTime):The timestamp when the browser profile was last updated.
last_saved_at(Option<DateTime>):The timestamp when browser session data was last saved to this profile.
last_saved_browser_session_id(Option<String>):The identifier of the browser session from which data was last saved to this profile.
last_saved_browser_id(Option<String>):The identifier of the browser from which data was last saved to this profile.
- On failure, responds with
SdkError<GetBrowserProfileError>
Source§impl Client
impl Client
Sourcepub fn get_code_interpreter(&self) -> GetCodeInterpreterFluentBuilder
pub fn get_code_interpreter(&self) -> GetCodeInterpreterFluentBuilder
Constructs a fluent builder for the GetCodeInterpreter operation.
- The fluent builder is configurable:
code_interpreter_id(impl Into<String>)/set_code_interpreter_id(Option<String>):
required: trueThe unique identifier of the code interpreter to retrieve.
- On success, responds with
GetCodeInterpreterOutputwith field(s):code_interpreter_id(String):The unique identifier of the code interpreter.
code_interpreter_arn(String):The Amazon Resource Name (ARN) of the code interpreter.
name(String):The name of the code interpreter.
description(Option<String>):The description of the code interpreter.
execution_role_arn(Option<String>):The IAM role ARN that provides permissions for the code interpreter.
network_configuration(Option<CodeInterpreterNetworkConfiguration>):The network configuration for a code interpreter. This structure defines how the code interpreter connects to the network.
status(CodeInterpreterStatus):The current status of the code interpreter.
certificates(Option<Vec::<Certificate>>):The list of certificates configured for the code interpreter.
failure_reason(Option<String>):The reason for failure if the code interpreter is in a failed state.
created_at(DateTime):The timestamp when the code interpreter was created.
last_updated_at(DateTime):The timestamp when the code interpreter was last updated.
- On failure, responds with
SdkError<GetCodeInterpreterError>
Source§impl Client
impl Client
Sourcepub fn get_configuration_bundle(&self) -> GetConfigurationBundleFluentBuilder
pub fn get_configuration_bundle(&self) -> GetConfigurationBundleFluentBuilder
Constructs a fluent builder for the GetConfigurationBundle operation.
- The fluent builder is configurable:
bundle_id(impl Into<String>)/set_bundle_id(Option<String>):
required: trueThe unique identifier of the configuration bundle to retrieve.
branch_name(impl Into<String>)/set_branch_name(Option<String>):
required: falseThe branch name to get the latest version from. If not specified, returns the latest version on the mainline branch.
- On success, responds with
GetConfigurationBundleOutputwith field(s):bundle_arn(String):The Amazon Resource Name (ARN) of the configuration bundle.
bundle_id(String):The unique identifier of the configuration bundle.
bundle_name(String):The name of the configuration bundle.
description(Option<String>):The description of the configuration bundle.
version_id(String):The version identifier of this configuration bundle.
components(HashMap::<String, ComponentConfiguration>):A map of component identifiers to their configurations for this version.
lineage_metadata(Option<VersionLineageMetadata>):The version lineage metadata, including parent versions, branch name, and creation source.
created_at(DateTime):The timestamp when the configuration bundle was created.
updated_at(DateTime):The timestamp when the configuration bundle was last updated.
- On failure, responds with
SdkError<GetConfigurationBundleError>
Source§impl Client
impl Client
Sourcepub fn get_configuration_bundle_version(
&self,
) -> GetConfigurationBundleVersionFluentBuilder
pub fn get_configuration_bundle_version( &self, ) -> GetConfigurationBundleVersionFluentBuilder
Constructs a fluent builder for the GetConfigurationBundleVersion operation.
- The fluent builder is configurable:
bundle_id(impl Into<String>)/set_bundle_id(Option<String>):
required: trueThe unique identifier of the configuration bundle.
version_id(impl Into<String>)/set_version_id(Option<String>):
required: trueThe version identifier of the configuration bundle version to retrieve.
- On success, responds with
GetConfigurationBundleVersionOutputwith field(s):bundle_arn(String):The Amazon Resource Name (ARN) of the configuration bundle.
bundle_id(String):The unique identifier of the configuration bundle.
bundle_name(String):The name of the configuration bundle.
description(Option<String>):The description of the configuration bundle.
version_id(String):The version identifier of this configuration bundle version.
components(HashMap::<String, ComponentConfiguration>):A map of component identifiers to their configurations for this version.
lineage_metadata(Option<VersionLineageMetadata>):The version lineage metadata, including parent versions, branch name, and creation source.
created_at(DateTime):The timestamp when the configuration bundle was created.
version_created_at(DateTime):The timestamp when this specific version was created.
- On failure, responds with
SdkError<GetConfigurationBundleVersionError>
Source§impl Client
impl Client
Sourcepub fn get_dataset(&self) -> GetDatasetFluentBuilder
pub fn get_dataset(&self) -> GetDatasetFluentBuilder
Constructs a fluent builder for the GetDataset operation.
- The fluent builder is configurable:
dataset_id(impl Into<String>)/set_dataset_id(Option<String>):
required: trueThe unique identifier of the dataset to retrieve.
dataset_version(impl Into<String>)/set_dataset_version(Option<String>):
required: false
Version to retrieve: “DRAFT” or a version number. Defaults to DRAFT if absent.
- On success, responds with
GetDatasetOutputwith field(s):dataset_arn(String):The Amazon Resource Name (ARN) of the dataset.
dataset_id(String):The unique identifier of the dataset.
dataset_version(String): The resolved version: “DRAFT” (default) or the requested version number.dataset_name(String):The name of the dataset.
description(Option<String>):The description of the dataset.
status(DatasetStatus):The current status of the dataset.
draft_status(Option<DraftStatus>): Publish synchronization state. Only authoritative when status == ACTIVE. MODIFIED — DRAFT has unpublished changes (or no published versions yet). UNMODIFIED — DRAFT matches the latest published version exactly.failure_reason(Option<String>): Populated when status is CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED.schema_type(DatasetSchemaType): The schema type declared at create time. Immutable after creation.kms_key_arn(Option<String>): AWS KMS key ARN used for SSE-KMS on service S3 writes, if configured.example_count(i64): Example count for DRAFT.download_url(Option<String>): Presigned S3 URL to download the consolidated dataset.jsonl file for the resolved version (DRAFT or published). TTL: 5 minutes. Omitted if the file does not yet exist (e.g. during CREATING) or on presign failure.download_url_expires_at(Option<DateTime>): Expiry timestamp for downloadUrl.created_at(DateTime):The timestamp when the dataset was created.
updated_at(DateTime):The timestamp when the dataset was last updated.
tags(Option<HashMap::<String, String>>):The tags associated with the dataset.
- On failure, responds with
SdkError<GetDatasetError>
Source§impl Client
impl Client
Sourcepub fn get_evaluator(&self) -> GetEvaluatorFluentBuilder
pub fn get_evaluator(&self) -> GetEvaluatorFluentBuilder
Constructs a fluent builder for the GetEvaluator operation.
- The fluent builder is configurable:
evaluator_id(impl Into<String>)/set_evaluator_id(Option<String>):
required: trueThe unique identifier of the evaluator to retrieve. Can be a built-in evaluator ID (e.g., Builtin.Helpfulness) or a custom evaluator ID.
included_data(IncludedData)/set_included_data(Option<IncludedData>):
required: falseControls which data is returned in the response.
ALL_DATA(default) returns the full evaluator including decrypted instructions and rating scale. For evaluators encrypted with a customer managed KMS key, this requireskms:Decryptpermission on the key.METADATA_ONLYreturns evaluator metadata and model configuration without instructions or rating scale, and does not require any KMS permissions.
- On success, responds with
GetEvaluatorOutputwith field(s):evaluator_arn(String):The Amazon Resource Name (ARN) of the evaluator.
evaluator_id(String):The unique identifier of the evaluator.
evaluator_name(String):The name of the evaluator.
description(Option<String>):The description of the evaluator.
evaluator_config(Option<EvaluatorConfig>):The configuration of the evaluator, including LLM-as-a-Judge or code-based settings.
level(EvaluatorLevel):The evaluation level (
TOOL_CALL,TRACE, orSESSION) that determines the scope of evaluation.status(EvaluatorStatus):The current status of the evaluator.
created_at(DateTime):The timestamp when the evaluator was created.
updated_at(DateTime):The timestamp when the evaluator was last updated.
locked_for_modification(Option<bool>):Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.
kms_key_arn(Option<String>):The Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt the evaluator’s sensitive data. This field is only present for evaluators encrypted with a customer managed key.
- On failure, responds with
SdkError<GetEvaluatorError>
Source§impl Client
impl Client
Sourcepub fn get_gateway(&self) -> GetGatewayFluentBuilder
pub fn get_gateway(&self) -> GetGatewayFluentBuilder
Constructs a fluent builder for the GetGateway operation.
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe identifier of the gateway to retrieve.
- On success, responds with
GetGatewayOutputwith field(s):gateway_arn(String):The Amazon Resource Name (ARN) of the gateway.
gateway_id(String):The unique identifier of the gateway.
gateway_url(Option<String>):An endpoint for invoking gateway.
created_at(DateTime):The timestamp when the gateway was created.
updated_at(DateTime):The timestamp when the gateway was last updated.
status(GatewayStatus):The current status of the gateway.
status_reasons(Option<Vec::<String>>):The reasons for the current status of the gateway.
name(String):The name of the gateway.
description(Option<String>):The description of the gateway.
role_arn(Option<String>):The IAM role ARN that provides permissions for the gateway.
protocol_type(GatewayProtocolType):Protocol applied to a gateway.
protocol_configuration(Option<GatewayProtocolConfiguration>):The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.
authorizer_type(AuthorizerType):Authorizer type for the gateway.
authorizer_configuration(Option<AuthorizerConfiguration>):The authorizer configuration for the gateway.
kms_key_arn(Option<String>):The Amazon Resource Name (ARN) of the KMS key used to encrypt the gateway.
interceptor_configurations(Option<Vec::<GatewayInterceptorConfiguration>>):The interceptors configured on the gateway.
policy_engine_configuration(Option<GatewayPolicyEngineConfiguration>):The policy engine configuration for the gateway.
workload_identity_details(Option<WorkloadIdentityDetails>):The workload identity details for the gateway.
exception_level(Option<ExceptionLevel>):The level of detail in error messages returned when invoking the gateway.
-
If the value is
DEBUG, granular exception messages are returned to help a user debug the gateway. -
If the value is omitted, a generic error message is returned to the end user.
-
- On failure, responds with
SdkError<GetGatewayError>
Source§impl Client
impl Client
Sourcepub fn get_gateway_rule(&self) -> GetGatewayRuleFluentBuilder
pub fn get_gateway_rule(&self) -> GetGatewayRuleFluentBuilder
Constructs a fluent builder for the GetGatewayRule operation.
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe identifier of the gateway containing the rule.
rule_id(impl Into<String>)/set_rule_id(Option<String>):
required: trueThe unique identifier of the rule to retrieve.
- On success, responds with
GetGatewayRuleOutputwith field(s):rule_id(String):The unique identifier of the gateway rule.
gateway_arn(String):The Amazon Resource Name (ARN) of the gateway that the rule belongs to.
priority(i32):The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.
conditions(Option<Vec::<Condition>>):The conditions that must be met for the rule to apply.
actions(Vec::<Action>):The actions to take when the rule conditions are met.
description(Option<String>):The description of the gateway rule.
created_at(DateTime):The timestamp when the rule was created.
status(GatewayRuleStatus):The current status of the rule.
system(Option<SystemManagedBlock>):System-managed metadata for rules created by automated processes.
updated_at(Option<DateTime>):The timestamp when the rule was last updated.
- On failure, responds with
SdkError<GetGatewayRuleError>
Source§impl Client
impl Client
Sourcepub fn get_gateway_target(&self) -> GetGatewayTargetFluentBuilder
pub fn get_gateway_target(&self) -> GetGatewayTargetFluentBuilder
Constructs a fluent builder for the GetGatewayTarget operation.
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe identifier of the gateway that contains the target.
target_id(impl Into<String>)/set_target_id(Option<String>):
required: trueThe unique identifier of the target to retrieve.
- On success, responds with
GetGatewayTargetOutputwith field(s):gateway_arn(String):The Amazon Resource Name (ARN) of the gateway.
target_id(String):The unique identifier of the gateway target.
created_at(DateTime):The timestamp when the gateway target was created.
updated_at(DateTime):The timestamp when the gateway target was last updated.
status(TargetStatus):The current status of the gateway target.
status_reasons(Option<Vec::<String>>):The reasons for the current status of the gateway target.
name(String):The name of the gateway target.
description(Option<String>):The description of the gateway target.
target_configuration(Option<TargetConfiguration>):The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.
credential_provider_configurations(Vec::<CredentialProviderConfiguration>):The credential provider configurations for the gateway target.
last_synchronized_at(Option<DateTime>):The last synchronization of the target.
metadata_configuration(Option<MetadataConfiguration>):The metadata configuration for HTTP header and query parameter propagation for the retrieved gateway target.
private_endpoint(Option<PrivateEndpoint>):The private endpoint configuration for the gateway target.
private_endpoint_managed_resources(Option<Vec::<ManagedResourceDetails>>):The managed resources created by the gateway for private endpoint connectivity.
authorization_data(Option<AuthorizationData>):OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.
protocol_type(Option<TargetProtocolType>):The protocol type of the gateway target.
- On failure, responds with
SdkError<GetGatewayTargetError>
Source§impl Client
impl Client
Sourcepub fn get_harness(&self) -> GetHarnessFluentBuilder
pub fn get_harness(&self) -> GetHarnessFluentBuilder
Constructs a fluent builder for the GetHarness operation.
- The fluent builder is configurable:
harness_id(impl Into<String>)/set_harness_id(Option<String>):
required: trueThe ID of the harness to retrieve.
- On success, responds with
GetHarnessOutputwith field(s):harness(Option<Harness>):The harness resource.
- On failure, responds with
SdkError<GetHarnessError>
Source§impl Client
impl Client
Sourcepub fn get_memory(&self) -> GetMemoryFluentBuilder
pub fn get_memory(&self) -> GetMemoryFluentBuilder
Constructs a fluent builder for the GetMemory operation.
- The fluent builder is configurable:
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe unique identifier of the memory to retrieve.
view(MemoryView)/set_view(Option<MemoryView>):
required: falseThe level of detail to return for the memory.
- On success, responds with
GetMemoryOutputwith field(s):memory(Option<Memory>):The retrieved AgentCore Memory resource details.
- On failure, responds with
SdkError<GetMemoryError>
Source§impl Client
impl Client
Sourcepub fn get_oauth2_credential_provider(
&self,
) -> GetOauth2CredentialProviderFluentBuilder
pub fn get_oauth2_credential_provider( &self, ) -> GetOauth2CredentialProviderFluentBuilder
Constructs a fluent builder for the GetOauth2CredentialProvider operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the OAuth2 credential provider to retrieve.
- On success, responds with
GetOauth2CredentialProviderOutputwith field(s):client_secret_arn(Option<Secret>):The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager.
client_secret_json_key(Option<String>):The JSON key used to extract the client secret value from the AWS Secrets Manager secret.
client_secret_source(Option<SecretSourceType>):The source type of the client secret. Either
MANAGEDif the secret is managed by the service, orEXTERNALif managed by the user in AWS Secrets Manager.name(String):The name of the OAuth2 credential provider.
credential_provider_arn(String):ARN of the credential provider requested.
credential_provider_vendor(CredentialProviderVendorType):The vendor of the OAuth2 credential provider.
callback_url(Option<String>):Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.
oauth2_provider_config_output(Option<Oauth2ProviderConfigOutput>):The configuration output for the OAuth2 provider.
created_time(DateTime):The timestamp when the OAuth2 credential provider was created.
last_updated_time(DateTime):The timestamp when the OAuth2 credential provider was last updated.
status(Option<Status>):The current status of the OAuth2 credential provider.
failure_reason(Option<String>):The reason for failure if the OAuth2 credential provider is in a failed state.
- On failure, responds with
SdkError<GetOauth2CredentialProviderError>
Source§impl Client
impl Client
Sourcepub fn get_online_evaluation_config(
&self,
) -> GetOnlineEvaluationConfigFluentBuilder
pub fn get_online_evaluation_config( &self, ) -> GetOnlineEvaluationConfigFluentBuilder
Constructs a fluent builder for the GetOnlineEvaluationConfig operation.
- The fluent builder is configurable:
online_evaluation_config_id(impl Into<String>)/set_online_evaluation_config_id(Option<String>):
required: trueThe unique identifier of the online evaluation configuration to retrieve.
- On success, responds with
GetOnlineEvaluationConfigOutputwith field(s):online_evaluation_config_arn(String):The Amazon Resource Name (ARN) of the online evaluation configuration.
online_evaluation_config_id(String):The unique identifier of the online evaluation configuration.
online_evaluation_config_name(String):The name of the online evaluation configuration.
description(Option<String>):The description of the online evaluation configuration.
rule(Option<Rule>):The evaluation rule containing sampling configuration, filters, and session settings.
data_source_config(Option<DataSourceConfig>):The data source configuration specifying CloudWatch log groups and service names to monitor.
evaluators(Vec::<EvaluatorReference>):The list of evaluators applied during online evaluation.
output_config(Option<OutputConfig>):The output configuration specifying where evaluation results are written.
evaluation_execution_role_arn(Option<String>):The Amazon Resource Name (ARN) of the IAM role used for evaluation execution.
status(OnlineEvaluationConfigStatus):The status of the online evaluation configuration.
execution_status(OnlineEvaluationExecutionStatus):The execution status indicating whether the online evaluation is currently running.
created_at(DateTime):The timestamp when the online evaluation configuration was created.
updated_at(DateTime):The timestamp when the online evaluation configuration was last updated.
failure_reason(Option<String>):The reason for failure if the online evaluation configuration execution failed.
- On failure, responds with
SdkError<GetOnlineEvaluationConfigError>
Source§impl Client
impl Client
Sourcepub fn get_payment_connector(&self) -> GetPaymentConnectorFluentBuilder
pub fn get_payment_connector(&self) -> GetPaymentConnectorFluentBuilder
Constructs a fluent builder for the GetPaymentConnector operation.
- The fluent builder is configurable:
payment_manager_id(impl Into<String>)/set_payment_manager_id(Option<String>):
required: trueThe unique identifier of the parent payment manager.
payment_connector_id(impl Into<String>)/set_payment_connector_id(Option<String>):
required: trueThe unique identifier of the payment connector to retrieve.
- On success, responds with
GetPaymentConnectorOutputwith field(s):payment_connector_id(String):The unique identifier of the payment connector.
name(String):The name of the payment connector.
description(Option<String>):The description of the payment connector.
r#type(PaymentConnectorType):The type of the payment connector, which determines the payment provider integration.
credential_provider_configurations(Vec::<CredentialsProviderConfiguration>):The credential provider configurations for the payment connector.
created_at(DateTime):The timestamp when the payment connector was created.
last_updated_at(DateTime):The timestamp when the payment connector was last updated.
status(PaymentConnectorStatus):The current status of the payment connector. Possible values include
CREATING,READY,UPDATING,DELETING,CREATE_FAILED,UPDATE_FAILED, andDELETE_FAILED.
- On failure, responds with
SdkError<GetPaymentConnectorError>
Source§impl Client
impl Client
Sourcepub fn get_payment_credential_provider(
&self,
) -> GetPaymentCredentialProviderFluentBuilder
pub fn get_payment_credential_provider( &self, ) -> GetPaymentCredentialProviderFluentBuilder
Constructs a fluent builder for the GetPaymentCredentialProvider operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the payment credential provider to retrieve.
- On success, responds with
GetPaymentCredentialProviderOutputwith field(s):name(String):The name of the payment credential provider.
credential_provider_arn(String):The Amazon Resource Name (ARN) of the payment credential provider.
credential_provider_vendor(PaymentCredentialProviderVendorType):The vendor type for the payment credential provider.
provider_configuration_output(Option<PaymentProviderConfigurationOutput>):Output configuration (contains secret ARNs, excludes actual secret values).
created_time(DateTime):The timestamp when the payment credential provider was created.
last_updated_time(DateTime):The timestamp when the payment credential provider was last updated.
tags(Option<HashMap::<String, String>>):The tags associated with the payment credential provider.
- On failure, responds with
SdkError<GetPaymentCredentialProviderError>
Source§impl Client
impl Client
Sourcepub fn get_payment_manager(&self) -> GetPaymentManagerFluentBuilder
pub fn get_payment_manager(&self) -> GetPaymentManagerFluentBuilder
Constructs a fluent builder for the GetPaymentManager operation.
- The fluent builder is configurable:
payment_manager_id(impl Into<String>)/set_payment_manager_id(Option<String>):
required: trueThe unique identifier of the payment manager to retrieve.
- On success, responds with
GetPaymentManagerOutputwith field(s):payment_manager_arn(String):The Amazon Resource Name (ARN) of the payment manager.
payment_manager_id(String):The unique identifier of the payment manager.
name(String):The name of the payment manager.
description(Option<String>):The description of the payment manager.
authorizer_type(PaymentsAuthorizerType):The type of authorizer used by the payment manager.
-
CUSTOM_JWT- Authorize with a bearer token. -
AWS_IAM- Authorize with your Amazon Web Services IAM credentials.
-
authorizer_configuration(Option<AuthorizerConfiguration>):Represents inbound authorization configuration options used to authenticate incoming requests.
role_arn(String):The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.
workload_identity_details(Option<WorkloadIdentityDetails>):The information about the workload identity.
created_at(DateTime):The timestamp when the payment manager was created.
last_updated_at(DateTime):The timestamp when the payment manager was last updated.
status(PaymentManagerStatus):The current status of the payment manager. Possible values include
CREATING,READY,UPDATING,DELETING,CREATE_FAILED,UPDATE_FAILED, andDELETE_FAILED.tags(Option<HashMap::<String, String>>):The tags associated with the payment manager.
- On failure, responds with
SdkError<GetPaymentManagerError>
Source§impl Client
impl Client
Sourcepub fn get_policy(&self) -> GetPolicyFluentBuilder
pub fn get_policy(&self) -> GetPolicyFluentBuilder
Constructs a fluent builder for the GetPolicy operation.
- The fluent builder is configurable:
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe identifier of the policy engine that manages the policy to be retrieved.
policy_id(impl Into<String>)/set_policy_id(Option<String>):
required: trueThe unique identifier of the policy to be retrieved. This must be a valid policy ID that exists within the specified policy engine.
- On success, responds with
GetPolicyOutputwith field(s):policy_id(String):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.
name(String):The customer-assigned name of the policy. This is the human-readable identifier that was specified when the policy was created.
policy_engine_id(String):The identifier of the policy engine that manages this policy. This confirms the policy engine context for the retrieved policy.
created_at(DateTime):The timestamp when the policy was originally created.
updated_at(DateTime):The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration.
policy_arn(String):The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.
status(PolicyStatus):The current status of the policy.
definition(Option<PolicyDefinition>):The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.
description(Option<String>):The human-readable description of the policy’s purpose and functionality. This helps administrators understand and manage the policy.
status_reasons(Vec::<String>):Additional information about the policy status. This provides details about any failures or the current state of the policy.
- On failure, responds with
SdkError<GetPolicyError>
Source§impl Client
impl Client
Sourcepub fn get_policy_engine(&self) -> GetPolicyEngineFluentBuilder
pub fn get_policy_engine(&self) -> GetPolicyEngineFluentBuilder
Constructs a fluent builder for the GetPolicyEngine operation.
- The fluent builder is configurable:
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe unique identifier of the policy engine to be retrieved. This must be a valid policy engine ID that exists within the account.
- On success, responds with
GetPolicyEngineOutputwith field(s):policy_engine_id(String):The unique identifier of the retrieved policy engine. This matches the policy engine ID provided in the request and serves as the system identifier.
name(String):The customer-assigned name of the policy engine. This is the human-readable identifier that was specified when the policy engine was created.
created_at(DateTime):The timestamp when the policy engine was originally created.
updated_at(DateTime):The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration.
policy_engine_arn(String):The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.
status(PolicyEngineStatus):The current status of the policy engine.
encryption_key_arn(Option<String>):The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
description(Option<String>):The human-readable description of the policy engine’s purpose and scope. This helps administrators understand the policy engine’s role in governance.
status_reasons(Vec::<String>):Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine.
- On failure, responds with
SdkError<GetPolicyEngineError>
Source§impl Client
impl Client
Sourcepub fn get_policy_engine_summary(&self) -> GetPolicyEngineSummaryFluentBuilder
pub fn get_policy_engine_summary(&self) -> GetPolicyEngineSummaryFluentBuilder
Constructs a fluent builder for the GetPolicyEngineSummary operation.
- The fluent builder is configurable:
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe unique identifier of the policy engine to retrieve the summary for. This must be a valid policy engine ID that exists within the account.
- On success, responds with
GetPolicyEngineSummaryOutputwith field(s):policy_engine_id(String):The unique identifier of the policy engine.
name(String):The customer-assigned name of the policy engine.
created_at(DateTime):The timestamp when the policy engine was originally created.
updated_at(DateTime):The timestamp when the policy engine was last modified.
policy_engine_arn(String):The Amazon Resource Name (ARN) of the policy engine.
status(PolicyEngineStatus):The current status of the policy engine.
encryption_key_arn(Option<String>):The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
- On failure, responds with
SdkError<GetPolicyEngineSummaryError>
Source§impl Client
impl Client
Sourcepub fn get_policy_generation(&self) -> GetPolicyGenerationFluentBuilder
pub fn get_policy_generation(&self) -> GetPolicyGenerationFluentBuilder
Constructs a fluent builder for the GetPolicyGeneration operation.
- The fluent builder is configurable:
policy_generation_id(impl Into<String>)/set_policy_generation_id(Option<String>):
required: trueThe unique identifier of the policy generation request to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call.
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and schema validation.
- On success, responds with
GetPolicyGenerationOutputwith field(s):policy_engine_id(String):The identifier of the policy engine associated with this policy generation. This confirms the policy engine context for the generation operation.
policy_generation_id(String):The unique identifier of the policy generation request. This matches the generation ID provided in the request and serves as the tracking identifier.
name(String):The customer-assigned name for the policy generation request. This helps identify and track generation operations across multiple requests.
policy_generation_arn(String):The Amazon Resource Name (ARN) of the policy generation. This globally unique identifier can be used for tracking, auditing, and cross-service references.
resource(Option<Resource>):The resource information associated with the policy generation. This provides context about the target resources for which the policies are being generated.
created_at(DateTime):The timestamp when the policy generation request was created. This is used for tracking and auditing generation operations and their lifecycle.
updated_at(DateTime):The timestamp when the policy generation was last updated. This tracks the progress of the generation process and any status changes.
status(PolicyGenerationStatus):The current status of the policy generation. This indicates whether the generation is in progress, completed successfully, or failed during processing.
findings(Option<String>):The findings and results from the policy generation process. This includes any issues, recommendations, validation results, or insights from the generated policies.
status_reasons(Vec::<String>):Additional information about the generation status. This provides details about any failures, warnings, or the current state of the generation process.
- On failure, responds with
SdkError<GetPolicyGenerationError>
Source§impl Client
impl Client
Sourcepub fn get_policy_generation_summary(
&self,
) -> GetPolicyGenerationSummaryFluentBuilder
pub fn get_policy_generation_summary( &self, ) -> GetPolicyGenerationSummaryFluentBuilder
Constructs a fluent builder for the GetPolicyGenerationSummary operation.
- The fluent builder is configurable:
policy_generation_id(impl Into<String>)/set_policy_generation_id(Option<String>):
required: trueThe unique identifier of the policy generation request to retrieve the summary for.
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe identifier of the policy engine associated with the policy generation request.
- On success, responds with
GetPolicyGenerationSummaryOutputwith field(s):policy_engine_id(String):The identifier of the policy engine associated with this policy generation.
policy_generation_id(String):The unique identifier of the policy generation request.
name(String):The customer-assigned name for the policy generation request.
policy_generation_arn(String):The Amazon Resource Name (ARN) of the policy generation request.
resource(Option<Resource>):The resource information associated with the policy generation.
created_at(DateTime):The timestamp when the policy generation request was created.
updated_at(DateTime):The timestamp when the policy generation was last updated.
status(PolicyGenerationStatus):The current status of the policy generation request.
findings(Option<String>):The findings from the policy generation process, if available.
- On failure, responds with
SdkError<GetPolicyGenerationSummaryError>
Source§impl Client
impl Client
Sourcepub fn get_policy_summary(&self) -> GetPolicySummaryFluentBuilder
pub fn get_policy_summary(&self) -> GetPolicySummaryFluentBuilder
Constructs a fluent builder for the GetPolicySummary operation.
- The fluent builder is configurable:
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe identifier of the policy engine that manages the policy to retrieve the summary for.
policy_id(impl Into<String>)/set_policy_id(Option<String>):
required: trueThe unique identifier of the policy to retrieve the summary for. This must be a valid policy ID that exists within the specified policy engine.
- On success, responds with
GetPolicySummaryOutputwith field(s):policy_id(String):The unique identifier of the policy.
name(String):The customer-assigned name of the policy.
policy_engine_id(String):The identifier of the policy engine that manages this policy.
created_at(DateTime):The timestamp when the policy was originally created.
updated_at(DateTime):The timestamp when the policy was last modified.
policy_arn(String):The Amazon Resource Name (ARN) of the policy.
status(PolicyStatus):The current status of the policy.
- On failure, responds with
SdkError<GetPolicySummaryError>
Source§impl Client
impl Client
Sourcepub fn get_registry(&self) -> GetRegistryFluentBuilder
pub fn get_registry(&self) -> GetRegistryFluentBuilder
Constructs a fluent builder for the GetRegistry operation.
- The fluent builder is configurable:
registry_id(impl Into<String>)/set_registry_id(Option<String>):
required: trueThe identifier of the registry to retrieve. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
- On success, responds with
GetRegistryOutputwith field(s):name(String):The name of the registry.
description(Option<String>):The description of the registry.
registry_id(String):The unique identifier of the registry.
registry_arn(String):The Amazon Resource Name (ARN) of the registry.
authorizer_type(Option<RegistryAuthorizerType>):The type of authorizer used by the registry. This controls the authorization method for the Search and Invoke APIs used by consumers.
-
CUSTOM_JWT- Authorize with a bearer token. -
AWS_IAM- Authorize with your Amazon Web Services IAM credentials.
-
authorizer_configuration(Option<AuthorizerConfiguration>):The authorizer configuration for the registry. For details, see the
AuthorizerConfigurationdata type.approval_configuration(Option<ApprovalConfiguration>):The approval configuration for registry records. For details, see the
ApprovalConfigurationdata type.status(RegistryStatus):The current status of the registry. Possible values include
CREATING,READY,UPDATING,CREATE_FAILED,UPDATE_FAILED,DELETING, andDELETE_FAILED.status_reason(Option<String>):The reason for the current status, typically set when the status is a failure state.
created_at(DateTime):The timestamp when the registry was created.
updated_at(DateTime):The timestamp when the registry was last updated.
- On failure, responds with
SdkError<GetRegistryError>
Source§impl Client
impl Client
Sourcepub fn get_registry_record(&self) -> GetRegistryRecordFluentBuilder
pub fn get_registry_record(&self) -> GetRegistryRecordFluentBuilder
Constructs a fluent builder for the GetRegistryRecord operation.
- The fluent builder is configurable:
registry_id(impl Into<String>)/set_registry_id(Option<String>):
required: trueThe identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
record_id(impl Into<String>)/set_record_id(Option<String>):
required: trueThe identifier of the registry record to retrieve. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
- On success, responds with
GetRegistryRecordOutputwith field(s):registry_arn(String):The Amazon Resource Name (ARN) of the registry that contains the record.
record_arn(String):The Amazon Resource Name (ARN) of the registry record.
record_id(String):The unique identifier of the registry record.
name(String):The name of the registry record.
description(Option<String>):The description of the registry record.
descriptor_type(DescriptorType):The descriptor type of the registry record. Possible values are
MCP,A2A,CUSTOM, andAGENT_SKILLS.descriptors(Option<Descriptors>):The descriptor-type-specific configuration containing the resource schema and metadata. For details, see the
Descriptorsdata type.record_version(Option<String>):The version of the registry record.
status(RegistryRecordStatus):The current status of the registry record. Possible values include
CREATING,DRAFT,APPROVED,PENDING_APPROVAL,REJECTED,DEPRECATED,UPDATING,CREATE_FAILED, andUPDATE_FAILED. A record transitions fromCREATINGtoDRAFT, then toPENDING_APPROVAL(viaSubmitRegistryRecordForApproval), and finally toAPPROVEDupon approval.created_at(DateTime):The timestamp when the registry record was created.
updated_at(DateTime):The timestamp when the registry record was last updated.
status_reason(Option<String>):The reason for the current status, typically set when the status is a failure state.
synchronization_type(Option<SynchronizationType>):The type of synchronization used for this record.
synchronization_configuration(Option<SynchronizationConfiguration>):The configuration for synchronizing registry record metadata from an external source.
- On failure, responds with
SdkError<GetRegistryRecordError>
Source§impl Client
impl Client
Sourcepub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder
pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder
Constructs a fluent builder for the GetResourcePolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource for which to retrieve the resource policy.
- On success, responds with
GetResourcePolicyOutputwith field(s):policy(Option<String>):The resource policy associated with the specified resource.
- On failure, responds with
SdkError<GetResourcePolicyError>
Source§impl Client
impl Client
Sourcepub fn get_token_vault(&self) -> GetTokenVaultFluentBuilder
pub fn get_token_vault(&self) -> GetTokenVaultFluentBuilder
Constructs a fluent builder for the GetTokenVault operation.
- The fluent builder is configurable:
token_vault_id(impl Into<String>)/set_token_vault_id(Option<String>):
required: falseThe unique identifier of the token vault to retrieve.
- On success, responds with
GetTokenVaultOutputwith field(s):token_vault_id(String):The ID of the token vault.
kms_configuration(Option<KmsConfiguration>):The KMS configuration for the token vault.
last_modified_date(DateTime):The timestamp when the token vault was last modified.
- On failure, responds with
SdkError<GetTokenVaultError>
Source§impl Client
impl Client
Sourcepub fn get_workload_identity(&self) -> GetWorkloadIdentityFluentBuilder
pub fn get_workload_identity(&self) -> GetWorkloadIdentityFluentBuilder
Constructs a fluent builder for the GetWorkloadIdentity operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the workload identity to retrieve.
- On success, responds with
GetWorkloadIdentityOutputwith field(s):name(String):The name of the workload identity.
workload_identity_arn(String):The Amazon Resource Name (ARN) of the workload identity.
allowed_resource_oauth2_return_urls(Option<Vec::<String>>):The list of allowed OAuth2 return URLs for resources associated with this workload identity.
created_time(DateTime):The timestamp when the workload identity was created.
last_updated_time(DateTime):The timestamp when the workload identity was last updated.
- On failure, responds with
SdkError<GetWorkloadIdentityError>
Source§impl Client
impl Client
Sourcepub fn list_agent_runtime_endpoints(
&self,
) -> ListAgentRuntimeEndpointsFluentBuilder
pub fn list_agent_runtime_endpoints( &self, ) -> ListAgentRuntimeEndpointsFluentBuilder
Constructs a fluent builder for the ListAgentRuntimeEndpoints operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
agent_runtime_id(impl Into<String>)/set_agent_runtime_id(Option<String>):
required: trueThe unique identifier of the AgentCore Runtime to list endpoints for.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA token to retrieve the next page of results.
- On success, responds with
ListAgentRuntimeEndpointsOutputwith field(s):runtime_endpoints(Vec::<AgentRuntimeEndpoint>):The list of AgentCore Runtime endpoints.
next_token(Option<String>):A token to retrieve the next page of results.
- On failure, responds with
SdkError<ListAgentRuntimeEndpointsError>
Source§impl Client
impl Client
Sourcepub fn list_agent_runtime_versions(
&self,
) -> ListAgentRuntimeVersionsFluentBuilder
pub fn list_agent_runtime_versions( &self, ) -> ListAgentRuntimeVersionsFluentBuilder
Constructs a fluent builder for the ListAgentRuntimeVersions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
agent_runtime_id(impl Into<String>)/set_agent_runtime_id(Option<String>):
required: trueThe unique identifier of the AgentCore Runtime to list versions for.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA token to retrieve the next page of results.
- On success, responds with
ListAgentRuntimeVersionsOutputwith field(s):agent_runtimes(Vec::<AgentRuntime>):The list of AgentCore Runtime versions.
next_token(Option<String>):A token to retrieve the next page of results.
- On failure, responds with
SdkError<ListAgentRuntimeVersionsError>
Source§impl Client
impl Client
Sourcepub fn list_agent_runtimes(&self) -> ListAgentRuntimesFluentBuilder
pub fn list_agent_runtimes(&self) -> ListAgentRuntimesFluentBuilder
Constructs a fluent builder for the ListAgentRuntimes operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA token to retrieve the next page of results.
- On success, responds with
ListAgentRuntimesOutputwith field(s):agent_runtimes(Vec::<AgentRuntime>):The list of AgentCore Runtime resources.
next_token(Option<String>):A token to retrieve the next page of results.
- On failure, responds with
SdkError<ListAgentRuntimesError>
Source§impl Client
impl Client
Sourcepub fn list_api_key_credential_providers(
&self,
) -> ListApiKeyCredentialProvidersFluentBuilder
pub fn list_api_key_credential_providers( &self, ) -> ListApiKeyCredentialProvidersFluentBuilder
Constructs a fluent builder for the ListApiKeyCredentialProviders operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falsePagination token.
max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return.
- On success, responds with
ListApiKeyCredentialProvidersOutputwith field(s):credential_providers(Vec::<ApiKeyCredentialProviderItem>):The list of API key credential providers.
next_token(Option<String>):Pagination token for the next page of results.
- On failure, responds with
SdkError<ListApiKeyCredentialProvidersError>
Source§impl Client
impl Client
Sourcepub fn list_browser_profiles(&self) -> ListBrowserProfilesFluentBuilder
pub fn list_browser_profiles(&self) -> ListBrowserProfilesFluentBuilder
Constructs a fluent builder for the ListBrowserProfiles operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA token to retrieve the next page of results.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe name of the browser profile to filter results by.
- On success, responds with
ListBrowserProfilesOutputwith field(s):profile_summaries(Vec::<BrowserProfileSummary>):The list of browser profile summaries.
next_token(Option<String>):A token to retrieve the next page of results.
- On failure, responds with
SdkError<ListBrowserProfilesError>
Source§impl Client
impl Client
Sourcepub fn list_browsers(&self) -> ListBrowsersFluentBuilder
pub fn list_browsers(&self) -> ListBrowsersFluentBuilder
Constructs a fluent builder for the ListBrowsers operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. The default value is 10. The maximum value is 50.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
r#type(ResourceType)/set_type(Option<ResourceType>):
required: falseThe type of browsers to list. If not specified, all browser types are returned.
- On success, responds with
ListBrowsersOutputwith field(s):browser_summaries(Vec::<BrowserSummary>):The list of browser summaries.
next_token(Option<String>):A token to retrieve the next page of results.
- On failure, responds with
SdkError<ListBrowsersError>
Source§impl Client
impl Client
Sourcepub fn list_code_interpreters(&self) -> ListCodeInterpretersFluentBuilder
pub fn list_code_interpreters(&self) -> ListCodeInterpretersFluentBuilder
Constructs a fluent builder for the ListCodeInterpreters operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA token to retrieve the next page of results.
r#type(ResourceType)/set_type(Option<ResourceType>):
required: falseThe type of code interpreters to list.
- On success, responds with
ListCodeInterpretersOutputwith field(s):code_interpreter_summaries(Vec::<CodeInterpreterSummary>):The list of code interpreter summaries.
next_token(Option<String>):A token to retrieve the next page of results.
- On failure, responds with
SdkError<ListCodeInterpretersError>
Source§impl Client
impl Client
Sourcepub fn list_configuration_bundle_versions(
&self,
) -> ListConfigurationBundleVersionsFluentBuilder
pub fn list_configuration_bundle_versions( &self, ) -> ListConfigurationBundleVersionsFluentBuilder
Constructs a fluent builder for the ListConfigurationBundleVersions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bundle_id(impl Into<String>)/set_bundle_id(Option<String>):
required: trueThe unique identifier of the configuration bundle to list versions for.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseIf the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.filter(VersionFilter)/set_filter(Option<VersionFilter>):
required: falseAn optional filter for listing versions, including branch name, creation source, and whether to return only the latest version per branch.
- On success, responds with
ListConfigurationBundleVersionsOutputwith field(s):versions(Vec::<ConfigurationBundleVersionSummary>):The list of configuration bundle version summaries.
next_token(Option<String>):If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.
- On failure, responds with
SdkError<ListConfigurationBundleVersionsError>
Source§impl Client
impl Client
Sourcepub fn list_configuration_bundles(
&self,
) -> ListConfigurationBundlesFluentBuilder
pub fn list_configuration_bundles( &self, ) -> ListConfigurationBundlesFluentBuilder
Constructs a fluent builder for the ListConfigurationBundles operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseIf the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.
- On success, responds with
ListConfigurationBundlesOutputwith field(s):bundles(Vec::<ConfigurationBundleSummary>):The list of configuration bundle summaries.
next_token(Option<String>):If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.
- On failure, responds with
SdkError<ListConfigurationBundlesError>
Source§impl Client
impl Client
Sourcepub fn list_dataset_examples(&self) -> ListDatasetExamplesFluentBuilder
pub fn list_dataset_examples(&self) -> ListDatasetExamplesFluentBuilder
Constructs a fluent builder for the ListDatasetExamples operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
dataset_id(impl Into<String>)/set_dataset_id(Option<String>):
required: trueThe unique identifier of the dataset.
dataset_version(impl Into<String>)/set_dataset_version(Option<String>):
required: false
Version to paginate: “DRAFT” or a version number. Defaults to DRAFT if absent. Only used on the first request (when nextToken is absent). For subsequent pages, the version is extracted from the nextToken and this parameter is ignored.max_results(i32)/set_max_results(Option<i32>):
required: false
Maximum number of examples to return per page. Default: 1000. Min: 1, max: 1000. Response size is validated against 5 MB limit after reading. For bulk access to all examples, use thedownloadUrlfield from GetDataset.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next page of results.
- On success, responds with
ListDatasetExamplesOutputwith field(s):dataset_arn(String):The Amazon Resource Name (ARN) of the dataset.
dataset_id(String):The unique identifier of the dataset.
dataset_version(String): The version returned.examples(Vec::<Document>): Paginated example content. Each element is a JSON object containing at least anexampleIdfield plus the schema-specific content fields.next_token(Option<String>):The token for the next page of results, or null if there are no more results.
- On failure, responds with
SdkError<ListDatasetExamplesError>
Source§impl Client
impl Client
Sourcepub fn list_dataset_versions(&self) -> ListDatasetVersionsFluentBuilder
pub fn list_dataset_versions(&self) -> ListDatasetVersionsFluentBuilder
Constructs a fluent builder for the ListDatasetVersions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
dataset_id(impl Into<String>)/set_dataset_id(Option<String>):
required: trueThe unique identifier of the dataset.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next page of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of versions to return per page.
- On success, responds with
ListDatasetVersionsOutputwith field(s):versions(Vec::<DatasetVersionSummary>):The list of published dataset versions.
next_token(Option<String>):The token for the next page of results, or null if there are no more results.
- On failure, responds with
SdkError<ListDatasetVersionsError>
Source§impl Client
impl Client
Sourcepub fn list_datasets(&self) -> ListDatasetsFluentBuilder
pub fn list_datasets(&self) -> ListDatasetsFluentBuilder
Constructs a fluent builder for the ListDatasets operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next page of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of datasets to return per page.
- On success, responds with
ListDatasetsOutputwith field(s):datasets(Vec::<DatasetSummary>):The list of datasets.
next_token(Option<String>):The token for the next page of results, or null if there are no more results.
- On failure, responds with
SdkError<ListDatasetsError>
Source§impl Client
impl Client
Sourcepub fn list_evaluators(&self) -> ListEvaluatorsFluentBuilder
pub fn list_evaluators(&self) -> ListEvaluatorsFluentBuilder
Constructs a fluent builder for the ListEvaluators operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe pagination token from a previous request to retrieve the next page of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of evaluators to return in a single response.
- On success, responds with
ListEvaluatorsOutputwith field(s):evaluators(Vec::<EvaluatorSummary>):The list of evaluator summaries containing basic information about each evaluator.
next_token(Option<String>):The pagination token to use in a subsequent request to retrieve the next page of results.
- On failure, responds with
SdkError<ListEvaluatorsError>
Source§impl Client
impl Client
Sourcepub fn list_gateway_rules(&self) -> ListGatewayRulesFluentBuilder
pub fn list_gateway_rules(&self) -> ListGatewayRulesFluentBuilder
Constructs a fluent builder for the ListGatewayRules operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe identifier of the gateway to list rules for.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe pagination token from a previous request.
- On success, responds with
ListGatewayRulesOutputwith field(s):gateway_rules(Vec::<GatewayRuleDetail>):The list of gateway rules.
next_token(Option<String>):The pagination token to use in a subsequent request.
- On failure, responds with
SdkError<ListGatewayRulesError>
Source§impl Client
impl Client
Sourcepub fn list_gateway_targets(&self) -> ListGatewayTargetsFluentBuilder
pub fn list_gateway_targets(&self) -> ListGatewayTargetsFluentBuilder
Constructs a fluent builder for the ListGatewayTargets operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe identifier of the gateway to list targets for.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseIf the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.
- On success, responds with
ListGatewayTargetsOutputwith field(s):items(Vec::<TargetSummary>):The list of gateway target summaries.
next_token(Option<String>):If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.
- On failure, responds with
SdkError<ListGatewayTargetsError>
Source§impl Client
impl Client
Sourcepub fn list_gateways(&self) -> ListGatewaysFluentBuilder
pub fn list_gateways(&self) -> ListGatewaysFluentBuilder
Constructs a fluent builder for the ListGateways operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseIf the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.
- On success, responds with
ListGatewaysOutputwith field(s):items(Vec::<GatewaySummary>):The list of gateway summaries.
next_token(Option<String>):If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.
- On failure, responds with
SdkError<ListGatewaysError>
Source§impl Client
impl Client
Sourcepub fn list_harnesses(&self) -> ListHarnessesFluentBuilder
pub fn list_harnesses(&self) -> ListHarnessesFluentBuilder
Constructs a fluent builder for the ListHarnesses operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results.
- On success, responds with
ListHarnessesOutputwith field(s):harnesses(Vec::<HarnessSummary>):The list of harness summaries.
next_token(Option<String>):The token for the next set of results.
- On failure, responds with
SdkError<ListHarnessesError>
Source§impl Client
impl Client
Sourcepub fn list_memories(&self) -> ListMemoriesFluentBuilder
pub fn list_memories(&self) -> ListMemoriesFluentBuilder
Constructs a fluent builder for the ListMemories operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. The default value is 10. The maximum value is 50.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- On success, responds with
ListMemoriesOutputwith field(s):memories(Vec::<MemorySummary>):The list of AgentCore Memory resource summaries.
next_token(Option<String>):A token to retrieve the next page of results.
- On failure, responds with
SdkError<ListMemoriesError>
Source§impl Client
impl Client
Sourcepub fn list_oauth2_credential_providers(
&self,
) -> ListOauth2CredentialProvidersFluentBuilder
pub fn list_oauth2_credential_providers( &self, ) -> ListOauth2CredentialProvidersFluentBuilder
Constructs a fluent builder for the ListOauth2CredentialProviders operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falsePagination token.
max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return.
- On success, responds with
ListOauth2CredentialProvidersOutputwith field(s):credential_providers(Vec::<Oauth2CredentialProviderItem>):The list of OAuth2 credential providers.
next_token(Option<String>):Pagination token for the next page of results.
- On failure, responds with
SdkError<ListOauth2CredentialProvidersError>
Source§impl Client
impl Client
Sourcepub fn list_online_evaluation_configs(
&self,
) -> ListOnlineEvaluationConfigsFluentBuilder
pub fn list_online_evaluation_configs( &self, ) -> ListOnlineEvaluationConfigsFluentBuilder
Constructs a fluent builder for the ListOnlineEvaluationConfigs operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe pagination token from a previous request to retrieve the next page of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of online evaluation configurations to return in a single response.
- On success, responds with
ListOnlineEvaluationConfigsOutputwith field(s):online_evaluation_configs(Vec::<OnlineEvaluationConfigSummary>):The list of online evaluation configuration summaries containing basic information about each configuration.
next_token(Option<String>):The pagination token to use in a subsequent request to retrieve the next page of results.
- On failure, responds with
SdkError<ListOnlineEvaluationConfigsError>
Source§impl Client
impl Client
Sourcepub fn list_payment_connectors(&self) -> ListPaymentConnectorsFluentBuilder
pub fn list_payment_connectors(&self) -> ListPaymentConnectorsFluentBuilder
Constructs a fluent builder for the ListPaymentConnectors operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
payment_manager_id(impl Into<String>)/set_payment_manager_id(Option<String>):
required: trueThe unique identifier of the payment manager whose connectors to list.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseIf the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.
- On success, responds with
ListPaymentConnectorsOutputwith field(s):payment_connectors(Vec::<PaymentConnectorSummary>):The list of payment connector summaries. For details about the fields in each summary, see the
PaymentConnectorSummarydata type.next_token(Option<String>):If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.
- On failure, responds with
SdkError<ListPaymentConnectorsError>
Source§impl Client
impl Client
Sourcepub fn list_payment_credential_providers(
&self,
) -> ListPaymentCredentialProvidersFluentBuilder
pub fn list_payment_credential_providers( &self, ) -> ListPaymentCredentialProvidersFluentBuilder
Constructs a fluent builder for the ListPaymentCredentialProviders operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falsePagination token.
max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return.
- On success, responds with
ListPaymentCredentialProvidersOutputwith field(s):credential_providers(Vec::<PaymentCredentialProviderItem>):The list of payment credential providers.
next_token(Option<String>):Pagination token for the next page of results.
- On failure, responds with
SdkError<ListPaymentCredentialProvidersError>
Source§impl Client
impl Client
Sourcepub fn list_payment_managers(&self) -> ListPaymentManagersFluentBuilder
pub fn list_payment_managers(&self) -> ListPaymentManagersFluentBuilder
Constructs a fluent builder for the ListPaymentManagers operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseIf the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.
- On success, responds with
ListPaymentManagersOutputwith field(s):payment_managers(Vec::<PaymentManagerSummary>):The list of payment manager summaries. For details about the fields in each summary, see the
PaymentManagerSummarydata type.next_token(Option<String>):If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.
- On failure, responds with
SdkError<ListPaymentManagersError>
Source§impl Client
impl Client
Sourcepub fn list_policies(&self) -> ListPoliciesFluentBuilder
pub fn list_policies(&self) -> ListPoliciesFluentBuilder
Constructs a fluent builder for the ListPolicies operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token returned from a previous ListPolicies call. Use this token to retrieve the next page of results when the response is paginated.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe 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.
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe identifier of the policy engine whose policies to retrieve.
target_resource_scope(impl Into<String>)/set_target_resource_scope(Option<String>):
required: falseOptional 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.
- On success, responds with
ListPoliciesOutputwith field(s):policies(Vec::<Policy>):An array of policy objects that match the specified criteria. Each policy object contains the policy metadata, status, and key identifiers for further operations.
next_token(Option<String>):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.
- On failure, responds with
SdkError<ListPoliciesError>
Source§impl Client
impl Client
Sourcepub fn list_policy_engine_summaries(
&self,
) -> ListPolicyEngineSummariesFluentBuilder
pub fn list_policy_engine_summaries( &self, ) -> ListPolicyEngineSummariesFluentBuilder
Constructs a fluent builder for the ListPolicyEngineSummaries operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token returned from a previous ListPolicyEngineSummaries call. Use this token to retrieve the next page of results when the response is paginated.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of policy engine summaries to return in a single response.
- On success, responds with
ListPolicyEngineSummariesOutputwith field(s):policy_engines(Vec::<PolicyEngineSummary>):An array of policy engine summary objects that exist in the account. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.
next_token(Option<String>):A pagination token that can be used in subsequent ListPolicyEngineSummaries calls to retrieve additional results. This token is only present when there are more results available.
- On failure, responds with
SdkError<ListPolicyEngineSummariesError>
Source§impl Client
impl Client
Sourcepub fn list_policy_engines(&self) -> ListPolicyEnginesFluentBuilder
pub fn list_policy_engines(&self) -> ListPolicyEnginesFluentBuilder
Constructs a fluent builder for the ListPolicyEngines operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token returned from a previous ListPolicyEngines call. Use this token to retrieve the next page of results when the response is paginated.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of policy engines to return in a single response. If not specified, the default is 10 policy engines per page, with a maximum of 100 per page.
- On success, responds with
ListPolicyEnginesOutputwith field(s):policy_engines(Vec::<PolicyEngine>):An array of policy engine objects that exist in the account. Each policy engine object contains the engine metadata, status, and key identifiers for further operations.
next_token(Option<String>):A pagination token that can be used in subsequent ListPolicyEngines calls to retrieve additional results. This token is only present when there are more results available.
- On failure, responds with
SdkError<ListPolicyEnginesError>
Source§impl Client
impl Client
Sourcepub fn list_policy_generation_assets(
&self,
) -> ListPolicyGenerationAssetsFluentBuilder
pub fn list_policy_generation_assets( &self, ) -> ListPolicyGenerationAssetsFluentBuilder
Constructs a fluent builder for the ListPolicyGenerationAssets operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
policy_generation_id(impl Into<String>)/set_policy_generation_id(Option<String>):
required: trueThe unique identifier of the policy generation request whose assets are to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call that has completed processing.
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe 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.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token returned from a previous ListPolicyGenerationAssets call. Use this token to retrieve the next page of assets when the response is paginated due to large numbers of generated policy options.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe 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.
- On success, responds with
ListPolicyGenerationAssetsOutputwith field(s):policy_generation_assets(Option<Vec::<PolicyGenerationAsset>>):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.
next_token(Option<String>):A pagination token that can be used in subsequent ListPolicyGenerationAssets calls to retrieve additional assets. This token is only present when there are more generated policy assets available beyond the current response.
- On failure, responds with
SdkError<ListPolicyGenerationAssetsError>
Source§impl Client
impl Client
Sourcepub fn list_policy_generation_summaries(
&self,
) -> ListPolicyGenerationSummariesFluentBuilder
pub fn list_policy_generation_summaries( &self, ) -> ListPolicyGenerationSummariesFluentBuilder
Constructs a fluent builder for the ListPolicyGenerationSummaries operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token returned from a previous ListPolicyGenerationSummaries call. Use this token to retrieve the next page of results when the response is paginated.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of policy generation summaries to return in a single response.
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe identifier of the policy engine whose policy generation summaries to retrieve.
- On success, responds with
ListPolicyGenerationSummariesOutputwith field(s):policy_generations(Vec::<PolicyGenerationSummary>):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.
next_token(Option<String>):A pagination token that can be used in subsequent ListPolicyGenerationSummaries calls to retrieve additional results. This token is only present when there are more results available.
- On failure, responds with
SdkError<ListPolicyGenerationSummariesError>
Source§impl Client
impl Client
Sourcepub fn list_policy_generations(&self) -> ListPolicyGenerationsFluentBuilder
pub fn list_policy_generations(&self) -> ListPolicyGenerationsFluentBuilder
Constructs a fluent builder for the ListPolicyGenerations operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token for retrieving additional policy generations when results are paginated.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of policy generations to return in a single response.
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe identifier of the policy engine whose policy generations to retrieve.
- On success, responds with
ListPolicyGenerationsOutputwith field(s):policy_generations(Vec::<PolicyGeneration>):An array of policy generation objects that match the specified criteria.
next_token(Option<String>):A pagination token for retrieving additional policy generations if more results are available.
- On failure, responds with
SdkError<ListPolicyGenerationsError>
Source§impl Client
impl Client
Sourcepub fn list_policy_summaries(&self) -> ListPolicySummariesFluentBuilder
pub fn list_policy_summaries(&self) -> ListPolicySummariesFluentBuilder
Constructs a fluent builder for the ListPolicySummaries operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA pagination token returned from a previous ListPolicySummaries call. Use this token to retrieve the next page of results when the response is paginated.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of policy summaries to return in a single response.
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe identifier of the policy engine whose policy summaries to retrieve.
target_resource_scope(impl Into<String>)/set_target_resource_scope(Option<String>):
required: falseOptional 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.
- On success, responds with
ListPolicySummariesOutputwith field(s):policies(Vec::<PolicySummary>):An array of policy summary objects that match the specified criteria. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.
next_token(Option<String>):A pagination token that can be used in subsequent ListPolicySummaries calls to retrieve additional results. This token is only present when there are more results available.
- On failure, responds with
SdkError<ListPolicySummariesError>
Source§impl Client
impl Client
Sourcepub fn list_registries(&self) -> ListRegistriesFluentBuilder
pub fn list_registries(&self) -> ListRegistriesFluentBuilder
Constructs a fluent builder for the ListRegistries operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseIf the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.status(RegistryStatus)/set_status(Option<RegistryStatus>):
required: falseFilter registries by their current status. Possible values include
CREATING,READY,UPDATING,CREATE_FAILED,UPDATE_FAILED,DELETING, andDELETE_FAILED.authorizer_type(RegistryAuthorizerType)/set_authorizer_type(Option<RegistryAuthorizerType>):
required: falseFilter registries by their authorizer type. Possible values are
CUSTOM_JWTandAWS_IAM. For more information about authorizer types, see theRegistryAuthorizerTypeenum.
- On success, responds with
ListRegistriesOutputwith field(s):registries(Vec::<RegistrySummary>):The list of registry summaries. For details about the fields in each summary, see the
RegistrySummarydata type.next_token(Option<String>):If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.
- On failure, responds with
SdkError<ListRegistriesError>
Source§impl Client
impl Client
Sourcepub fn list_registry_records(&self) -> ListRegistryRecordsFluentBuilder
pub fn list_registry_records(&self) -> ListRegistryRecordsFluentBuilder
Constructs a fluent builder for the ListRegistryRecords operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
registry_id(impl Into<String>)/set_registry_id(Option<String>):
required: trueThe identifier of the registry to list records from. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseIf the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.name(impl Into<String>)/set_name(Option<String>):
required: falseFilter registry records by name.
status(RegistryRecordStatus)/set_status(Option<RegistryRecordStatus>):
required: falseFilter registry records by their current status. Possible values include
CREATING,DRAFT,APPROVED,PENDING_APPROVAL,REJECTED,DEPRECATED,UPDATING,CREATE_FAILED, andUPDATE_FAILED.descriptor_type(DescriptorType)/set_descriptor_type(Option<DescriptorType>):
required: falseFilter registry records by their descriptor type. Possible values are
MCP,A2A,CUSTOM, andAGENT_SKILLS.
- On success, responds with
ListRegistryRecordsOutputwith field(s):registry_records(Vec::<RegistryRecordSummary>):The list of registry record summaries. For details about the fields in each summary, see the
RegistryRecordSummarydata type.next_token(Option<String>):If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.
- On failure, responds with
SdkError<ListRegistryRecordsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource for which you want to list tags.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<HashMap::<String, String>>):The tags associated with the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn list_workload_identities(&self) -> ListWorkloadIdentitiesFluentBuilder
pub fn list_workload_identities(&self) -> ListWorkloadIdentitiesFluentBuilder
Constructs a fluent builder for the ListWorkloadIdentities operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falsePagination token.
max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return.
- On success, responds with
ListWorkloadIdentitiesOutputwith field(s):workload_identities(Vec::<WorkloadIdentityType>):The list of workload identities.
next_token(Option<String>):Pagination token for the next page of results.
- On failure, responds with
SdkError<ListWorkloadIdentitiesError>
Source§impl Client
impl Client
Sourcepub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder
pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder
Constructs a fluent builder for the PutResourcePolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource for which to create or update the resource policy.
policy(impl Into<String>)/set_policy(Option<String>):
required: trueThe resource policy to create or update.
- On success, responds with
PutResourcePolicyOutputwith field(s):policy(String):The resource policy that was created or updated.
- On failure, responds with
SdkError<PutResourcePolicyError>
Source§impl Client
impl Client
Sourcepub fn set_token_vault_cmk(&self) -> SetTokenVaultCMKFluentBuilder
pub fn set_token_vault_cmk(&self) -> SetTokenVaultCMKFluentBuilder
Constructs a fluent builder for the SetTokenVaultCMK operation.
- The fluent builder is configurable:
token_vault_id(impl Into<String>)/set_token_vault_id(Option<String>):
required: falseThe unique identifier of the token vault to update.
kms_configuration(KmsConfiguration)/set_kms_configuration(Option<KmsConfiguration>):
required: trueThe KMS configuration for the token vault, including the key type and KMS key ARN.
- On success, responds with
SetTokenVaultCmkOutputwith field(s):token_vault_id(String):The ID of the token vault.
kms_configuration(Option<KmsConfiguration>):The KMS configuration for the token vault.
last_modified_date(DateTime):The timestamp when the token vault was last modified.
- On failure, responds with
SdkError<SetTokenVaultCMKError>
Source§impl Client
impl Client
Sourcepub fn start_policy_generation(&self) -> StartPolicyGenerationFluentBuilder
pub fn start_policy_generation(&self) -> StartPolicyGenerationFluentBuilder
Constructs a fluent builder for the StartPolicyGeneration operation.
- The fluent builder is configurable:
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe 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.
resource(Resource)/set_resource(Option<Resource>):
required: trueThe resource information that provides context for policy generation. This helps the AI understand the target resources and generate appropriate access control rules.
content(Content)/set_content(Option<Content>):
required: trueThe 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.
name(impl Into<String>)/set_name(Option<String>):
required: trueA customer-assigned name for the policy generation request. This helps track and identify generation operations, especially when running multiple generations simultaneously.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA 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.
- On success, responds with
StartPolicyGenerationOutputwith field(s):policy_engine_id(String):The identifier of the policy engine associated with the started policy generation.
policy_generation_id(String):The unique identifier assigned to the policy generation request for tracking progress.
name(String):The customer-assigned name for the policy generation request.
policy_generation_arn(String):The ARN of the created policy generation request.
resource(Option<Resource>):The resource information associated with the policy generation request.
created_at(DateTime):The timestamp when the policy generation request was created.
updated_at(DateTime):The timestamp when the policy generation was last updated.
status(PolicyGenerationStatus):The initial status of the policy generation request.
findings(Option<String>):Initial findings from the policy generation process.
status_reasons(Vec::<String>):Additional information about the generation status.
- On failure, responds with
SdkError<StartPolicyGenerationError>
Source§impl Client
impl Client
Sourcepub fn submit_registry_record_for_approval(
&self,
) -> SubmitRegistryRecordForApprovalFluentBuilder
pub fn submit_registry_record_for_approval( &self, ) -> SubmitRegistryRecordForApprovalFluentBuilder
Constructs a fluent builder for the SubmitRegistryRecordForApproval operation.
- The fluent builder is configurable:
registry_id(impl Into<String>)/set_registry_id(Option<String>):
required: trueThe identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
record_id(impl Into<String>)/set_record_id(Option<String>):
required: trueThe identifier of the registry record to submit for approval. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
- On success, responds with
SubmitRegistryRecordForApprovalOutputwith field(s):registry_arn(String):The Amazon Resource Name (ARN) of the registry that contains the record.
record_arn(String):The Amazon Resource Name (ARN) of the registry record.
record_id(String):The unique identifier of the registry record.
status(RegistryRecordStatus):The resulting status of the registry record after submission.
updated_at(DateTime):The timestamp when the record was last updated.
- On failure, responds with
SdkError<SubmitRegistryRecordForApprovalError>
Source§impl Client
impl Client
Sourcepub fn synchronize_gateway_targets(
&self,
) -> SynchronizeGatewayTargetsFluentBuilder
pub fn synchronize_gateway_targets( &self, ) -> SynchronizeGatewayTargetsFluentBuilder
Constructs a fluent builder for the SynchronizeGatewayTargets operation.
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe gateway Identifier.
target_id_list(impl Into<String>)/set_target_id_list(Option<Vec::<String>>):
required: trueThe target ID list.
- On success, responds with
SynchronizeGatewayTargetsOutputwith field(s):targets(Option<Vec::<GatewayTarget>>):The gateway targets for synchronization.
- On failure, responds with
SdkError<SynchronizeGatewayTargetsError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource that you want to tag.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: trueThe tags to add to the resource. A tag is a key-value pair.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource that you want to untag.
tag_keys(impl Into<String>)/set_tag_keys(Option<Vec::<String>>):
required: trueThe tag keys of the tags to remove from the resource.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_agent_runtime(&self) -> UpdateAgentRuntimeFluentBuilder
pub fn update_agent_runtime(&self) -> UpdateAgentRuntimeFluentBuilder
Constructs a fluent builder for the UpdateAgentRuntime operation.
- The fluent builder is configurable:
agent_runtime_id(impl Into<String>)/set_agent_runtime_id(Option<String>):
required: trueThe unique identifier of the AgentCore Runtime to update.
agent_runtime_artifact(AgentRuntimeArtifact)/set_agent_runtime_artifact(Option<AgentRuntimeArtifact>):
required: trueThe updated artifact of the AgentCore Runtime.
role_arn(impl Into<String>)/set_role_arn(Option<String>):
required: trueThe updated IAM role ARN that provides permissions for the AgentCore Runtime.
network_configuration(NetworkConfiguration)/set_network_configuration(Option<NetworkConfiguration>):
required: trueThe updated network configuration for the AgentCore Runtime.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description of the AgentCore Runtime.
authorizer_configuration(AuthorizerConfiguration)/set_authorizer_configuration(Option<AuthorizerConfiguration>):
required: falseThe updated authorizer configuration for the AgentCore Runtime.
request_header_configuration(RequestHeaderConfiguration)/set_request_header_configuration(Option<RequestHeaderConfiguration>):
required: falseThe updated configuration for HTTP request headers that will be passed through to the runtime.
protocol_configuration(ProtocolConfiguration)/set_protocol_configuration(Option<ProtocolConfiguration>):
required: falseThe protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.
lifecycle_configuration(LifecycleConfiguration)/set_lifecycle_configuration(Option<LifecycleConfiguration>):
required: falseThe updated life cycle configuration for the AgentCore Runtime.
metadata_configuration(RuntimeMetadataConfiguration)/set_metadata_configuration(Option<RuntimeMetadataConfiguration>):
required: falseThe updated configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.
environment_variables(impl Into<String>, impl Into<String>)/set_environment_variables(Option<HashMap::<String, String>>):
required: falseUpdated environment variables to set in the AgentCore Runtime environment.
filesystem_configurations(FilesystemConfiguration)/set_filesystem_configurations(Option<Vec::<FilesystemConfiguration>>):
required: falseThe updated filesystem configurations to mount into the AgentCore Runtime.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency of the request.
- On success, responds with
UpdateAgentRuntimeOutputwith field(s):agent_runtime_arn(String):The Amazon Resource Name (ARN) of the updated AgentCore Runtime.
agent_runtime_id(String):The unique identifier of the updated AgentCore Runtime.
workload_identity_details(Option<WorkloadIdentityDetails>):The workload identity details for the updated AgentCore Runtime.
agent_runtime_version(String):The version of the updated AgentCore Runtime.
created_at(DateTime):The timestamp when the AgentCore Runtime was created.
last_updated_at(DateTime):The timestamp when the AgentCore Runtime was last updated.
status(AgentRuntimeStatus):The current status of the updated AgentCore Runtime.
- On failure, responds with
SdkError<UpdateAgentRuntimeError>
Source§impl Client
impl Client
Sourcepub fn update_agent_runtime_endpoint(
&self,
) -> UpdateAgentRuntimeEndpointFluentBuilder
pub fn update_agent_runtime_endpoint( &self, ) -> UpdateAgentRuntimeEndpointFluentBuilder
Constructs a fluent builder for the UpdateAgentRuntimeEndpoint operation.
- The fluent builder is configurable:
agent_runtime_id(impl Into<String>)/set_agent_runtime_id(Option<String>):
required: trueThe unique identifier of the AgentCore Runtime associated with the endpoint.
endpoint_name(impl Into<String>)/set_endpoint_name(Option<String>):
required: trueThe name of the AgentCore Runtime endpoint to update.
agent_runtime_version(impl Into<String>)/set_agent_runtime_version(Option<String>):
required: falseThe updated version of the AgentCore Runtime for the endpoint.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description of the AgentCore Runtime endpoint.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency of the request.
- On success, responds with
UpdateAgentRuntimeEndpointOutputwith field(s):live_version(Option<String>):The currently deployed version of the AgentCore Runtime on the endpoint.
target_version(Option<String>):The target version of the AgentCore Runtime for the endpoint.
agent_runtime_endpoint_arn(String):The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.
agent_runtime_arn(String):The Amazon Resource Name (ARN) of the AgentCore Runtime.
status(AgentRuntimeEndpointStatus):The current status of the updated AgentCore Runtime endpoint.
created_at(DateTime):The timestamp when the AgentCore Runtime endpoint was created.
last_updated_at(DateTime):The timestamp when the AgentCore Runtime endpoint was last updated.
- On failure, responds with
SdkError<UpdateAgentRuntimeEndpointError>
Source§impl Client
impl Client
Sourcepub fn update_api_key_credential_provider(
&self,
) -> UpdateApiKeyCredentialProviderFluentBuilder
pub fn update_api_key_credential_provider( &self, ) -> UpdateApiKeyCredentialProviderFluentBuilder
Constructs a fluent builder for the UpdateApiKeyCredentialProvider operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the API key credential provider to update.
api_key(impl Into<String>)/set_api_key(Option<String>):
required: falseThe new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.
api_key_secret_config(SecretReference)/set_api_key_secret_config(Option<SecretReference>):
required: falseA reference to the AWS Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when
apiKeySecretSourceis set toEXTERNAL.api_key_secret_source(SecretSourceType)/set_api_key_secret_source(Option<SecretSourceType>):
required: falseThe source type of the API key secret. Use
MANAGEDif the secret is managed by the service, orEXTERNALif you manage the secret yourself in AWS Secrets Manager.
- On success, responds with
UpdateApiKeyCredentialProviderOutputwith field(s):api_key_secret_arn(Option<Secret>):The Amazon Resource Name (ARN) of the API key secret in AWS Secrets Manager.
api_key_secret_json_key(Option<String>):The JSON key used to extract the API key value from the AWS Secrets Manager secret.
api_key_secret_source(Option<SecretSourceType>):The source type of the API key secret. Either
MANAGEDif the secret is managed by the service, orEXTERNALif managed by the user in AWS Secrets Manager.name(String):The name of the API key credential provider.
credential_provider_arn(String):The Amazon Resource Name (ARN) of the API key credential provider.
created_time(DateTime):The timestamp when the API key credential provider was created.
last_updated_time(DateTime):The timestamp when the API key credential provider was last updated.
- On failure, responds with
SdkError<UpdateApiKeyCredentialProviderError>
Source§impl Client
impl Client
Sourcepub fn update_configuration_bundle(
&self,
) -> UpdateConfigurationBundleFluentBuilder
pub fn update_configuration_bundle( &self, ) -> UpdateConfigurationBundleFluentBuilder
Constructs a fluent builder for the UpdateConfigurationBundle operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
bundle_id(impl Into<String>)/set_bundle_id(Option<String>):
required: trueThe unique identifier of the configuration bundle to update.
bundle_name(impl Into<String>)/set_bundle_name(Option<String>):
required: falseThe updated name for the configuration bundle.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description for the configuration bundle.
components(impl Into<String>, ComponentConfiguration)/set_components(Option<HashMap::<String, ComponentConfiguration>>):
required: falseThe updated component configurations. Creates a new version of the bundle.
parent_version_ids(impl Into<String>)/set_parent_version_ids(Option<Vec::<String>>):
required: falseA list of parent version identifiers for lineage tracking. Regular commits have a single parent. Merge commits have two parents: the target branch parent and the source branch parent. If the branch already exists, the first parent must be the latest version on that branch.
branch_name(impl Into<String>)/set_branch_name(Option<String>):
required: falseThe branch name for this version. If not specified, inherits the parent’s branch or defaults to
mainline.commit_message(impl Into<String>)/set_commit_message(Option<String>):
required: falseA commit message describing the changes in this version.
created_by(VersionCreatedBySource)/set_created_by(Option<VersionCreatedBySource>):
required: falseThe source that created this version, including the source name and optional ARN.
- On success, responds with
UpdateConfigurationBundleOutputwith field(s):bundle_arn(String):The Amazon Resource Name (ARN) of the updated configuration bundle.
bundle_id(String):The unique identifier of the updated configuration bundle.
version_id(String):The new version identifier created by this update.
updated_at(DateTime):The timestamp when the configuration bundle was updated.
- On failure, responds with
SdkError<UpdateConfigurationBundleError>
Source§impl Client
impl Client
Sourcepub fn update_dataset(&self) -> UpdateDatasetFluentBuilder
pub fn update_dataset(&self) -> UpdateDatasetFluentBuilder
Constructs a fluent builder for the UpdateDataset operation.
- The fluent builder is configurable:
dataset_id(impl Into<String>)/set_dataset_id(Option<String>):
required: trueThe unique identifier of the dataset to update.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description for the dataset.
- On success, responds with
UpdateDatasetOutputwith field(s):dataset_arn(String):The Amazon Resource Name (ARN) of the updated dataset.
dataset_id(String):The unique identifier of the updated dataset.
updated_at(DateTime):The timestamp when the dataset was updated.
- On failure, responds with
SdkError<UpdateDatasetError>
Source§impl Client
impl Client
Sourcepub fn update_dataset_examples(&self) -> UpdateDatasetExamplesFluentBuilder
pub fn update_dataset_examples(&self) -> UpdateDatasetExamplesFluentBuilder
Constructs a fluent builder for the UpdateDatasetExamples operation.
- The fluent builder is configurable:
dataset_id(impl Into<String>)/set_dataset_id(Option<String>):
required: trueThe unique identifier of the dataset.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
examples(Document)/set_examples(Option<Vec::<Document>>):
required: true
Examples to update. Each element is a JSON object containing a requiredexampleIdstring field identifying the existing example, plus the replacement fields. TheexampleIdis extracted and removed before persistence; the remaining document is validated against the dataset’s schemaType. Max 1000 examples per call. Total request body must not exceed 5 MB.
- On success, responds with
UpdateDatasetExamplesOutputwith field(s):dataset_arn(String):The Amazon Resource Name (ARN) of the dataset.
dataset_id(String):The unique identifier of the dataset.
status(DatasetStatus):The current status of the dataset.
updated_count(i64):The number of examples updated.
updated_at(DateTime):The timestamp when the examples were updated.
- On failure, responds with
SdkError<UpdateDatasetExamplesError>
Source§impl Client
impl Client
Sourcepub fn update_evaluator(&self) -> UpdateEvaluatorFluentBuilder
pub fn update_evaluator(&self) -> UpdateEvaluatorFluentBuilder
Constructs a fluent builder for the UpdateEvaluator operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
evaluator_id(impl Into<String>)/set_evaluator_id(Option<String>):
required: trueThe unique identifier of the evaluator to update.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description of the evaluator.
evaluator_config(EvaluatorConfig)/set_evaluator_config(Option<EvaluatorConfig>):
required: falseThe updated configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.
level(EvaluatorLevel)/set_level(Option<EvaluatorLevel>):
required: falseThe updated evaluation level (
TOOL_CALL,TRACE, orSESSION) that determines the scope of evaluation.kms_key_arn(impl Into<String>)/set_kms_key_arn(Option<String>):
required: falseThe Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data. Specify a new key ARN to rotate the encryption key, or specify a key ARN to add encryption to an evaluator that was previously created without one. When you rotate to a new key, the service decrypts the existing data with the old key and re-encrypts it with the new key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.
- On success, responds with
UpdateEvaluatorOutputwith field(s):evaluator_arn(String):The Amazon Resource Name (ARN) of the updated evaluator.
evaluator_id(String):The unique identifier of the updated evaluator.
updated_at(DateTime):The timestamp when the evaluator was last updated.
status(EvaluatorStatus):The status of the evaluator update operation.
- On failure, responds with
SdkError<UpdateEvaluatorError>
Source§impl Client
impl Client
Sourcepub fn update_gateway(&self) -> UpdateGatewayFluentBuilder
pub fn update_gateway(&self) -> UpdateGatewayFluentBuilder
Constructs a fluent builder for the UpdateGateway operation.
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe identifier of the gateway to update.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the gateway. This name must be the same as the one when the gateway was created.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description for the gateway.
role_arn(impl Into<String>)/set_role_arn(Option<String>):
required: trueThe updated IAM role ARN that provides permissions for the gateway.
protocol_type(GatewayProtocolType)/set_protocol_type(Option<GatewayProtocolType>):
required: falseThe updated protocol type for the gateway.
protocol_configuration(GatewayProtocolConfiguration)/set_protocol_configuration(Option<GatewayProtocolConfiguration>):
required: falseThe configuration for a gateway protocol. This structure defines how the gateway communicates with external services.
authorizer_type(AuthorizerType)/set_authorizer_type(Option<AuthorizerType>):
required: trueThe updated authorizer type for the gateway.
authorizer_configuration(AuthorizerConfiguration)/set_authorizer_configuration(Option<AuthorizerConfiguration>):
required: falseThe updated authorizer configuration for the gateway.
kms_key_arn(impl Into<String>)/set_kms_key_arn(Option<String>):
required: falseThe updated ARN of the KMS key used to encrypt the gateway.
interceptor_configurations(GatewayInterceptorConfiguration)/set_interceptor_configurations(Option<Vec::<GatewayInterceptorConfiguration>>):
required: falseThe updated interceptor configurations for the gateway.
policy_engine_configuration(GatewayPolicyEngineConfiguration)/set_policy_engine_configuration(Option<GatewayPolicyEngineConfiguration>):
required: falseThe updated policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.
exception_level(ExceptionLevel)/set_exception_level(Option<ExceptionLevel>):
required: falseThe level of detail in error messages returned when invoking the gateway.
-
If the value is
DEBUG, granular exception messages are returned to help a user debug the gateway. -
If the value is omitted, a generic error message is returned to the end user.
-
- On success, responds with
UpdateGatewayOutputwith field(s):gateway_arn(String):The Amazon Resource Name (ARN) of the updated gateway.
gateway_id(String):The unique identifier of the updated gateway.
gateway_url(Option<String>):An endpoint for invoking the updated gateway.
created_at(DateTime):The timestamp when the gateway was created.
updated_at(DateTime):The timestamp when the gateway was last updated.
status(GatewayStatus):The current status of the updated gateway.
status_reasons(Option<Vec::<String>>):The reasons for the current status of the updated gateway.
name(String):The name of the gateway.
description(Option<String>):The updated description of the gateway.
role_arn(Option<String>):The updated IAM role ARN that provides permissions for the gateway.
protocol_type(GatewayProtocolType):The updated protocol type for the gateway.
protocol_configuration(Option<GatewayProtocolConfiguration>):The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.
authorizer_type(AuthorizerType):The updated authorizer type for the gateway.
authorizer_configuration(Option<AuthorizerConfiguration>):The updated authorizer configuration for the gateway.
kms_key_arn(Option<String>):The updated ARN of the KMS key used to encrypt the gateway.
interceptor_configurations(Option<Vec::<GatewayInterceptorConfiguration>>):The updated interceptor configurations for the gateway.
policy_engine_configuration(Option<GatewayPolicyEngineConfiguration>):The updated policy engine configuration for the gateway.
workload_identity_details(Option<WorkloadIdentityDetails>):The workload identity details for the updated gateway.
exception_level(Option<ExceptionLevel>):The level of detail in error messages returned when invoking the gateway.
-
If the value is
DEBUG, granular exception messages are returned to help a user debug the gateway. -
If the value is omitted, a generic error message is returned to the end user.
-
- On failure, responds with
SdkError<UpdateGatewayError>
Source§impl Client
impl Client
Sourcepub fn update_gateway_rule(&self) -> UpdateGatewayRuleFluentBuilder
pub fn update_gateway_rule(&self) -> UpdateGatewayRuleFluentBuilder
Constructs a fluent builder for the UpdateGatewayRule operation.
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe identifier of the gateway containing the rule.
rule_id(impl Into<String>)/set_rule_id(Option<String>):
required: trueThe unique identifier of the rule to update.
priority(i32)/set_priority(Option<i32>):
required: falseThe updated priority of the rule.
conditions(Condition)/set_conditions(Option<Vec::<Condition>>):
required: falseThe updated conditions for the rule.
actions(Action)/set_actions(Option<Vec::<Action>>):
required: falseThe updated actions for the rule.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description of the rule.
- On success, responds with
UpdateGatewayRuleOutputwith field(s):rule_id(String):The unique identifier of the gateway rule.
gateway_arn(String):The Amazon Resource Name (ARN) of the gateway that the rule belongs to.
priority(i32):The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.
conditions(Option<Vec::<Condition>>):The conditions that must be met for the rule to apply.
actions(Vec::<Action>):The actions to take when the rule conditions are met.
description(Option<String>):The description of the gateway rule.
created_at(DateTime):The timestamp when the rule was created.
status(GatewayRuleStatus):The current status of the rule.
system(Option<SystemManagedBlock>):System-managed metadata for rules created by automated processes.
updated_at(Option<DateTime>):The timestamp when the rule was last updated.
- On failure, responds with
SdkError<UpdateGatewayRuleError>
Source§impl Client
impl Client
Sourcepub fn update_gateway_target(&self) -> UpdateGatewayTargetFluentBuilder
pub fn update_gateway_target(&self) -> UpdateGatewayTargetFluentBuilder
Constructs a fluent builder for the UpdateGatewayTarget operation.
- The fluent builder is configurable:
gateway_identifier(impl Into<String>)/set_gateway_identifier(Option<String>):
required: trueThe unique identifier of the gateway associated with the target.
target_id(impl Into<String>)/set_target_id(Option<String>):
required: trueThe unique identifier of the gateway target to update.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe updated name for the gateway target.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description for the gateway target.
target_configuration(TargetConfiguration)/set_target_configuration(Option<TargetConfiguration>):
required: trueThe configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.
credential_provider_configurations(CredentialProviderConfiguration)/set_credential_provider_configurations(Option<Vec::<CredentialProviderConfiguration>>):
required: falseThe updated credential provider configurations for the gateway target.
metadata_configuration(MetadataConfiguration)/set_metadata_configuration(Option<MetadataConfiguration>):
required: falseConfiguration for HTTP header and query parameter propagation to the gateway target.
private_endpoint(PrivateEndpoint)/set_private_endpoint(Option<PrivateEndpoint>):
required: falseThe private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.
- On success, responds with
UpdateGatewayTargetOutputwith field(s):gateway_arn(String):The Amazon Resource Name (ARN) of the gateway.
target_id(String):The unique identifier of the updated gateway target.
created_at(DateTime):The timestamp when the gateway target was created.
updated_at(DateTime):The timestamp when the gateway target was last updated.
status(TargetStatus):The current status of the updated gateway target.
status_reasons(Option<Vec::<String>>):The reasons for the current status of the updated gateway target.
name(String):The updated name of the gateway target.
description(Option<String>):The updated description of the gateway target.
target_configuration(Option<TargetConfiguration>):The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.
credential_provider_configurations(Vec::<CredentialProviderConfiguration>):The updated credential provider configurations for the gateway target.
last_synchronized_at(Option<DateTime>):The date and time at which the targets were last synchronized.
metadata_configuration(Option<MetadataConfiguration>):The metadata configuration that was applied to the gateway target.
private_endpoint(Option<PrivateEndpoint>):The private endpoint configuration for the gateway target.
private_endpoint_managed_resources(Option<Vec::<ManagedResourceDetails>>):The managed resources created by the gateway for private endpoint connectivity.
authorization_data(Option<AuthorizationData>):OAuth2 authorization data for the updated gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.
protocol_type(Option<TargetProtocolType>):The protocol type of the updated gateway target.
- On failure, responds with
SdkError<UpdateGatewayTargetError>
Source§impl Client
impl Client
Sourcepub fn update_harness(&self) -> UpdateHarnessFluentBuilder
pub fn update_harness(&self) -> UpdateHarnessFluentBuilder
Constructs a fluent builder for the UpdateHarness operation.
- The fluent builder is configurable:
harness_id(impl Into<String>)/set_harness_id(Option<String>):
required: trueThe ID of the harness to update.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure idempotency of the request.
execution_role_arn(impl Into<String>)/set_execution_role_arn(Option<String>):
required: falseThe ARN of the IAM role that the harness assumes when running. If not specified, the existing value is retained.
environment(HarnessEnvironmentProviderRequest)/set_environment(Option<HarnessEnvironmentProviderRequest>):
required: falseThe compute environment configuration for the harness. If not specified, the existing value is retained.
environment_artifact(UpdatedHarnessEnvironmentArtifact)/set_environment_artifact(Option<UpdatedHarnessEnvironmentArtifact>):
required: falseThe environment artifact for the harness. Use the optionalValue wrapper to set a new value, or set it to null to clear the existing configuration.
environment_variables(impl Into<String>, impl Into<String>)/set_environment_variables(Option<HashMap::<String, String>>):
required: falseEnvironment variables to set in the harness runtime environment. If specified, this replaces all existing environment variables. If not specified, the existing value is retained.
authorizer_configuration(UpdatedAuthorizerConfiguration)/set_authorizer_configuration(Option<UpdatedAuthorizerConfiguration>):
required: falseWrapper for updating an optional AuthorizerConfiguration field with PATCH semantics. When present in an update request, the authorizer configuration is replaced with optionalValue. When absent, the authorizer configuration is left unchanged. To unset, include the wrapper with optionalValue not specified.
model(HarnessModelConfiguration)/set_model(Option<HarnessModelConfiguration>):
required: falseThe model configuration for the harness. If not specified, the existing value is retained.
system_prompt(HarnessSystemContentBlock)/set_system_prompt(Option<Vec::<HarnessSystemContentBlock>>):
required: falseThe system prompt that defines the agent’s behavior. If not specified, the existing value is retained.
tools(HarnessTool)/set_tools(Option<Vec::<HarnessTool>>):
required: falseThe tools available to the agent. If specified, this replaces all existing tools. If not specified, the existing value is retained.
skills(HarnessSkill)/set_skills(Option<Vec::<HarnessSkill>>):
required: falseThe skills available to the agent. If specified, this replaces all existing skills. If not specified, the existing value is retained.
allowed_tools(impl Into<String>)/set_allowed_tools(Option<Vec::<String>>):
required: falseThe tools that the agent is allowed to use. If specified, this replaces all existing allowed tools. If not specified, the existing value is retained.
memory(UpdatedHarnessMemoryConfiguration)/set_memory(Option<UpdatedHarnessMemoryConfiguration>):
required: falseThe AgentCore Memory configuration. Use the optionalValue wrapper to set a new value, or set it to null to clear the existing configuration.
truncation(HarnessTruncationConfiguration)/set_truncation(Option<HarnessTruncationConfiguration>):
required: falseThe truncation configuration for managing conversation context. If not specified, the existing value is retained.
max_iterations(i32)/set_max_iterations(Option<i32>):
required: falseThe maximum number of iterations the agent loop can execute per invocation. If not specified, the existing value is retained.
max_tokens(i32)/set_max_tokens(Option<i32>):
required: falseThe maximum total number of output tokens the agent can generate across all model calls within a single invocation. If not specified, the existing value is retained.
timeout_seconds(i32)/set_timeout_seconds(Option<i32>):
required: falseThe maximum duration in seconds for the agent loop execution per invocation. If not specified, the existing value is retained.
- On success, responds with
UpdateHarnessOutputwith field(s):harness(Option<Harness>):The updated harness.
- On failure, responds with
SdkError<UpdateHarnessError>
Source§impl Client
impl Client
Sourcepub fn update_memory(&self) -> UpdateMemoryFluentBuilder
pub fn update_memory(&self) -> UpdateMemoryFluentBuilder
Constructs a fluent builder for the UpdateMemory operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique AWS identifier.
memory_id(impl Into<String>)/set_memory_id(Option<String>):
required: trueThe unique identifier of the memory to update.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description of the AgentCore Memory resource.
event_expiry_duration(i32)/set_event_expiry_duration(Option<i32>):
required: falseThe number of days after which memory events will expire, between 7 and 365 days.
memory_execution_role_arn(impl Into<String>)/set_memory_execution_role_arn(Option<String>):
required: falseThe ARN of the IAM role that provides permissions for the AgentCore Memory resource.
memory_strategies(ModifyMemoryStrategies)/set_memory_strategies(Option<ModifyMemoryStrategies>):
required: falseThe memory strategies to add, modify, or delete.
add_indexed_keys(IndexedKey)/set_add_indexed_keys(Option<Vec::<IndexedKey>>):
required: falseAdditional metadata keys to index. Previously indexed keys cannot be removed.
stream_delivery_resources(StreamDeliveryResources)/set_stream_delivery_resources(Option<StreamDeliveryResources>):
required: falseConfiguration for streaming memory record data to external resources.
- On success, responds with
UpdateMemoryOutputwith field(s):memory(Option<Memory>):The updated AgentCore Memory resource details.
- On failure, responds with
SdkError<UpdateMemoryError>
Source§impl Client
impl Client
Sourcepub fn update_oauth2_credential_provider(
&self,
) -> UpdateOauth2CredentialProviderFluentBuilder
pub fn update_oauth2_credential_provider( &self, ) -> UpdateOauth2CredentialProviderFluentBuilder
Constructs a fluent builder for the UpdateOauth2CredentialProvider operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the OAuth2 credential provider to update.
credential_provider_vendor(CredentialProviderVendorType)/set_credential_provider_vendor(Option<CredentialProviderVendorType>):
required: trueThe vendor of the OAuth2 credential provider.
oauth2_provider_config_input(Oauth2ProviderConfigInput)/set_oauth2_provider_config_input(Option<Oauth2ProviderConfigInput>):
required: trueThe configuration input for the OAuth2 provider.
- On success, responds with
UpdateOauth2CredentialProviderOutputwith field(s):client_secret_arn(Option<Secret>):The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager.
client_secret_json_key(Option<String>):The JSON key used to extract the client secret value from the AWS Secrets Manager secret.
client_secret_source(Option<SecretSourceType>):The source type of the client secret. Either
MANAGEDif the secret is managed by the service, orEXTERNALif managed by the user in AWS Secrets Manager.name(String):The name of the OAuth2 credential provider.
credential_provider_vendor(CredentialProviderVendorType):The vendor of the OAuth2 credential provider.
credential_provider_arn(String):The Amazon Resource Name (ARN) of the OAuth2 credential provider.
callback_url(Option<String>):Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.
oauth2_provider_config_output(Option<Oauth2ProviderConfigOutput>):The configuration output for the OAuth2 provider.
created_time(DateTime):The timestamp when the OAuth2 credential provider was created.
last_updated_time(DateTime):The timestamp when the OAuth2 credential provider was last updated.
status(Option<Status>):The current status of the updated OAuth2 credential provider.
- On failure, responds with
SdkError<UpdateOauth2CredentialProviderError>
Source§impl Client
impl Client
Sourcepub fn update_online_evaluation_config(
&self,
) -> UpdateOnlineEvaluationConfigFluentBuilder
pub fn update_online_evaluation_config( &self, ) -> UpdateOnlineEvaluationConfigFluentBuilder
Constructs a fluent builder for the UpdateOnlineEvaluationConfig operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
online_evaluation_config_id(impl Into<String>)/set_online_evaluation_config_id(Option<String>):
required: trueThe unique identifier of the online evaluation configuration to update.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description of the online evaluation configuration.
rule(Rule)/set_rule(Option<Rule>):
required: falseThe updated evaluation rule containing sampling configuration, filters, and session settings.
data_source_config(DataSourceConfig)/set_data_source_config(Option<DataSourceConfig>):
required: falseThe updated data source configuration specifying CloudWatch log groups and service names to monitor.
evaluators(EvaluatorReference)/set_evaluators(Option<Vec::<EvaluatorReference>>):
required: falseThe updated list of evaluators to apply during online evaluation.
evaluation_execution_role_arn(impl Into<String>)/set_evaluation_execution_role_arn(Option<String>):
required: falseThe updated Amazon Resource Name (ARN) of the IAM role used for evaluation execution.
execution_status(OnlineEvaluationExecutionStatus)/set_execution_status(Option<OnlineEvaluationExecutionStatus>):
required: falseThe updated execution status to enable or disable the online evaluation.
- On success, responds with
UpdateOnlineEvaluationConfigOutputwith field(s):online_evaluation_config_arn(String):The Amazon Resource Name (ARN) of the updated online evaluation configuration.
online_evaluation_config_id(String):The unique identifier of the updated online evaluation configuration.
updated_at(DateTime):The timestamp when the online evaluation configuration was last updated.
status(OnlineEvaluationConfigStatus):The status of the online evaluation configuration.
execution_status(OnlineEvaluationExecutionStatus):The execution status indicating whether the online evaluation is currently running.
failure_reason(Option<String>):The reason for failure if the online evaluation configuration update or execution failed.
- On failure, responds with
SdkError<UpdateOnlineEvaluationConfigError>
Source§impl Client
impl Client
Sourcepub fn update_payment_connector(&self) -> UpdatePaymentConnectorFluentBuilder
pub fn update_payment_connector(&self) -> UpdatePaymentConnectorFluentBuilder
Constructs a fluent builder for the UpdatePaymentConnector operation.
- The fluent builder is configurable:
payment_manager_id(impl Into<String>)/set_payment_manager_id(Option<String>):
required: trueThe unique identifier of the parent payment manager.
payment_connector_id(impl Into<String>)/set_payment_connector_id(Option<String>):
required: trueThe unique identifier of the payment connector to update.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description of the payment connector.
r#type(PaymentConnectorType)/set_type(Option<PaymentConnectorType>):
required: falseThe updated type of the payment connector.
credential_provider_configurations(CredentialsProviderConfiguration)/set_credential_provider_configurations(Option<Vec::<CredentialsProviderConfiguration>>):
required: falseThe updated credential provider configurations for the payment connector.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
- On success, responds with
UpdatePaymentConnectorOutputwith field(s):payment_connector_id(String):The unique identifier of the updated payment connector.
payment_manager_id(String):The unique identifier of the parent payment manager.
name(String):The name of the updated payment connector.
r#type(PaymentConnectorType):The type of the updated payment connector.
credential_provider_configurations(Vec::<CredentialsProviderConfiguration>):The credential provider configurations for the updated payment connector.
last_updated_at(DateTime):The timestamp when the payment connector was last updated.
status(PaymentConnectorStatus):The current status of the updated payment connector. Possible values include
CREATING,READY,UPDATING,DELETING,CREATE_FAILED,UPDATE_FAILED, andDELETE_FAILED.
- On failure, responds with
SdkError<UpdatePaymentConnectorError>
Source§impl Client
impl Client
Sourcepub fn update_payment_credential_provider(
&self,
) -> UpdatePaymentCredentialProviderFluentBuilder
pub fn update_payment_credential_provider( &self, ) -> UpdatePaymentCredentialProviderFluentBuilder
Constructs a fluent builder for the UpdatePaymentCredentialProvider operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the payment credential provider to update.
credential_provider_vendor(PaymentCredentialProviderVendorType)/set_credential_provider_vendor(Option<PaymentCredentialProviderVendorType>):
required: trueThe vendor type for the payment credential provider (e.g., CoinbaseCDP, StripePrivy).
provider_configuration_input(PaymentProviderConfigurationInput)/set_provider_configuration_input(Option<PaymentProviderConfigurationInput>):
required: trueConfiguration specific to the vendor, including API credentials.
- On success, responds with
UpdatePaymentCredentialProviderOutputwith field(s):name(String):The name of the updated payment credential provider.
credential_provider_vendor(PaymentCredentialProviderVendorType):The vendor type for the updated payment credential provider.
credential_provider_arn(String):The Amazon Resource Name (ARN) of the updated payment credential provider.
provider_configuration_output(Option<PaymentProviderConfigurationOutput>):Output configuration (contains secret ARNs, excludes actual secret values).
created_time(DateTime):The timestamp when the payment credential provider was created.
last_updated_time(DateTime):The timestamp when the payment credential provider was last updated.
- On failure, responds with
SdkError<UpdatePaymentCredentialProviderError>
Source§impl Client
impl Client
Sourcepub fn update_payment_manager(&self) -> UpdatePaymentManagerFluentBuilder
pub fn update_payment_manager(&self) -> UpdatePaymentManagerFluentBuilder
Constructs a fluent builder for the UpdatePaymentManager operation.
- The fluent builder is configurable:
payment_manager_id(impl Into<String>)/set_payment_manager_id(Option<String>):
required: trueThe unique identifier of the payment manager to update.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description of the payment manager.
authorizer_type(PaymentsAuthorizerType)/set_authorizer_type(Option<PaymentsAuthorizerType>):
required: falseThe updated authorizer type for the payment manager.
authorizer_configuration(AuthorizerConfiguration)/set_authorizer_configuration(Option<AuthorizerConfiguration>):
required: falseThe updated authorizer configuration for the payment manager.
role_arn(impl Into<String>)/set_role_arn(Option<String>):
required: falseThe updated Amazon Resource Name (ARN) of the IAM role for the payment manager.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.
- On success, responds with
UpdatePaymentManagerOutputwith field(s):payment_manager_arn(String):The Amazon Resource Name (ARN) of the updated payment manager.
payment_manager_id(String):The unique identifier of the updated payment manager.
name(String):The name of the updated payment manager.
authorizer_type(PaymentsAuthorizerType):The type of authorizer for the updated payment manager.
role_arn(String):The Amazon Resource Name (ARN) of the IAM role associated with the updated payment manager.
workload_identity_details(Option<WorkloadIdentityDetails>):The information about the workload identity.
last_updated_at(DateTime):The timestamp when the payment manager was last updated.
status(PaymentManagerStatus):The current status of the updated payment manager. Possible values include
CREATING,READY,UPDATING,DELETING,CREATE_FAILED,UPDATE_FAILED, andDELETE_FAILED.
- On failure, responds with
SdkError<UpdatePaymentManagerError>
Source§impl Client
impl Client
Sourcepub fn update_policy(&self) -> UpdatePolicyFluentBuilder
pub fn update_policy(&self) -> UpdatePolicyFluentBuilder
Constructs a fluent builder for the UpdatePolicy operation.
- The fluent builder is configurable:
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe identifier of the policy engine that manages the policy to be updated. This ensures the policy is updated within the correct policy engine context.
policy_id(impl Into<String>)/set_policy_id(Option<String>):
required: trueThe unique identifier of the policy to be updated. This must be a valid policy ID that exists within the specified policy engine.
description(UpdatedDescription)/set_description(Option<UpdatedDescription>):
required: falseThe new human-readable description for the policy. This optional field allows updating the policy’s documentation while keeping the same policy logic.
definition(PolicyDefinition)/set_definition(Option<PolicyDefinition>):
required: falseThe 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.
validation_mode(PolicyValidationMode)/set_validation_mode(Option<PolicyValidationMode>):
required: falseThe 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.
- On success, responds with
UpdatePolicyOutputwith field(s):policy_id(String):The unique identifier of the updated policy.
name(String):The name of the updated policy.
policy_engine_id(String):The identifier of the policy engine managing the updated policy.
created_at(DateTime):The original creation timestamp of the policy.
updated_at(DateTime):The timestamp when the policy was last updated.
policy_arn(String):The ARN of the updated policy.
status(PolicyStatus):The current status of the updated policy.
definition(Option<PolicyDefinition>):The updated Cedar policy statement.
description(Option<String>):The updated description of the policy.
status_reasons(Vec::<String>):Additional information about the update status.
- On failure, responds with
SdkError<UpdatePolicyError>
Source§impl Client
impl Client
Sourcepub fn update_policy_engine(&self) -> UpdatePolicyEngineFluentBuilder
pub fn update_policy_engine(&self) -> UpdatePolicyEngineFluentBuilder
Constructs a fluent builder for the UpdatePolicyEngine operation.
- The fluent builder is configurable:
policy_engine_id(impl Into<String>)/set_policy_engine_id(Option<String>):
required: trueThe unique identifier of the policy engine to be updated.
description(UpdatedDescription)/set_description(Option<UpdatedDescription>):
required: falseThe new description for the policy engine.
- On success, responds with
UpdatePolicyEngineOutputwith field(s):policy_engine_id(String):The unique identifier of the updated policy engine.
name(String):The name of the updated policy engine.
created_at(DateTime):The original creation timestamp of the policy engine.
updated_at(DateTime):The timestamp when the policy engine was last updated.
policy_engine_arn(String):The ARN of the updated policy engine.
status(PolicyEngineStatus):The current status of the updated policy engine.
encryption_key_arn(Option<String>):The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
description(Option<String>):The updated description of the policy engine.
status_reasons(Vec::<String>):Additional information about the update status.
- On failure, responds with
SdkError<UpdatePolicyEngineError>
Source§impl Client
impl Client
Sourcepub fn update_registry(&self) -> UpdateRegistryFluentBuilder
pub fn update_registry(&self) -> UpdateRegistryFluentBuilder
Constructs a fluent builder for the UpdateRegistry operation.
- The fluent builder is configurable:
registry_id(impl Into<String>)/set_registry_id(Option<String>):
required: trueThe identifier of the registry to update. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe updated name of the registry.
description(UpdatedDescription)/set_description(Option<UpdatedDescription>):
required: falseThe updated description of the registry. To clear the description, include the
UpdatedDescriptionwrapper withoptionalValuenot specified.authorizer_configuration(UpdatedAuthorizerConfiguration)/set_authorizer_configuration(Option<UpdatedAuthorizerConfiguration>):
required: falseThe updated authorizer configuration for the registry. Changing the authorizer configuration can break existing consumers of the registry who are using the authorization type prior to the update.
approval_configuration(UpdatedApprovalConfiguration)/set_approval_configuration(Option<UpdatedApprovalConfiguration>):
required: falseThe updated approval configuration for registry records. The updated configuration only affects new records that move to
PENDING_APPROVALstatus after the change. Existing records already inPENDING_APPROVALstatus are not affected.
- On success, responds with
UpdateRegistryOutputwith field(s):name(String):The name of the updated registry.
description(Option<String>):The description of the updated registry.
registry_id(String):The unique identifier of the updated registry.
registry_arn(String):The Amazon Resource Name (ARN) of the updated registry.
authorizer_type(Option<RegistryAuthorizerType>):The type of authorizer used by the updated registry. This controls the authorization method for the Search and Invoke APIs used by consumers.
-
CUSTOM_JWT- Authorize with a bearer token. -
AWS_IAM- Authorize with your Amazon Web Services IAM credentials.
-
authorizer_configuration(Option<AuthorizerConfiguration>):The authorizer configuration for the updated registry. For details, see the
AuthorizerConfigurationdata type.approval_configuration(Option<ApprovalConfiguration>):The approval configuration for the updated registry. For details, see the
ApprovalConfigurationdata type.status(RegistryStatus):The current status of the updated registry. Possible values include
CREATING,READY,UPDATING,CREATE_FAILED,UPDATE_FAILED,DELETING, andDELETE_FAILED.status_reason(Option<String>):The reason for the current status of the updated registry.
created_at(DateTime):The timestamp when the registry was created.
updated_at(DateTime):The timestamp when the registry was last updated.
- On failure, responds with
SdkError<UpdateRegistryError>
Source§impl Client
impl Client
Sourcepub fn update_registry_record(&self) -> UpdateRegistryRecordFluentBuilder
pub fn update_registry_record(&self) -> UpdateRegistryRecordFluentBuilder
Constructs a fluent builder for the UpdateRegistryRecord operation.
- The fluent builder is configurable:
registry_id(impl Into<String>)/set_registry_id(Option<String>):
required: trueThe identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
record_id(impl Into<String>)/set_record_id(Option<String>):
required: trueThe identifier of the registry record to update. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe updated name for the registry record.
description(UpdatedDescription)/set_description(Option<UpdatedDescription>):
required: falseThe updated description for the registry record. To clear the description, include the
UpdatedDescriptionwrapper withoptionalValuenot specified.descriptor_type(DescriptorType)/set_descriptor_type(Option<DescriptorType>):
required: falseThe updated descriptor type for the registry record. Changing the descriptor type may require updating the
descriptorsfield to match the new type’s schema requirements.descriptors(UpdatedDescriptors)/set_descriptors(Option<UpdatedDescriptors>):
required: falseThe updated descriptor-type-specific configuration containing the resource schema and metadata. Uses PATCH semantics where individual descriptor fields can be updated independently.
record_version(impl Into<String>)/set_record_version(Option<String>):
required: falseThe version of the registry record for optimistic locking. If provided, it must match the current version of the record. The service automatically increments the version after a successful update.
synchronization_type(UpdatedSynchronizationType)/set_synchronization_type(Option<UpdatedSynchronizationType>):
required: falseThe updated synchronization type for the registry record.
synchronization_configuration(UpdatedSynchronizationConfiguration)/set_synchronization_configuration(Option<UpdatedSynchronizationConfiguration>):
required: falseThe updated synchronization configuration for the registry record.
trigger_synchronization(bool)/set_trigger_synchronization(Option<bool>):
required: falseWhether to trigger synchronization using the stored or provided configuration. When set to
true, the service will synchronize the record metadata from the configured external source.
- On success, responds with
UpdateRegistryRecordOutputwith field(s):registry_arn(String):The Amazon Resource Name (ARN) of the registry that contains the updated record.
record_arn(String):The Amazon Resource Name (ARN) of the updated registry record.
record_id(String):The unique identifier of the updated registry record.
name(String):The name of the updated registry record.
description(Option<String>):The description of the updated registry record.
descriptor_type(DescriptorType):The descriptor type of the updated registry record. Possible values are
MCP,A2A,CUSTOM, andAGENT_SKILLS.descriptors(Option<Descriptors>):The descriptor-type-specific configuration of the updated registry record. For details, see the
Descriptorsdata type.record_version(Option<String>):The version of the updated registry record.
status(RegistryRecordStatus):The current status of the updated registry record. Possible values include
CREATING,DRAFT,APPROVED,PENDING_APPROVAL,REJECTED,DEPRECATED,UPDATING,CREATE_FAILED, andUPDATE_FAILED.created_at(DateTime):The timestamp when the registry record was created.
updated_at(DateTime):The timestamp when the registry record was last updated.
status_reason(Option<String>):The reason for the current status of the updated registry record.
synchronization_type(Option<SynchronizationType>):The synchronization type of the updated registry record.
synchronization_configuration(Option<SynchronizationConfiguration>):The synchronization configuration of the updated registry record.
- On failure, responds with
SdkError<UpdateRegistryRecordError>
Source§impl Client
impl Client
Sourcepub fn update_registry_record_status(
&self,
) -> UpdateRegistryRecordStatusFluentBuilder
pub fn update_registry_record_status( &self, ) -> UpdateRegistryRecordStatusFluentBuilder
Constructs a fluent builder for the UpdateRegistryRecordStatus operation.
- The fluent builder is configurable:
registry_id(impl Into<String>)/set_registry_id(Option<String>):
required: trueThe identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
record_id(impl Into<String>)/set_record_id(Option<String>):
required: trueThe identifier of the registry record to update the status for. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
status(RegistryRecordStatus)/set_status(Option<RegistryRecordStatus>):
required: trueThe target status for the registry record.
status_reason(impl Into<String>)/set_status_reason(Option<String>):
required: trueThe reason for the status change, such as why the record was approved or rejected.
- On success, responds with
UpdateRegistryRecordStatusOutputwith field(s):registry_arn(String):The Amazon Resource Name (ARN) of the registry that contains the record.
record_arn(String):The Amazon Resource Name (ARN) of the registry record.
record_id(String):The unique identifier of the registry record.
status(RegistryRecordStatus):The resulting status of the registry record.
status_reason(String):The reason for the status change.
updated_at(DateTime):The timestamp when the record was last updated.
- On failure, responds with
SdkError<UpdateRegistryRecordStatusError>
Source§impl Client
impl Client
Sourcepub fn update_workload_identity(&self) -> UpdateWorkloadIdentityFluentBuilder
pub fn update_workload_identity(&self) -> UpdateWorkloadIdentityFluentBuilder
Constructs a fluent builder for the UpdateWorkloadIdentity operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the workload identity to update.
allowed_resource_oauth2_return_urls(impl Into<String>)/set_allowed_resource_oauth2_return_urls(Option<Vec::<String>>):
required: falseThe new list of allowed OAuth2 return URLs for resources associated with this workload identity. This list replaces the existing list.
- On success, responds with
UpdateWorkloadIdentityOutputwith field(s):name(String):The name of the workload identity.
workload_identity_arn(String):The Amazon Resource Name (ARN) of the workload identity.
allowed_resource_oauth2_return_urls(Option<Vec::<String>>):The list of allowed OAuth2 return URLs for resources associated with this workload identity.
created_time(DateTime):The timestamp when the workload identity was created.
last_updated_time(DateTime):The timestamp when the workload identity was last updated.
- On failure, responds with
SdkError<UpdateWorkloadIdentityError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_implconfigured. - Identity caching is enabled without a
sleep_implandtime_sourceconfigured. - No
behavior_versionis provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it. - This method will panic if no
BehaviorVersionis provided. If you experience this panic, setbehavior_versionon the Config or enable thebehavior-version-latestCargo feature.
Trait Implementations§
Source§impl Waiters for Client
impl Waiters for Client
Source§fn wait_until_memory_created(&self) -> MemoryCreatedFluentBuilder
fn wait_until_memory_created(&self) -> MemoryCreatedFluentBuilder
memory_createdSource§fn wait_until_policy_active(&self) -> PolicyActiveFluentBuilder
fn wait_until_policy_active(&self) -> PolicyActiveFluentBuilder
Source§fn wait_until_policy_deleted(&self) -> PolicyDeletedFluentBuilder
fn wait_until_policy_deleted(&self) -> PolicyDeletedFluentBuilder
Source§fn wait_until_policy_engine_active(&self) -> PolicyEngineActiveFluentBuilder
fn wait_until_policy_engine_active(&self) -> PolicyEngineActiveFluentBuilder
Source§fn wait_until_policy_engine_deleted(&self) -> PolicyEngineDeletedFluentBuilder
fn wait_until_policy_engine_deleted(&self) -> PolicyEngineDeletedFluentBuilder
Source§fn wait_until_policy_generation_completed(
&self,
) -> PolicyGenerationCompletedFluentBuilder
fn wait_until_policy_generation_completed( &self, ) -> PolicyGenerationCompletedFluentBuilder
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl UnsafeUnpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);