Skip to content

Bedrock AgentCore Control  >  Operations  >  update_gateway_target

update_gateway_target

Operation

update_gateway_target async 

update_gateway_target(input: UpdateGatewayTargetInput, plugins: list[Plugin] | None = None) -> UpdateGatewayTargetOutput

Updates an existing gateway target.

You cannot update a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before updating the target.

Parameters:

Name Type Description Default
input UpdateGatewayTargetInput

An instance of UpdateGatewayTargetInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
UpdateGatewayTargetOutput

An instance of UpdateGatewayTargetOutput.

Input

UpdateGatewayTargetInput dataclass

Dataclass for UpdateGatewayTargetInput structure.

Attributes

certificate_configurations class-attribute instance-attribute 
certificate_configurations: list[CertificateConfiguration] | None = None

The private certificate authority (CA) configurations for the gateway target. Use this to have the gateway trust a private CA when it establishes TLS connections to the target endpoint. Provide each certificate by reference to an Amazon S3 object or an Amazon Web Services Secrets Manager secret. You can specify only one certificate authority configuration in this list. To remove a previously configured certificate authority, omit this field on update.

credential_provider_configurations class-attribute instance-attribute 
credential_provider_configurations: list[CredentialProviderConfiguration] | None = None

The updated credential provider configurations for the gateway target.

description class-attribute instance-attribute 
description: str | None = field(repr=False, default=None)

The updated description for the gateway target.

gateway_identifier class-attribute instance-attribute 
gateway_identifier: str | None = None

The unique identifier of the gateway associated with the target.

metadata_configuration class-attribute instance-attribute 
metadata_configuration: MetadataConfiguration | None = None

Configuration for HTTP header and query parameter propagation to the gateway target.

name class-attribute instance-attribute 
name: str | None = field(repr=False, default=None)

The updated name for the gateway target.

private_endpoint class-attribute instance-attribute 
private_endpoint: PrivateEndpoint | None = None

The private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.

target_configuration class-attribute instance-attribute 
target_configuration: TargetConfiguration | None = None

The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.

target_id class-attribute instance-attribute 
target_id: str | None = None

The unique identifier of the gateway target to update.

Output

UpdateGatewayTargetOutput dataclass

Dataclass for UpdateGatewayTargetOutput structure.

Attributes

authorization_data class-attribute instance-attribute 
authorization_data: AuthorizationData | None = None

OAuth2 authorization data for the updated gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

certificate_configurations class-attribute instance-attribute 
certificate_configurations: list[CertificateConfiguration] | None = None

The private certificate authority (CA) configurations for the gateway target.

created_at instance-attribute 
created_at: datetime

The timestamp when the gateway target was created.

credential_provider_configurations instance-attribute 
credential_provider_configurations: list[CredentialProviderConfiguration]

The updated credential provider configurations for the gateway target.

description class-attribute instance-attribute 
description: str | None = field(repr=False, default=None)

The updated description of the gateway target.

gateway_arn instance-attribute 
gateway_arn: str

The Amazon Resource Name (ARN) of the gateway.

last_synchronized_at class-attribute instance-attribute 
last_synchronized_at: datetime | None = None

The date and time at which the targets were last synchronized.

metadata_configuration class-attribute instance-attribute 
metadata_configuration: MetadataConfiguration | None = None

The metadata configuration that was applied to the gateway target.

name class-attribute instance-attribute 
name: str = field(repr=False)

The updated name of the gateway target.

private_endpoint class-attribute instance-attribute 
private_endpoint: PrivateEndpoint | None = None

The private endpoint configuration for the gateway target.

private_endpoint_managed_resources class-attribute instance-attribute 
private_endpoint_managed_resources: list[ManagedResourceDetails] | None = None

The managed resources created by the gateway for private endpoint connectivity.

protocol_type class-attribute instance-attribute 
protocol_type: str | None = None

The protocol type of the updated gateway target.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status instance-attribute 
status: str

The current status of the updated gateway target.

status_reasons class-attribute instance-attribute 
status_reasons: list[str] | None = None

The reasons for the current status of the updated gateway target.

target_configuration instance-attribute 
target_configuration: TargetConfiguration

The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.

target_id instance-attribute 
target_id: str

The unique identifier of the updated gateway target.

updated_at instance-attribute 
updated_at: datetime

The timestamp when the gateway target was last updated.