DevOpsAgentClient

AWS DevOps Agent is your always-available operations teammate. It resolves and proactively prevents incidents, optimizes application reliability and performance, and handles on-demand SRE tasks across AWS, multicloud, and on-premises environments. AWS DevOps Agent investigates incidents as an experienced DevOps engineer would. It learns your applications and their relationships. It works with your observability tools, runbooks, code repositories, and CI/CD pipelines. The agent correlates telemetry, code, and deployment data across all of them.

Properties

Link copied to clipboard
abstract override val config: DevOpsAgentClient.Config

DevOpsAgentClient's configuration

Functions

Link copied to clipboard

Adds a specific service association to an AgentSpace. It overwrites the existing association of the same service. Returns 201 Created on success.

Link copied to clipboard

Creates a new AgentSpace with the specified name and description. Duplicate space names are allowed.

Link copied to clipboard
abstract suspend fun createAsset(input: CreateAssetRequest): CreateAssetResponse

Creates a new asset in the specified agent space

Link copied to clipboard

Creates a file in an asset

Link copied to clipboard

Creates a new backlog task in the specified agent space

Link copied to clipboard
abstract suspend fun createChat(input: CreateChatRequest): CreateChatResponse

Creates a new chat execution in the specified agent space

Link copied to clipboard

Creates a Private Connection to a target resource.

Link copied to clipboard

Creates a new Trigger in the specified agent space

Link copied to clipboard

Deletes an AgentSpace. This operation is idempotent and returns a 204 No Content response on success.

Link copied to clipboard
abstract suspend fun deleteAsset(input: DeleteAssetRequest): DeleteAssetResponse

Deletes an asset and all its files from the specified agent space

Link copied to clipboard

Deletes a file from an asset

Link copied to clipboard

Deletes a Private Connection. The deletion is asynchronous and returns DELETE_IN_PROGRESS status.

Link copied to clipboard

Deletes a Trigger from the specified agent space

Link copied to clipboard

Deregister a service

Link copied to clipboard

Retrieves details of an existing Private Connection.

Link copied to clipboard

Disable the Operator App for the specified AgentSpace

Link copied to clipboard

Deletes a specific service association from an AgentSpace. This operation is idempotent and returns a 204 No Content response on success.

Link copied to clipboard

Enable the Operator App to access the given AgentSpace

Link copied to clipboard
abstract suspend fun getAccountUsage(input: GetAccountUsageRequest = GetAccountUsageRequest { }): GetAccountUsageResponse

Retrieves monthly account usage metrics and limits for the AWS account.

Link copied to clipboard

Retrieves detailed information about a specific AgentSpace.

Link copied to clipboard
abstract suspend fun getAsset(input: GetAssetRequest): GetAssetResponse

Gets an asset from the specified agent space

Link copied to clipboard

Gets an asset's content as a zip bundle

Link copied to clipboard

Gets a file from an asset

Link copied to clipboard

Retrieves given associations configured for a specific AgentSpace.

Link copied to clipboard

Gets a backlog task for the specified agent space and task id

Link copied to clipboard

Get the full auth configuration of operator including any enabled auth flow

Link copied to clipboard

Retrieves a specific recommendation by its ID

Link copied to clipboard
abstract suspend fun getService(input: GetServiceRequest): GetServiceResponse

Retrieves given service by it's unique identifier

Link copied to clipboard
abstract suspend fun getTrigger(input: GetTriggerRequest): GetTriggerResponse

Gets a Trigger from the specified agent space

Link copied to clipboard
abstract suspend fun listAgentSpaces(input: ListAgentSpacesRequest = ListAgentSpacesRequest { }): ListAgentSpacesResponse

Lists all AgentSpaces with optional pagination.

Link copied to clipboard

Lists files in an asset

Link copied to clipboard
abstract suspend fun listAssets(input: ListAssetsRequest): ListAssetsResponse

Lists assets in the specified agent space

Link copied to clipboard
abstract suspend fun listAssetTypes(input: ListAssetTypesRequest = ListAssetTypesRequest { }): ListAssetTypesResponse

Lists the supported asset types

Link copied to clipboard

Lists versions of an asset in the specified agent space

