AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS DevOps Agent Service SendMessage API operation.

Syntax

Send-DOPSMessage
-Context_ApprovalAction_Action <ApprovalActionType>
-AgentSpaceId <String>
-Context_ApprovalAction_ApprovalId <String>
-AssetId <String[]>
-Context_ApprovalAction_ButtonText <String>
-Content <String>
-Context_CurrentPage <String>
-ExecutionId <String>
-Context_ApprovalAction_InterruptId <String>
-Context_LastMessage <String>
-ModelTier <String>
-Context_ApprovalAction_ToolUseId <String>
-Context_UserActionResponse <String>
-UserId <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonDevOpsAgentConfig>

Description

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

Parameters

-AgentSpaceId <String>
The agent space identifier
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AssetId <String[]>
Optional list of asset identifiers to attach to the message Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAssetIds
-ClientConfig <AmazonDevOpsAgentConfig>
Amazon.PowerShell.Cmdlets.DOPS.AmazonDevOpsAgentClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Content <String>
The user message content
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context_ApprovalAction_Action <ApprovalActionType>
The action taken on the approval request — APPROVED or REJECTED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context_ApprovalAction_ApprovalId <String>
Identifier of the approval request being resolved.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context_ApprovalAction_ButtonText <String>
Optional display text of the UI control the user chose (for example, "Approve Exact", "Approve Broader", or "Reject"), provided as auxiliary decision context.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context_ApprovalAction_InterruptId <String>
An opaque resume identifier issued by the service when an agent execution pauses for approval. Provide it when resuming so the service can resume the correct paused execution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context_ApprovalAction_ToolUseId <String>
Identifier of the specific paused tool invocation that requested approval. Correlates the approval decision back to the paused invocation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context_CurrentPage <String>
The current page or view the user is on
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context_LastMessage <String>
The ID of the last message in the conversation
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context_UserActionResponse <String>
Response to a UI prompt (not a text conversation message). Set this to the sentinel value `"APPROVAL_ACTION"` when the request is resuming a paused execution after an approval decision; in that case the structured decision is provided on the sibling `approvalAction` member. Preserved as a String for backward compatibility: clients that predate the typed approval field may still encode UI-prompt responses as JSON in this field.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionId <String>
The execution identifier for the chat session
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelTier <String>
Optional model tier selection. Valid values: smart, balanced, fast. Absent or unrecognized values default to balanced.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Events'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DevOpsAgent.Model.SendMessageResponse). Specifying the name of a property of type Amazon.DevOpsAgent.Model.SendMessageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserId <String>
User identifier. This field is deprecated and will be ignored — the service resolves user identity from the authenticated session.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.DevOpsAgent.Model.SendMessageEvents or Amazon.DevOpsAgent.Model.SendMessageResponse
This cmdlet returns an Amazon.DevOpsAgent.Model.SendMessageEvents object. The service call response (type Amazon.DevOpsAgent.Model.SendMessageResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z