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 Amazon Bedrock Agent Core Control Plane Fronting Layer UpdateRegistryRecord API operation.

Syntax

Update-BACCRegistryRecord
-SynchronizationConfiguration_OptionalValue_FromUrl_CredentialProviderConfiguration <RegistryRecordCredentialProviderConfiguration[]>
-DescriptorType <DescriptorType>
-Descriptors_OptionalValue_A2a_OptionalValue_AgentCard_InlineContent <String>
-Descriptors_OptionalValue_AgentSkills_OptionalValue_SkillDefinition_OptionalValue_InlineContent <String>
-Descriptors_OptionalValue_AgentSkills_OptionalValue_SkillMd_OptionalValue_InlineContent <String>
-Descriptors_OptionalValue_Custom_OptionalValue_InlineContent <String>
-Descriptors_OptionalValue_Mcp_OptionalValue_Server_OptionalValue_InlineContent <String>
-Descriptors_OptionalValue_Mcp_OptionalValue_Tools_OptionalValue_InlineContent <String>
-Name <String>
-Description_OptionalValue <String>
-SynchronizationType_OptionalValue <SynchronizationType>
-Descriptors_OptionalValue_Mcp_OptionalValue_Tools_OptionalValue_ProtocolVersion <String>
-RecordId <String>
-RecordVersion <String>
-RegistryId <String>
-Descriptors_OptionalValue_A2a_OptionalValue_AgentCard_SchemaVersion <String>
-Descriptors_OptionalValue_AgentSkills_OptionalValue_SkillDefinition_OptionalValue_SchemaVersion <String>
-Descriptors_OptionalValue_Mcp_OptionalValue_Server_OptionalValue_SchemaVersion <String>
-TriggerSynchronization <Boolean>
-SynchronizationConfiguration_OptionalValue_FromUrl_Url <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockAgentCoreControlConfig>

Description

Updates an existing registry record. This operation uses PATCH semantics, so you only need to specify the fields you want to change. The update is processed asynchronously and returns HTTP 202 Accepted.

Parameters

-ClientConfig <AmazonBedrockAgentCoreControlConfig>
Amazon.PowerShell.Cmdlets.BACC.AmazonBedrockAgentCoreControlClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description_OptionalValue <String>
Represents an optional value that is used to update the human-readable description of the resource. If not specified, it will clear the current description of the resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Descriptors_OptionalValue_A2a_OptionalValue_AgentCard_InlineContent <String>
The JSON content containing the A2A agent card definition, conforming to the A2A protocol specification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Descriptors_OptionalValue_A2a_OptionalValue_AgentCard_SchemaVersion <String>
The schema version of the agent card based on the A2A protocol specification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Descriptors_OptionalValue_AgentSkills_OptionalValue_SkillDefinition_OptionalValue_InlineContent <String>
The JSON content containing the structured skill definition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Descriptors_OptionalValue_AgentSkills_OptionalValue_SkillDefinition_OptionalValue_SchemaVersion <String>
The version of the skill definition schema.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Descriptors_OptionalValue_AgentSkills_OptionalValue_SkillMd_OptionalValue_InlineContent <String>
The markdown content describing the agent's skills in a human-readable format.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Descriptors_OptionalValue_Custom_OptionalValue_InlineContent <String>
The custom descriptor content as a valid JSON document. You can define any custom schema that describes your resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Descriptors_OptionalValue_Mcp_OptionalValue_Server_OptionalValue_InlineContent <String>
The JSON content containing the MCP server definition, conforming to the MCP protocol specification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Descriptors_OptionalValue_Mcp_OptionalValue_Server_OptionalValue_SchemaVersion <String>
The schema version of the server definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Descriptors_OptionalValue_Mcp_OptionalValue_Tools_OptionalValue_InlineContent <String>
The JSON content containing the MCP tools definition, conforming to the MCP protocol specification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Descriptors_OptionalValue_Mcp_OptionalValue_Tools_OptionalValue_ProtocolVersion <String>
The protocol version of the tools definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DescriptorType <DescriptorType>
The updated descriptor type for the registry record. Changing the descriptor type may require updating the descriptors field to match the new type's schema requirements.
Required?False
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)
-Name <String>
The updated name for the registry record.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RecordId <String>
The identifier of the registry record to update. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RecordVersion <String>
The version of the registry record for optimistic locking. If provided, it must match the current version of the record. The service automatically increments the version after a successful update.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RegistryId <String>
The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgentCoreControl.Model.UpdateRegistryRecordResponse). Specifying the name of a property of type Amazon.BedrockAgentCoreControl.Model.UpdateRegistryRecordResponse 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)
-SynchronizationConfiguration_OptionalValue_FromUrl_CredentialProviderConfiguration <RegistryRecordCredentialProviderConfiguration[]>
Optional list of credential provider configurations for authenticating with the MCP server. At most one credential provider configuration can be specified. 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)
AliasesSynchronizationConfiguration_OptionalValue_FromUrl_CredentialProviderConfigurations
-SynchronizationConfiguration_OptionalValue_FromUrl_Url <String>
The HTTPS URL of the MCP server to synchronize from.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SynchronizationType_OptionalValue <SynchronizationType>
The updated synchronization type value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TriggerSynchronization <Boolean>
Whether to trigger synchronization using the stored or provided configuration. When set to true, the service will synchronize the record metadata from the configured external source.
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.BedrockAgentCoreControl.Model.UpdateRegistryRecordResponse
This cmdlet returns an Amazon.BedrockAgentCoreControl.Model.UpdateRegistryRecordResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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