Link copied to clipboard

List all associations for given AgentSpace

Link copied to clipboard

Lists backlog tasks in the specified agent space with optional filtering and sorting

Link copied to clipboard
abstract suspend fun listChats(input: ListChatsRequest): ListChatsResponse

Retrieves a paginated list of the user's recent chat executions

Link copied to clipboard

List executions

Link copied to clipboard
abstract suspend fun listGoals(input: ListGoalsRequest): ListGoalsResponse

Lists goals in the specified agent space with optional filtering

Link copied to clipboard

List journal records for a specific execution

Link copied to clipboard

List pending messages for a specific execution.

Link copied to clipboard
abstract suspend fun listPrivateConnections(input: ListPrivateConnectionsRequest = ListPrivateConnectionsRequest { }): ListPrivateConnectionsResponse

Lists all Private Connections in the caller's account.

Link copied to clipboard

Lists recommendations for the specified agent space

Link copied to clipboard
abstract suspend fun listServices(input: ListServicesRequest = ListServicesRequest { }): ListServicesResponse

List a list of registered service on the account level.

Link copied to clipboard

Lists tags for the specified AWS DevOps Agent resource.

Link copied to clipboard

Lists Triggers in the specified agent space

Link copied to clipboard

List all webhooks for given Association

Link copied to clipboard

This operation registers the specified service

Link copied to clipboard
abstract suspend fun <T> sendMessage(input: SendMessageRequest, block: suspend (SendMessageResponse) -> T): T

Sends a chat message and streams the response for the specified agent space execution

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds or overwrites tags for the specified AWS DevOps Agent resource.

Link copied to clipboard

Removes tags from the specified AWS DevOps Agent resource.

Link copied to clipboard

Updates the information of an existing AgentSpace.

Link copied to clipboard
abstract suspend fun updateAsset(input: UpdateAssetRequest): UpdateAssetResponse

Updates an asset in the specified agent space

Link copied to clipboard

Updates a file in an asset

Link copied to clipboard

Partially updates the configuration of an existing service association for an AgentSpace. Present fields are fully replaced; absent fields are left unchanged. Returns 200 OK on success.

Link copied to clipboard

Update an existing backlog task.

Link copied to clipboard
abstract suspend fun updateGoal(input: UpdateGoalRequest): UpdateGoalResponse

Update an existing goal

Link copied to clipboard

Update the external Identity Provider configuration for the Operator App

Link copied to clipboard

Updates the certificate associated with a Private Connection.

Link copied to clipboard

Updates an existing recommendation with new content, status, or metadata

Link copied to clipboard

Updates the status of an existing Trigger

Link copied to clipboard

Validates an aws association and set status and returns a 204 No Content response on success.

Inherited functions

Link copied to clipboard

Adds a specific service association to an AgentSpace. It overwrites the existing association of the same service. Returns 201 Created on success.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Creates a new AgentSpace with the specified name and description. Duplicate space names are allowed.

Link copied to clipboard

Creates a new asset in the specified agent space

Link copied to clipboard

Creates a file in an asset

Link copied to clipboard

Creates a new backlog task in the specified agent space

Link copied to clipboard
inline suspend fun DevOpsAgentClient.createChat(crossinline block: CreateChatRequest.Builder.() -> Unit): CreateChatResponse

Creates a new chat execution in the specified agent space

Link copied to clipboard

Creates a Private Connection to a target resource.

Link copied to clipboard

Creates a new Trigger in the specified agent space

Link copied to clipboard

Deletes an AgentSpace. This operation is idempotent and returns a 204 No Content response on success.

Link copied to clipboard

Deletes an asset and all its files from the specified agent space

Link copied to clipboard

Deletes a file from an asset

Link copied to clipboard

Deletes a Private Connection. The deletion is asynchronous and returns DELETE_IN_PROGRESS status.

Link copied to clipboard

Deletes a Trigger from the specified agent space

Link copied to clipboard

Deregister a service

Link copied to clipboard

Retrieves details of an existing Private Connection.

Link copied to clipboard

Disable the Operator App for the specified AgentSpace

Link copied to clipboard

