update_gateway_target¶
Operation¶
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 |
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 |
Input¶
dataclass
¶
Dataclass for UpdateGatewayTargetInput structure.
Attributes¶
class-attribute
instance-attribute
¶
credential_provider_configurations: list[CredentialProviderConfiguration] | None = None
The updated credential provider configurations for the gateway target.
class-attribute
instance-attribute
¶
description: str | None = field(repr=False, default=None)
The updated description for the gateway target.
class-attribute
instance-attribute
¶
gateway_identifier: str | None = None
The unique identifier of the gateway associated with the target.
class-attribute
instance-attribute
¶
metadata_configuration: MetadataConfiguration | None = None
Configuration for HTTP header and query parameter propagation to the gateway target.
class-attribute
instance-attribute
¶
name: str | None = field(repr=False, default=None)
The updated name for the gateway target.
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.
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.
class-attribute
instance-attribute
¶
target_id: str | None = None
The unique identifier of the gateway target to update.
Output¶
dataclass
¶
Dataclass for UpdateGatewayTargetOutput structure.
Attributes¶
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.
instance-attribute
¶
created_at: datetime
The timestamp when the gateway target was created.
instance-attribute
¶
credential_provider_configurations: list[CredentialProviderConfiguration]
The updated credential provider configurations for the gateway target.
class-attribute
instance-attribute
¶
description: str | None = field(repr=False, default=None)
The updated description of the gateway target.
class-attribute
instance-attribute
¶
last_synchronized_at: datetime | None = None
The date and time at which the targets were last synchronized.
class-attribute
instance-attribute
¶
metadata_configuration: MetadataConfiguration | None = None
The metadata configuration that was applied to the gateway target.
class-attribute
instance-attribute
¶
name: str = field(repr=False)
The updated name of the gateway target.
class-attribute
instance-attribute
¶
private_endpoint: PrivateEndpoint | None = None
The private endpoint configuration for the gateway target.
class-attribute
instance-attribute
¶
private_endpoint_managed_resources: list[ManagedResourceDetails] | None = None
The managed resources created by the gateway for private endpoint connectivity.
class-attribute
instance-attribute
¶
protocol_type: TargetProtocolType | None = None
The protocol type of the updated gateway target.
class-attribute
instance-attribute
¶
status_reasons: list[str] | None = None
The reasons for the current status of the updated gateway target.
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.
instance-attribute
¶
updated_at: datetime
The timestamp when the gateway target was last updated.