pub struct Client { /* private fields */ }Expand description
Client for AWS DevOps Agent Service
Client for invoking operations on AWS DevOps Agent Service. Each operation on AWS DevOps Agent Service 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_devopsagent::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_devopsagent::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 AssociateService operation has
a Client::associate_service, 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.associate_service()
.agent_space_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.
Implementations§
Source§impl Client
impl Client
Sourcepub fn associate_service(&self) -> AssociateServiceFluentBuilder
pub fn associate_service(&self) -> AssociateServiceFluentBuilder
Constructs a fluent builder for the AssociateService operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
service_id(impl Into<String>)/set_service_id(Option<String>):
required: trueThe unique identifier of the service.
configuration(ServiceConfiguration)/set_configuration(Option<ServiceConfiguration>):
required: trueThe configuration that directs how AgentSpace interacts with the given service.
- On success, responds with
AssociateServiceOutputwith field(s):association(Option<Association>):Represents a service association within an AgentSpace, defining how the agent interacts with external services.
webhook(Option<GenericWebhook>):Generic webhook configuration
- On failure, responds with
SdkError<AssociateServiceError>
Source§impl Client
impl Client
Sourcepub fn create_agent_space(&self) -> CreateAgentSpaceFluentBuilder
pub fn create_agent_space(&self) -> CreateAgentSpaceFluentBuilder
Constructs a fluent builder for the CreateAgentSpace operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the AgentSpace.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the AgentSpace.
locale(impl Into<String>)/set_locale(Option<String>):
required: falseThe locale for the AgentSpace, which determines the language used in agent responses.
kms_key_arn(impl Into<String>)/set_kms_key_arn(Option<String>):
required: falseThe ARN of the AWS Key Management Service (AWS KMS) customer managed key that’s used to encrypt resources.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseClient-provided token to ensure request idempotency. When the same token is provided in subsequent calls, the same response is returned within a 8-hour window.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseTags to add to the AgentSpace at creation time.
- On success, responds with
CreateAgentSpaceOutputwith field(s):agent_space(Option<AgentSpace>):Represents a complete AgentSpace with all its properties, timestamps, encryption settings, and unique identifier.
tags(Option<HashMap::<String, String>>):Tags associated with the created AgentSpace.
- On failure, responds with
SdkError<CreateAgentSpaceError>
Source§impl Client
impl Client
Sourcepub fn create_asset(&self) -> CreateAssetFluentBuilder
pub fn create_asset(&self) -> CreateAssetFluentBuilder
Constructs a fluent builder for the CreateAsset operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space where the asset will be created
asset_type(impl Into<String>)/set_asset_type(Option<String>):
required: trueThe type of asset to create
metadata(Document)/set_metadata(Option<Document>):
required: falseThe metadata describing this asset
content(AssetContent)/set_content(Option<AssetContent>):
required: trueThe content for the asset. Provide a single file or a zip bundle.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier used for idempotent asset creation
- On success, responds with
CreateAssetOutputwith field(s):asset(Option<Asset>):The asset object
- On failure, responds with
SdkError<CreateAssetError>
Source§impl Client
impl Client
Sourcepub fn create_asset_file(&self) -> CreateAssetFileFluentBuilder
pub fn create_asset_file(&self) -> CreateAssetFileFluentBuilder
Constructs a fluent builder for the CreateAssetFile operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the asset
asset_id(impl Into<String>)/set_asset_id(Option<String>):
required: trueThe unique identifier of the asset to create the file in
path(impl Into<String>)/set_path(Option<String>):
required: trueThe path of the file within the asset
content(AssetFileBody)/set_content(Option<AssetFileBody>):
required: trueThe content of the file to create
metadata(Document)/set_metadata(Option<Document>):
required: falseOptional metadata describing this file
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier used for idempotent asset file creation
- On success, responds with
CreateAssetFileOutputwith field(s):file(Option<AssetFile>):The asset file object
- On failure, responds with
SdkError<CreateAssetFileError>
Source§impl Client
impl Client
Sourcepub fn create_backlog_task(&self) -> CreateBacklogTaskFluentBuilder
pub fn create_backlog_task(&self) -> CreateBacklogTaskFluentBuilder
Constructs a fluent builder for the CreateBacklogTask operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space where the task will be created
reference(ReferenceInput)/set_reference(Option<ReferenceInput>):
required: falseOptional reference information for the task
task_type(TaskType)/set_task_type(Option<TaskType>):
required: trueThe type of task being created
title(impl Into<String>)/set_title(Option<String>):
required: trueThe title of the backlog task
description(impl Into<String>)/set_description(Option<String>):
required: falseOptional detailed description of the task
priority(Priority)/set_priority(Option<Priority>):
required: trueThe priority level of the task
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseClient-provided token for idempotent operations
- On success, responds with
CreateBacklogTaskOutputwith field(s):task(Option<Task>):The newly created task object
- On failure, responds with
SdkError<CreateBacklogTaskError>
Source§impl Client
impl Client
Sourcepub fn create_chat(&self) -> CreateChatFluentBuilder
pub fn create_chat(&self) -> CreateChatFluentBuilder
Constructs a fluent builder for the CreateChat operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueUnique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseThe user identifier for the chat. This field is deprecated and will be ignored — the service resolves user identity from the authenticated session.
user_type(UserType)/set_user_type(Option<UserType>):
required: falseThe authentication type of the user
- On success, responds with
CreateChatOutputwith field(s):execution_id(String):The unique identifier for the created execution
created_at(DateTime):Timestamp when the chat was created
- On failure, responds with
SdkError<CreateChatError>
Source§impl Client
impl Client
Sourcepub fn create_private_connection(&self) -> CreatePrivateConnectionFluentBuilder
pub fn create_private_connection(&self) -> CreatePrivateConnectionFluentBuilder
Constructs a fluent builder for the CreatePrivateConnection operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueUnique name for this Private Connection within the account.
mode(PrivateConnectionMode)/set_mode(Option<PrivateConnectionMode>):
required: truePrivate Connection mode configuration.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseTags to add to the Private Connection at creation time.
- On success, responds with
CreatePrivateConnectionOutputwith field(s):name(String):The name of the Private Connection.
r#type(PrivateConnectionType):The type of the Private Connection.
resource_gateway_id(Option<String>):The service-managed Resource Gateway ARN. Only present for service-managed Private Connections.
host_address(Option<String>):IP address or DNS name of the target resource. Only present for service-managed Private Connections.
vpc_id(Option<String>):VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections.
resource_configuration_id(Option<String>):The Resource Configuration ARN. Only present for self-managed Private Connections.
status(PrivateConnectionStatus):The status of the Private Connection.
certificate_expiry_time(Option<DateTime>):The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.
dns_resolution(Option<ResourceConfigDnsResolution>):DNS resolution mode for the Private Connection’s resource gateway.
failure_message(Option<String>):Message describing the reason for a failed Private Connection creation, if applicable.
tags(Option<HashMap::<String, String>>):Tags associated with the created Private Connection.
- On failure, responds with
SdkError<CreatePrivateConnectionError>
Source§impl Client
impl Client
Sourcepub fn create_trigger(&self) -> CreateTriggerFluentBuilder
pub fn create_trigger(&self) -> CreateTriggerFluentBuilder
Constructs a fluent builder for the CreateTrigger operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueUnique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
r#type(impl Into<String>)/set_type(Option<String>):
required: trueHow the new Trigger fires
condition(TriggerCondition)/set_condition(Option<TriggerCondition>):
required: trueThe condition that fires the new Trigger
action(Document)/set_action(Option<Document>):
required: trueThe action the new Trigger performs when it fires
status(impl Into<String>)/set_status(Option<String>):
required: falseThe initial status of the Trigger
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier used for idempotent Trigger creation
- On success, responds with
CreateTriggerOutputwith field(s):trigger(Option<Trigger>):The Trigger object
- On failure, responds with
SdkError<CreateTriggerError>
Source§impl Client
impl Client
Sourcepub fn delete_agent_space(&self) -> DeleteAgentSpaceFluentBuilder
pub fn delete_agent_space(&self) -> DeleteAgentSpaceFluentBuilder
Constructs a fluent builder for the DeleteAgentSpace operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
- On success, responds with
DeleteAgentSpaceOutput - On failure, responds with
SdkError<DeleteAgentSpaceError>
Source§impl Client
impl Client
Sourcepub fn delete_asset(&self) -> DeleteAssetFluentBuilder
pub fn delete_asset(&self) -> DeleteAssetFluentBuilder
Constructs a fluent builder for the DeleteAsset operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the asset
asset_id(impl Into<String>)/set_asset_id(Option<String>):
required: trueThe unique identifier of the asset to delete
- On success, responds with
DeleteAssetOutput - On failure, responds with
SdkError<DeleteAssetError>
Source§impl Client
impl Client
Sourcepub fn delete_asset_file(&self) -> DeleteAssetFileFluentBuilder
pub fn delete_asset_file(&self) -> DeleteAssetFileFluentBuilder
Constructs a fluent builder for the DeleteAssetFile operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the asset
asset_id(impl Into<String>)/set_asset_id(Option<String>):
required: trueThe unique identifier of the asset containing the file
path(impl Into<String>)/set_path(Option<String>):
required: trueThe path of the file within the asset to delete
- On success, responds with
DeleteAssetFileOutput - On failure, responds with
SdkError<DeleteAssetFileError>
Source§impl Client
impl Client
Sourcepub fn delete_private_connection(&self) -> DeletePrivateConnectionFluentBuilder
pub fn delete_private_connection(&self) -> DeletePrivateConnectionFluentBuilder
Constructs a fluent builder for the DeletePrivateConnection operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the Private Connection.
- On success, responds with
DeletePrivateConnectionOutputwith field(s):name(String):The name of the Private Connection.
status(PrivateConnectionStatus):The status of the Private Connection.
- On failure, responds with
SdkError<DeletePrivateConnectionError>
Source§impl Client
impl Client
Sourcepub fn delete_trigger(&self) -> DeleteTriggerFluentBuilder
pub fn delete_trigger(&self) -> DeleteTriggerFluentBuilder
Constructs a fluent builder for the DeleteTrigger operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueUnique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
trigger_id(impl Into<String>)/set_trigger_id(Option<String>):
required: trueGeneric resource identifier (allows alphanumeric characters, hyphens, and underscores; 1-128 characters)
- On success, responds with
DeleteTriggerOutput - On failure, responds with
SdkError<DeleteTriggerError>
Source§impl Client
impl Client
Sourcepub fn deregister_service(&self) -> DeregisterServiceFluentBuilder
pub fn deregister_service(&self) -> DeregisterServiceFluentBuilder
Constructs a fluent builder for the DeregisterService operation.
- The fluent builder is configurable:
service_id(impl Into<String>)/set_service_id(Option<String>):
required: trueThe service id to deregister. A service can only be deregistered if it is not associated with any AgentSpace.
- On success, responds with
DeregisterServiceOutput - On failure, responds with
SdkError<DeregisterServiceError>
Source§impl Client
impl Client
Sourcepub fn describe_private_connection(
&self,
) -> DescribePrivateConnectionFluentBuilder
pub fn describe_private_connection( &self, ) -> DescribePrivateConnectionFluentBuilder
Constructs a fluent builder for the DescribePrivateConnection operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the Private Connection.
- On success, responds with
DescribePrivateConnectionOutputwith field(s):name(String):The name of the Private Connection.
r#type(PrivateConnectionType):The type of the Private Connection.
resource_gateway_id(Option<String>):The service-managed Resource Gateway ARN. Only present for service-managed Private Connections.
host_address(Option<String>):IP address or DNS name of the target resource. Only present for service-managed Private Connections.
vpc_id(Option<String>):VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections.
resource_configuration_id(Option<String>):The Resource Configuration ARN. Only present for self-managed Private Connections.
status(PrivateConnectionStatus):The status of the Private Connection.
certificate_expiry_time(Option<DateTime>):The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.
dns_resolution(Option<ResourceConfigDnsResolution>):DNS resolution mode for the Private Connection’s resource gateway.
failure_message(Option<String>):Message describing the reason for a failed Private Connection, if applicable.
tags(Option<HashMap::<String, String>>):Tags associated with the Private Connection.
- On failure, responds with
SdkError<DescribePrivateConnectionError>
Source§impl Client
impl Client
Sourcepub fn disable_operator_app(&self) -> DisableOperatorAppFluentBuilder
pub fn disable_operator_app(&self) -> DisableOperatorAppFluentBuilder
Constructs a fluent builder for the DisableOperatorApp operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
auth_flow(AuthFlow)/set_auth_flow(Option<AuthFlow>):
required: falseThe authentication flow configured for the operator App. e.g. idc
- On success, responds with
DisableOperatorAppOutput - On failure, responds with
SdkError<DisableOperatorAppError>
Source§impl Client
impl Client
Sourcepub fn disassociate_service(&self) -> DisassociateServiceFluentBuilder
pub fn disassociate_service(&self) -> DisassociateServiceFluentBuilder
Constructs a fluent builder for the DisassociateService operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
association_id(impl Into<String>)/set_association_id(Option<String>):
required: trueThe unique identifier of the given association.
- On success, responds with
DisassociateServiceOutput - On failure, responds with
SdkError<DisassociateServiceError>
Source§impl Client
impl Client
Sourcepub fn enable_operator_app(&self) -> EnableOperatorAppFluentBuilder
pub fn enable_operator_app(&self) -> EnableOperatorAppFluentBuilder
Constructs a fluent builder for the EnableOperatorApp operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
auth_flow(AuthFlow)/set_auth_flow(Option<AuthFlow>):
required: trueThe authentication flow configured for the operator App. e.g. iam or idc
operator_app_role_arn(impl Into<String>)/set_operator_app_role_arn(Option<String>):
required: trueThe IAM role end users assume to access AIDevOps APIs
idc_instance_arn(impl Into<String>)/set_idc_instance_arn(Option<String>):
required: falseThe IdC instance Arn used to create an IdC auth application
issuer_url(impl Into<String>)/set_issuer_url(Option<String>):
required: falseThe OIDC issuer URL of the external Identity Provider
idp_client_id(impl Into<String>)/set_idp_client_id(Option<String>):
required: falseThe OIDC client ID for the IdP application
idp_client_secret(impl Into<String>)/set_idp_client_secret(Option<String>):
required: falseThe OIDC client secret for the IdP application
provider(impl Into<String>)/set_provider(Option<String>):
required: falseThe Identity Provider name (e.g., Entra, Okta, Google)
- On success, responds with
EnableOperatorAppOutputwith field(s):agent_space_id(String):The unique identifier of the AgentSpace
operator_app_url(Option<String>):The URL for operators to access the Operator App
iam(Option<IamAuthConfiguration>):Configuration for IAM-based authentication flow for the Operator App.
idc(Option<IdcAuthConfiguration>):Configuration for AWS Identity Center (IdC) authentication flow for the Operator App.
idp(Option<IdpAuthConfiguration>):Configuration for external Identity Provider OIDC authentication flow for the Operator App.
- On failure, responds with
SdkError<EnableOperatorAppError>
Source§impl Client
impl Client
Sourcepub fn get_account_usage(&self) -> GetAccountUsageFluentBuilder
pub fn get_account_usage(&self) -> GetAccountUsageFluentBuilder
Constructs a fluent builder for the GetAccountUsage operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
GetAccountUsageOutputwith field(s):monthly_account_investigation_hours(Option<UsageMetric>):Monthly investigation hours usage and limit for an account
monthly_account_evaluation_hours(Option<UsageMetric>):Monthly evaluation hours usage and limit for an account
monthly_account_system_learning_hours(Option<UsageMetric>):Monthly system learning hours usage and limit for an account
monthly_account_on_demand_hours(Option<UsageMetric>):Monthly on-demand hours usage and limit for an account
usage_period_start_time(DateTime):The start time of the usage tracking period
usage_period_end_time(DateTime):The end time of the usage tracking period
- On failure, responds with
SdkError<GetAccountUsageError>
Source§impl Client
impl Client
Sourcepub fn get_agent_space(&self) -> GetAgentSpaceFluentBuilder
pub fn get_agent_space(&self) -> GetAgentSpaceFluentBuilder
Constructs a fluent builder for the GetAgentSpace operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
- On success, responds with
GetAgentSpaceOutputwith field(s):agent_space(Option<AgentSpace>):Represents a complete AgentSpace with all its properties, timestamps, encryption settings, and unique identifier.
tags(Option<HashMap::<String, String>>):Tags associated with the AgentSpace.
- On failure, responds with
SdkError<GetAgentSpaceError>
Source§impl Client
impl Client
Sourcepub fn get_asset(&self) -> GetAssetFluentBuilder
pub fn get_asset(&self) -> GetAssetFluentBuilder
Constructs a fluent builder for the GetAsset operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the asset
asset_id(impl Into<String>)/set_asset_id(Option<String>):
required: trueThe unique identifier of the asset to retrieve
asset_version(i32)/set_asset_version(Option<i32>):
required: falseThe specific version of the asset to retrieve. If omitted, the latest version is returned.
- On success, responds with
GetAssetOutputwith field(s):asset(Option<Asset>):The asset object
- On failure, responds with
SdkError<GetAssetError>
Source§impl Client
impl Client
Sourcepub fn get_asset_content(&self) -> GetAssetContentFluentBuilder
pub fn get_asset_content(&self) -> GetAssetContentFluentBuilder
Constructs a fluent builder for the GetAssetContent operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the asset
asset_id(impl Into<String>)/set_asset_id(Option<String>):
required: trueThe unique identifier of the asset
asset_version(i32)/set_asset_version(Option<i32>):
required: falseThe specific asset version to export. If omitted, the latest version is returned.
- On success, responds with
GetAssetContentOutputwith field(s):content(Option<AssetZipContent>):The asset content as a zip file
version(i32):The asset version this content belongs to
- On failure, responds with
SdkError<GetAssetContentError>
Source§impl Client
impl Client
Sourcepub fn get_asset_file(&self) -> GetAssetFileFluentBuilder
pub fn get_asset_file(&self) -> GetAssetFileFluentBuilder
Constructs a fluent builder for the GetAssetFile operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the asset
asset_id(impl Into<String>)/set_asset_id(Option<String>):
required: trueThe unique identifier of the asset containing the file
path(impl Into<String>)/set_path(Option<String>):
required: trueThe path of the file within the asset to retrieve
asset_version(i32)/set_asset_version(Option<i32>):
required: falseThe specific asset version to retrieve the file from. If omitted, the latest version is returned.
- On success, responds with
GetAssetFileOutputwith field(s):file(Option<AssetFile>):The asset file object
- On failure, responds with
SdkError<GetAssetFileError>
Source§impl Client
impl Client
Sourcepub fn get_association(&self) -> GetAssociationFluentBuilder
pub fn get_association(&self) -> GetAssociationFluentBuilder
Constructs a fluent builder for the GetAssociation operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
association_id(impl Into<String>)/set_association_id(Option<String>):
required: trueThe unique identifier of the given association.
- On success, responds with
GetAssociationOutputwith field(s):association(Option<Association>):Represents a service association within an AgentSpace, defining how the agent interacts with external services.
- On failure, responds with
SdkError<GetAssociationError>
Source§impl Client
impl Client
Sourcepub fn get_backlog_task(&self) -> GetBacklogTaskFluentBuilder
pub fn get_backlog_task(&self) -> GetBacklogTaskFluentBuilder
Constructs a fluent builder for the GetBacklogTask operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the task
task_id(impl Into<String>)/set_task_id(Option<String>):
required: trueThe unique identifier of the task to retrieve
- On success, responds with
GetBacklogTaskOutputwith field(s):task(Option<Task>):The requested task object
- On failure, responds with
SdkError<GetBacklogTaskError>
Source§impl Client
impl Client
Sourcepub fn get_operator_app(&self) -> GetOperatorAppFluentBuilder
pub fn get_operator_app(&self) -> GetOperatorAppFluentBuilder
Constructs a fluent builder for the GetOperatorApp operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
- On success, responds with
GetOperatorAppOutputwith field(s):operator_app_url(Option<String>):The URL for operators to access the Operator App
iam(Option<IamAuthConfiguration>):Configuration for IAM-based authentication flow for the Operator App.
idc(Option<IdcAuthConfiguration>):Configuration for AWS Identity Center (IdC) authentication flow for the Operator App.
idp(Option<IdpAuthConfiguration>):Configuration for external Identity Provider OIDC authentication flow for the Operator App.
- On failure, responds with
SdkError<GetOperatorAppError>
Source§impl Client
impl Client
Sourcepub fn get_recommendation(&self) -> GetRecommendationFluentBuilder
pub fn get_recommendation(&self) -> GetRecommendationFluentBuilder
Constructs a fluent builder for the GetRecommendation operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the recommendation
recommendation_id(impl Into<String>)/set_recommendation_id(Option<String>):
required: trueThe unique identifier for the recommendation to retrieve
recommendation_version(i64)/set_recommendation_version(Option<i64>):
required: falseSpecific version of the recommendation to retrieve. If not specified, returns the latest version.
- On success, responds with
GetRecommendationOutputwith field(s):recommendation(Option<Recommendation>):The requested recommendation
- On failure, responds with
SdkError<GetRecommendationError>
Source§impl Client
impl Client
Sourcepub fn get_service(&self) -> GetServiceFluentBuilder
pub fn get_service(&self) -> GetServiceFluentBuilder
Constructs a fluent builder for the GetService operation.
- The fluent builder is configurable:
service_id(impl Into<String>)/set_service_id(Option<String>):
required: trueThe unique identifier of the given service.
- On success, responds with
GetServiceOutputwith field(s):service(Option<RegisteredService>):Represents a registered service with its configuration and accessible resources.
tags(Option<HashMap::<String, String>>):Tags associated with the Service.
- On failure, responds with
SdkError<GetServiceError>
Source§impl Client
impl Client
Sourcepub fn get_trigger(&self) -> GetTriggerFluentBuilder
pub fn get_trigger(&self) -> GetTriggerFluentBuilder
Constructs a fluent builder for the GetTrigger operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueUnique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
trigger_id(impl Into<String>)/set_trigger_id(Option<String>):
required: trueGeneric resource identifier (allows alphanumeric characters, hyphens, and underscores; 1-128 characters)
- On success, responds with
GetTriggerOutputwith field(s):trigger(Option<Trigger>):The Trigger object
- On failure, responds with
SdkError<GetTriggerError>
Source§impl Client
impl Client
Sourcepub fn list_agent_spaces(&self) -> ListAgentSpacesFluentBuilder
pub fn list_agent_spaces(&self) -> ListAgentSpacesFluentBuilder
Constructs a fluent builder for the ListAgentSpaces operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseToken for the next page of results.
- On success, responds with
ListAgentSpacesOutputwith field(s):next_token(Option<String>):Token to retrieve the next page of results, if there are more results.
agent_spaces(Vec::<AgentSpace>):The list of AgentSpaces.
- On failure, responds with
SdkError<ListAgentSpacesError>
Source§impl Client
impl Client
Sourcepub fn list_asset_files(&self) -> ListAssetFilesFluentBuilder
pub fn list_asset_files(&self) -> ListAssetFilesFluentBuilder
Constructs a fluent builder for the ListAssetFiles operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the asset
asset_id(impl Into<String>)/set_asset_id(Option<String>):
required: trueThe unique identifier of the asset whose files to list
asset_version(i32)/set_asset_version(Option<i32>):
required: falseThe specific asset version to list files from. If omitted, files from the latest version are returned.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falsePagination token from a previous response to retrieve the next page of results
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single response
- On success, responds with
ListAssetFilesOutputwith field(s):items(Vec::<AssetFileSummary>):The list of asset file summaries
next_token(Option<String>):Pagination token to retrieve the next page of results. Absent when there are no more results.
- On failure, responds with
SdkError<ListAssetFilesError>
Source§impl Client
impl Client
Sourcepub fn list_asset_types(&self) -> ListAssetTypesFluentBuilder
pub fn list_asset_types(&self) -> ListAssetTypesFluentBuilder
Constructs a fluent builder for the ListAssetTypes 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 from a previous response to retrieve the next page of results
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single response
- On success, responds with
ListAssetTypesOutputwith field(s):items(Vec::<AssetTypeSummary>):The list of supported asset types
next_token(Option<String>):Pagination token to retrieve the next page of results. Absent when there are no more results.
- On failure, responds with
SdkError<ListAssetTypesError>
Source§impl Client
impl Client
Sourcepub fn list_asset_versions(&self) -> ListAssetVersionsFluentBuilder
pub fn list_asset_versions(&self) -> ListAssetVersionsFluentBuilder
Constructs a fluent builder for the ListAssetVersions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the asset
asset_id(impl Into<String>)/set_asset_id(Option<String>):
required: trueThe unique identifier of the asset whose versions to list
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single response
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falsePagination token from a previous response to retrieve the next page of results
- On success, responds with
ListAssetVersionsOutputwith field(s):items(Vec::<AssetVersionMetadata>):The list of version metadata for the asset
next_token(Option<String>):Pagination token to retrieve the next page of results. Absent when there are no more results.
- On failure, responds with
SdkError<ListAssetVersionsError>
Source§impl Client
impl Client
Sourcepub fn list_assets(&self) -> ListAssetsFluentBuilder
pub fn list_assets(&self) -> ListAssetsFluentBuilder
Constructs a fluent builder for the ListAssets operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space to list assets from
asset_type(impl Into<String>)/set_asset_type(Option<String>):
required: falseFilter results to only assets of this type
updated_after(DateTime)/set_updated_after(Option<DateTime>):
required: falseFilter results to only assets updated after this timestamp
updated_before(DateTime)/set_updated_before(Option<DateTime>):
required: falseFilter results to only assets updated before this timestamp
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falsePagination token from a previous response to retrieve the next page of results
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single response
- On success, responds with
ListAssetsOutputwith field(s):items(Vec::<Asset>):The list of assets for the agent space
next_token(Option<String>):Pagination token to retrieve the next page of results. Absent when there are no more results.
- On failure, responds with
SdkError<ListAssetsError>
Source§impl Client
impl Client
Sourcepub fn list_associations(&self) -> ListAssociationsFluentBuilder
pub fn list_associations(&self) -> ListAssociationsFluentBuilder
Constructs a fluent builder for the ListAssociations operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseToken for the next page of results.
filter_service_types(impl Into<String>)/set_filter_service_types(Option<String>):
required: falseA comma-separated list of service types to filter list associations output
- On success, responds with
ListAssociationsOutputwith field(s):next_token(Option<String>):Token to retrieve the next page of results, if there are more results.
associations(Vec::<Association>):The list of associations.
- On failure, responds with
SdkError<ListAssociationsError>
Source§impl Client
impl Client
Sourcepub fn list_backlog_tasks(&self) -> ListBacklogTasksFluentBuilder
pub fn list_backlog_tasks(&self) -> ListBacklogTasksFluentBuilder
Constructs a fluent builder for the ListBacklogTasks operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the tasks
filter(TaskFilter)/set_filter(Option<TaskFilter>):
required: falseFilter criteria to apply when listing tasks Filtering restrictions: - Each filter field list is limited to a single value - Filtering by Priority and Status at the same time when not filtering by Type is not permitted - Timestamp filters (createdAfter, createdBefore) can be combined with other filters when not sorting by priority
limit(i32)/set_limit(Option<i32>):
required: falseMaximum number of tasks to return in a single response (1-1000, default: 100)
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseToken for retrieving the next page of results
sort_field(TaskSortField)/set_sort_field(Option<TaskSortField>):
required: falseField to sort by Sorting restrictions: - Only sorting on createdAt is supported when using priority or status filters alone. - Sorting by priority is not supported when using Timestamp filters (createdAfter, createdBefore)
order(TaskSortOrder)/set_order(Option<TaskSortOrder>):
required: falseSort order for the tasks based on sortField (default: DESC)
- On success, responds with
ListBacklogTasksOutputwith field(s):tasks(Vec::<Task>):List of backlog tasks
next_token(Option<String>):Token for retrieving the next page of results, if more results are available
- On failure, responds with
SdkError<ListBacklogTasksError>
Source§impl Client
impl Client
Sourcepub fn list_chats(&self) -> ListChatsFluentBuilder
pub fn list_chats(&self) -> ListChatsFluentBuilder
Constructs a fluent builder for the ListChats operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueUnique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseThe user identifier to list chats for. This field is deprecated and will be ignored — the service resolves user identity from the authenticated session.
max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseToken for pagination
- On success, responds with
ListChatsOutputwith field(s):executions(Vec::<ChatExecution>):List of recent chat executions
next_token(Option<String>):Token for retrieving the next page of results
- On failure, responds with
SdkError<ListChatsError>
Source§impl Client
impl Client
Sourcepub fn list_executions(&self) -> ListExecutionsFluentBuilder
pub fn list_executions(&self) -> ListExecutionsFluentBuilder
Constructs a fluent builder for the ListExecutions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space
task_id(impl Into<String>)/set_task_id(Option<String>):
required: trueThe unique identifier of the task whose executions to retrieve
limit(i32)/set_limit(Option<i32>):
required: falseMaximum number of executions to return
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseToken for pagination to retrieve the next set of results
- On success, responds with
ListExecutionsOutputwith field(s):executions(Vec::<Execution>):List of executions
next_token(Option<String>):Token for retrieving the next page of results, if available
- On failure, responds with
SdkError<ListExecutionsError>
Source§impl Client
impl Client
Sourcepub fn list_goals(&self) -> ListGoalsFluentBuilder
pub fn list_goals(&self) -> ListGoalsFluentBuilder
Constructs a fluent builder for the ListGoals operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space
status(GoalStatus)/set_status(Option<GoalStatus>):
required: falseFilter goals by goal status
goal_type(GoalType)/set_goal_type(Option<GoalType>):
required: falseFilter goals by goal type
limit(i32)/set_limit(Option<i32>):
required: falseMaximum number of goals to return
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falsePagination token for the next set of results
- On success, responds with
ListGoalsOutputwith field(s):goals(Vec::<Goal>):List of goals matching the criteria
next_token(Option<String>):Pagination token for the next set of results
- On failure, responds with
SdkError<ListGoalsError>
Source§impl Client
impl Client
Sourcepub fn list_journal_records(&self) -> ListJournalRecordsFluentBuilder
pub fn list_journal_records(&self) -> ListJournalRecordsFluentBuilder
Constructs a fluent builder for the ListJournalRecords operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the execution
execution_id(impl Into<String>)/set_execution_id(Option<String>):
required: trueThe unique identifier of the execution whose journal records to retrieve
limit(i32)/set_limit(Option<i32>):
required: falseMaximum number of records to return in a single response (1-100, default: 100)
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseToken for retrieving the next page of results
record_type(impl Into<String>)/set_record_type(Option<String>):
required: falseFilter records by type (empty string returns all types)
order(OrderType)/set_order(Option<OrderType>):
required: falseSort order for the records based on timestamp (default: DESC)
- On success, responds with
ListJournalRecordsOutputwith field(s):records(Vec::<JournalRecord>):List of journal records matching the request criteria
next_token(Option<String>):Token for retrieving the next page of results, if more results are available
- On failure, responds with
SdkError<ListJournalRecordsError>
Source§impl Client
impl Client
Sourcepub fn list_pending_messages(&self) -> ListPendingMessagesFluentBuilder
pub fn list_pending_messages(&self) -> ListPendingMessagesFluentBuilder
Constructs a fluent builder for the ListPendingMessages operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueUnique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
execution_id(impl Into<String>)/set_execution_id(Option<String>):
required: trueThe unique identifier of the execution whose journal records to retrieve
- On success, responds with
ListPendingMessagesOutputwith field(s):agent_space_id(String):Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
execution_id(String):The unique identifier for the execution.
messages(Vec::<PendingMessage>):The list of pending messages for the execution.
created_at(DateTime):Timestamp when the pending messages were created.
- On failure, responds with
SdkError<ListPendingMessagesError>
Source§impl Client
impl Client
Sourcepub fn list_private_connections(&self) -> ListPrivateConnectionsFluentBuilder
pub fn list_private_connections(&self) -> ListPrivateConnectionsFluentBuilder
Constructs a fluent builder for the ListPrivateConnections operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
ListPrivateConnectionsOutputwith field(s):private_connections(Vec::<PrivateConnectionSummary>):The list of Private Connections.
- On failure, responds with
SdkError<ListPrivateConnectionsError>
Source§impl Client
impl Client
Sourcepub fn list_recommendations(&self) -> ListRecommendationsFluentBuilder
pub fn list_recommendations(&self) -> ListRecommendationsFluentBuilder
Constructs a fluent builder for the ListRecommendations operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the recommendations
task_id(impl Into<String>)/set_task_id(Option<String>):
required: falseOptional task ID to filter recommendations by specific task
goal_id(impl Into<String>)/set_goal_id(Option<String>):
required: falseOptional goal ID to filter recommendations by specific goal
status(RecommendationStatus)/set_status(Option<RecommendationStatus>):
required: falseOptional status to filter recommendations by their current status
priority(RecommendationPriority)/set_priority(Option<RecommendationPriority>):
required: falseOptional priority to filter recommendations by priority level
limit(i32)/set_limit(Option<i32>):
required: falseMaximum number of recommendations to return in a single response
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseToken for retrieving the next page of results
- On success, responds with
ListRecommendationsOutputwith field(s):recommendations(Vec::<Recommendation>):List of recommendations matching the request criteria
next_token(Option<String>):Token for retrieving the next page of results, if more results are available
- On failure, responds with
SdkError<ListRecommendationsError>
Source§impl Client
impl Client
Sourcepub fn list_services(&self) -> ListServicesFluentBuilder
pub fn list_services(&self) -> ListServicesFluentBuilder
Constructs a fluent builder for the ListServices operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseMaximum number of results to return in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseToken for the next page of results.
filter_service_type(Service)/set_filter_service_type(Option<Service>):
required: falseOptional filter to list only services of a specific type.
- On success, responds with
ListServicesOutputwith field(s):next_token(Option<String>):Token to retrieve the next page of results, if there are more results.
services(Vec::<RegisteredService>):List of registered services.
- On failure, responds with
SdkError<ListServicesError>
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 ARN of the resource.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(HashMap::<String, String>):Tags associated with the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn list_triggers(&self) -> ListTriggersFluentBuilder
pub fn list_triggers(&self) -> ListTriggersFluentBuilder
Constructs a fluent builder for the ListTriggers operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueUnique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
status(impl Into<String>)/set_status(Option<String>):
required: falseFilter results to Triggers in this status
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falsePagination token from a previous response to retrieve the next page of results
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single response
- On success, responds with
ListTriggersOutputwith field(s):items(Vec::<Trigger>):The list of Triggers
next_token(Option<String>):Pagination token for list operations (1-2048 characters)
- On failure, responds with
SdkError<ListTriggersError>
Source§impl Client
impl Client
Sourcepub fn list_webhooks(&self) -> ListWebhooksFluentBuilder
pub fn list_webhooks(&self) -> ListWebhooksFluentBuilder
Constructs a fluent builder for the ListWebhooks operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
association_id(impl Into<String>)/set_association_id(Option<String>):
required: trueThe unique identifier of the given association.
- On success, responds with
ListWebhooksOutputwith field(s):webhooks(Vec::<Webhook>):The list of association webhooks.
- On failure, responds with
SdkError<ListWebhooksError>
Source§impl Client
impl Client
Sourcepub fn register_service(&self) -> RegisterServiceFluentBuilder
pub fn register_service(&self) -> RegisterServiceFluentBuilder
Constructs a fluent builder for the RegisterService operation.
- The fluent builder is configurable:
service(PostRegisterServiceSupportedService)/set_service(Option<PostRegisterServiceSupportedService>):
required: trueServices that can be registered via the post-registration API (excludes OAuth 3LO services).
service_details(ServiceDetails)/set_service_details(Option<ServiceDetails>):
required: trueService-specific authorization configuration parameters
kms_key_arn(impl Into<String>)/set_kms_key_arn(Option<String>):
required: falseThe ARN of the AWS Key Management Service (AWS KMS) customer managed key that’s used to encrypt resources.
private_connection_name(impl Into<String>)/set_private_connection_name(Option<String>):
required: falseThe name of the private connection to use for VPC connectivity.
target_url_private_connection_name(impl Into<String>)/set_target_url_private_connection_name(Option<String>):
required: falseThe name of the private connection to use for API calls (target URL) only. Cannot be specified when privateConnectionName is provided.
exchange_url_private_connection_name(impl Into<String>)/set_exchange_url_private_connection_name(Option<String>):
required: falseThe name of the private connection to use for OAuth token exchange requests only. Cannot be specified when privateConnectionName is provided.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe display name for the service registration.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseTags to add to the Service at registration time.
- On success, responds with
RegisterServiceOutputwith field(s):service_id(Option<String>):Service ID - present when registration is complete, absent when additional steps are required
additional_step(Option<AdditionalServiceRegistrationStep>):Indicates if additional steps are required to complete service registration (e.g., 3-legged OAuth)
kms_key_arn(Option<String>):The ARN of the AWS Key Management Service (AWS KMS) customer managed key that’s used to encrypt resources.
tags(Option<HashMap::<String, String>>):Tags associated with the registered Service.
- On failure, responds with
SdkError<RegisterServiceError>
Source§impl Client
impl Client
Sourcepub fn send_message(&self) -> SendMessageFluentBuilder
pub fn send_message(&self) -> SendMessageFluentBuilder
Constructs a fluent builder for the SendMessage operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe agent space identifier
execution_id(impl Into<String>)/set_execution_id(Option<String>):
required: trueThe execution identifier for the chat session
content(impl Into<String>)/set_content(Option<String>):
required: trueThe user message content
context(SendMessageContext)/set_context(Option<SendMessageContext>):
required: falseOptional context for the message
user_id(impl Into<String>)/set_user_id(Option<String>):
required: falseUser identifier. This field is deprecated and will be ignored — the service resolves user identity from the authenticated session.
asset_ids(impl Into<String>)/set_asset_ids(Option<Vec::<String>>):
required: falseOptional list of asset identifiers to attach to the message
- On success, responds with
SendMessageOutputwith field(s):events(EventReceiver<SendMessageEvents, SendMessageEventsError>):The stream of chat message events
- On failure, responds with
SdkError<SendMessageError>
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 ARN of the resource to tag.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: trueTags to add to the resource.
- 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 ARN of the resource to untag.
tag_keys(impl Into<String>)/set_tag_keys(Option<Vec::<String>>):
required: trueTag keys to remove.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_agent_space(&self) -> UpdateAgentSpaceFluentBuilder
pub fn update_agent_space(&self) -> UpdateAgentSpaceFluentBuilder
Constructs a fluent builder for the UpdateAgentSpace operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
name(impl Into<String>)/set_name(Option<String>):
required: falseThe updated name of the AgentSpace.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe updated description of the AgentSpace.
locale(impl Into<String>)/set_locale(Option<String>):
required: falseThe updated locale for the AgentSpace, which determines the language used in agent responses.
- On success, responds with
UpdateAgentSpaceOutputwith field(s):agent_space(Option<AgentSpace>):Represents a complete AgentSpace with all its properties, timestamps, encryption settings, and unique identifier.
- On failure, responds with
SdkError<UpdateAgentSpaceError>
Source§impl Client
impl Client
Sourcepub fn update_asset(&self) -> UpdateAssetFluentBuilder
pub fn update_asset(&self) -> UpdateAssetFluentBuilder
Constructs a fluent builder for the UpdateAsset operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the asset
asset_id(impl Into<String>)/set_asset_id(Option<String>):
required: trueThe unique identifier of the asset to update
metadata(Document)/set_metadata(Option<Document>):
required: falseMetadata fields to update. Only the fields present in this document are updated. Omitted fields retain their current values.
content(AssetContent)/set_content(Option<AssetContent>):
required: falseOptional content to set or replace. A single file adds or replaces one file; a zip replaces all files.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier used for idempotent asset update
- On success, responds with
UpdateAssetOutputwith field(s):asset(Option<Asset>):The asset object
- On failure, responds with
SdkError<UpdateAssetError>
Source§impl Client
impl Client
Sourcepub fn update_asset_file(&self) -> UpdateAssetFileFluentBuilder
pub fn update_asset_file(&self) -> UpdateAssetFileFluentBuilder
Constructs a fluent builder for the UpdateAssetFile operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the asset
asset_id(impl Into<String>)/set_asset_id(Option<String>):
required: trueThe unique identifier of the asset containing the file
path(impl Into<String>)/set_path(Option<String>):
required: trueThe path of the file within the asset to update
content(AssetFileBody)/set_content(Option<AssetFileBody>):
required: falseUpdated file content. If omitted, the existing content is unchanged.
metadata(Document)/set_metadata(Option<Document>):
required: falseMetadata fields to update. Only the fields present in this document are updated. Omitted fields retain their current values.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier used for idempotent asset file update
- On success, responds with
UpdateAssetFileOutputwith field(s):file(Option<AssetFile>):The asset file object
- On failure, responds with
SdkError<UpdateAssetFileError>
Source§impl Client
impl Client
Sourcepub fn update_association(&self) -> UpdateAssociationFluentBuilder
pub fn update_association(&self) -> UpdateAssociationFluentBuilder
Constructs a fluent builder for the UpdateAssociation operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
association_id(impl Into<String>)/set_association_id(Option<String>):
required: trueThe unique identifier of the given association.
configuration(ServiceConfiguration)/set_configuration(Option<ServiceConfiguration>):
required: trueThe configuration that directs how AgentSpace interacts with the given service. The entire configuration is replaced on update.
- On success, responds with
UpdateAssociationOutputwith field(s):association(Option<Association>):Represents a service association within an AgentSpace, defining how the agent interacts with external services.
webhook(Option<GenericWebhook>):Generic webhook configuration
- On failure, responds with
SdkError<UpdateAssociationError>
Source§impl Client
impl Client
Sourcepub fn update_backlog_task(&self) -> UpdateBacklogTaskFluentBuilder
pub fn update_backlog_task(&self) -> UpdateBacklogTaskFluentBuilder
Constructs a fluent builder for the UpdateBacklogTask operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the task
task_id(impl Into<String>)/set_task_id(Option<String>):
required: trueThe unique identifier of the task to update
task_status(TaskStatus)/set_task_status(Option<TaskStatus>):
required: falseUpdated task status
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseClient-provided token for idempotent operations
- On success, responds with
UpdateBacklogTaskOutputwith field(s):task(Option<Task>):The updated task object
- On failure, responds with
SdkError<UpdateBacklogTaskError>
Source§impl Client
impl Client
Sourcepub fn update_goal(&self) -> UpdateGoalFluentBuilder
pub fn update_goal(&self) -> UpdateGoalFluentBuilder
Constructs a fluent builder for the UpdateGoal operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the goal
goal_id(impl Into<String>)/set_goal_id(Option<String>):
required: trueThe unique identifier of the goal to update
evaluation_schedule(GoalScheduleInput)/set_evaluation_schedule(Option<GoalScheduleInput>):
required: falseUpdate goal schedule state
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseClient-provided token for idempotent operations
- On success, responds with
UpdateGoalOutputwith field(s):goal(Option<Goal>):The updated goal object
- On failure, responds with
SdkError<UpdateGoalError>
Source§impl Client
impl Client
Sourcepub fn update_operator_app_idp_config(
&self,
) -> UpdateOperatorAppIdpConfigFluentBuilder
pub fn update_operator_app_idp_config( &self, ) -> UpdateOperatorAppIdpConfigFluentBuilder
Constructs a fluent builder for the UpdateOperatorAppIdpConfig operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
idp_client_secret(impl Into<String>)/set_idp_client_secret(Option<String>):
required: falseThe OIDC client secret for the IdP application
- On success, responds with
UpdateOperatorAppIdpConfigOutputwith field(s):agent_space_id(String):The unique identifier of the AgentSpace
idp(Option<IdpAuthConfiguration>):Configuration for external Identity Provider OIDC authentication flow for the Operator App.
- On failure, responds with
SdkError<UpdateOperatorAppIdpConfigError>
Source§impl Client
impl Client
Sourcepub fn update_private_connection_certificate(
&self,
) -> UpdatePrivateConnectionCertificateFluentBuilder
pub fn update_private_connection_certificate( &self, ) -> UpdatePrivateConnectionCertificateFluentBuilder
Constructs a fluent builder for the UpdatePrivateConnectionCertificate operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the Private Connection.
certificate(impl Into<String>)/set_certificate(Option<String>):
required: trueThe new certificate for the Private Connection.
- On success, responds with
UpdatePrivateConnectionCertificateOutputwith field(s):name(String):The name of the Private Connection.
r#type(PrivateConnectionType):The type of the Private Connection.
resource_gateway_id(Option<String>):The service-managed Resource Gateway ARN. Only present for service-managed Private Connections.
host_address(Option<String>):IP address or DNS name of the target resource. Only present for service-managed Private Connections.
vpc_id(Option<String>):VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections.
resource_configuration_id(Option<String>):The Resource Configuration ARN. Only present for self-managed Private Connections.
status(PrivateConnectionStatus):The status of the Private Connection.
certificate_expiry_time(Option<DateTime>):The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.
dns_resolution(Option<ResourceConfigDnsResolution>):DNS resolution mode for the Private Connection’s resource gateway.
failure_message(Option<String>):Message describing the reason for a failed Private Connection update, if applicable.
- On failure, responds with
SdkError<UpdatePrivateConnectionCertificateError>
Source§impl Client
impl Client
Sourcepub fn update_recommendation(&self) -> UpdateRecommendationFluentBuilder
pub fn update_recommendation(&self) -> UpdateRecommendationFluentBuilder
Constructs a fluent builder for the UpdateRecommendation operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier for the agent space containing the recommendation
recommendation_id(impl Into<String>)/set_recommendation_id(Option<String>):
required: trueThe unique identifier for the recommendation to update
status(RecommendationStatus)/set_status(Option<RecommendationStatus>):
required: falseCurrent status of the recommendation
additional_context(impl Into<String>)/set_additional_context(Option<String>):
required: falseAdditional context for recommendation
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique token that ensures idempotency of the request
- On success, responds with
UpdateRecommendationOutputwith field(s):recommendation(Option<Recommendation>):The updated recommendation
- On failure, responds with
SdkError<UpdateRecommendationError>
Source§impl Client
impl Client
Sourcepub fn update_trigger(&self) -> UpdateTriggerFluentBuilder
pub fn update_trigger(&self) -> UpdateTriggerFluentBuilder
Constructs a fluent builder for the UpdateTrigger operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueUnique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
trigger_id(impl Into<String>)/set_trigger_id(Option<String>):
required: trueGeneric resource identifier (allows alphanumeric characters, hyphens, and underscores; 1-128 characters)
status(impl Into<String>)/set_status(Option<String>):
required: falseThe new status for the Trigger
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier used for idempotent Trigger update
- On success, responds with
UpdateTriggerOutputwith field(s):trigger(Option<Trigger>):The Trigger object
- On failure, responds with
SdkError<UpdateTriggerError>
Source§impl Client
impl Client
Sourcepub fn validate_aws_associations(&self) -> ValidateAwsAssociationsFluentBuilder
pub fn validate_aws_associations(&self) -> ValidateAwsAssociationsFluentBuilder
Constructs a fluent builder for the ValidateAwsAssociations operation.
- The fluent builder is configurable:
agent_space_id(impl Into<String>)/set_agent_space_id(Option<String>):
required: trueThe unique identifier of the AgentSpace
- On success, responds with
ValidateAwsAssociationsOutput - On failure, responds with
SdkError<ValidateAwsAssociationsError>
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§
Auto Trait Implementations§
impl !RefUnwindSafe for Client
impl !UnwindSafe for Client
impl Freeze for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl UnsafeUnpin 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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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);