Deletes a specific service association from an AgentSpace. This operation is idempotent and returns a 204 No Content response on success.

Link copied to clipboard

Enable the Operator App to access the given AgentSpace

Link copied to clipboard

Retrieves monthly account usage metrics and limits for the AWS account.

Link copied to clipboard

Retrieves detailed information about a specific AgentSpace.

Link copied to clipboard
inline suspend fun DevOpsAgentClient.getAsset(crossinline block: GetAssetRequest.Builder.() -> Unit): GetAssetResponse

Gets an asset from the specified agent space

Link copied to clipboard

Gets an asset's content as a zip bundle

Link copied to clipboard

Gets a file from an asset

Link copied to clipboard

Retrieves given associations configured for a specific AgentSpace.

Link copied to clipboard

Gets a backlog task for the specified agent space and task id

Link copied to clipboard

Get the full auth configuration of operator including any enabled auth flow

Link copied to clipboard

Retrieves a specific recommendation by its ID

Link copied to clipboard
inline suspend fun DevOpsAgentClient.getService(crossinline block: GetServiceRequest.Builder.() -> Unit): GetServiceResponse

Retrieves given service by it's unique identifier

Link copied to clipboard
inline suspend fun DevOpsAgentClient.getTrigger(crossinline block: GetTriggerRequest.Builder.() -> Unit): GetTriggerResponse

Gets a Trigger from the specified agent space

Link copied to clipboard

Lists all AgentSpaces with optional pagination.

Link copied to clipboard

Lists files in an asset

Link copied to clipboard
inline suspend fun DevOpsAgentClient.listAssets(crossinline block: ListAssetsRequest.Builder.() -> Unit): ListAssetsResponse

Lists assets in the specified agent space

Link copied to clipboard

Lists the supported asset types

Link copied to clipboard

Lists versions of an asset in the specified agent space

Link copied to clipboard

List all associations for given AgentSpace

Link copied to clipboard

Lists backlog tasks in the specified agent space with optional filtering and sorting

Link copied to clipboard
inline suspend fun DevOpsAgentClient.listChats(crossinline block: ListChatsRequest.Builder.() -> Unit): ListChatsResponse

Retrieves a paginated list of the user's recent chat executions

Link copied to clipboard

List executions

Link copied to clipboard
inline suspend fun DevOpsAgentClient.listGoals(crossinline block: ListGoalsRequest.Builder.() -> Unit): ListGoalsResponse

Lists goals in the specified agent space with optional filtering

Link copied to clipboard

List journal records for a specific execution

Link copied to clipboard

List pending messages for a specific execution.

Link copied to clipboard

Lists all Private Connections in the caller's account.

Link copied to clipboard

Lists recommendations for the specified agent space

Link copied to clipboard

List a list of registered service on the account level.

Link copied to clipboard

Lists tags for the specified AWS DevOps Agent resource.

Link copied to clipboard

Lists Triggers in the specified agent space

Link copied to clipboard

List all webhooks for given Association

Link copied to clipboard

This operation registers the specified service

Link copied to clipboard

Adds or overwrites tags for the specified AWS DevOps Agent resource.

Link copied to clipboard

Removes tags from the specified AWS DevOps Agent resource.

Link copied to clipboard

Updates the information of an existing AgentSpace.

Link copied to clipboard

Updates an asset in the specified agent space

Link copied to clipboard

Updates a file in an asset

Link copied to clipboard

Partially updates the configuration of an existing service association for an AgentSpace. Present fields are fully replaced; absent fields are left unchanged. Returns 200 OK on success.

Link copied to clipboard

Update an existing backlog task.

Link copied to clipboard
inline suspend fun DevOpsAgentClient.updateGoal(crossinline block: UpdateGoalRequest.Builder.() -> Unit): UpdateGoalResponse

Update an existing goal

Link copied to clipboard

Update the external Identity Provider configuration for the Operator App

Link copied to clipboard

Updates the certificate associated with a Private Connection.

Link copied to clipboard

Updates an existing recommendation with new content, status, or metadata

Link copied to clipboard

Updates the status of an existing Trigger

Link copied to clipboard

Validates an aws association and set status and returns a 204 No Content response on success.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.