Skip to content

update_gateway_target

Operation

update_gateway_target

update_gateway_target(request: UpdateGatewayTargetInput | UpdateGatewayTargetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateGatewayTargetInputDict]) -> 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
request UpdateGatewayTargetInput | UpdateGatewayTargetInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateGatewayTargetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateGatewayTargetOutput

An instance of UpdateGatewayTargetOutput.

update_gateway_target async

update_gateway_target(request: UpdateGatewayTargetInput | UpdateGatewayTargetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateGatewayTargetInputDict]) -> 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
request UpdateGatewayTargetInput | UpdateGatewayTargetInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateGatewayTargetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateGatewayTargetOutput

An instance of UpdateGatewayTargetOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateGatewayTargetInputDict

Bases: TypedDict

Dictionary form of UpdateGatewayTargetInput.

Attributes

certificate_configurations instance-attribute
certificate_configurations: Sequence[CertificateConfiguration | CertificateConfigurationDict] | 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 instance-attribute

The updated credential provider configurations for the gateway target.

description instance-attribute
description: str | None

The updated description for the gateway target.

gateway_identifier instance-attribute
gateway_identifier: Required[str]

The unique identifier of the gateway associated with the target.

metadata_configuration instance-attribute
metadata_configuration: MetadataConfiguration | MetadataConfigurationDict | None

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

name instance-attribute
name: str | None

The updated name for the gateway target.

private_endpoint instance-attribute
private_endpoint: PrivateEndpoint | PrivateEndpointDict | None

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

target_configuration instance-attribute

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: Required[str]

The unique identifier of the gateway target to update.

UpdateGatewayTargetInput dataclass

Bases: _SerdeShape

Dataclass for UpdateGatewayTargetInput structure.

Attributes

certificate_configurations class-attribute instance-attribute
certificate_configurations: list[CertificateConfiguration] | 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 = ...

The updated credential provider configurations for the gateway target.

description class-attribute instance-attribute
description: str | None = ...

The updated description for the gateway target.

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

The unique identifier of the gateway associated with the target.

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

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

name class-attribute instance-attribute
name: str | None = ...

The updated name for the gateway target.

private_endpoint class-attribute instance-attribute
private_endpoint: PrivateEndpoint | 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 = ...

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 = ...

The unique identifier of the gateway target to update.

Output

UpdateGatewayTargetOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateGatewayTargetOutput structure.

Attributes

authorization_data class-attribute instance-attribute
authorization_data: AuthorizationData | 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 = ...

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 = ...

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 = ...

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

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

The metadata configuration that was applied to the gateway target.

name instance-attribute
name: str

The updated name of the gateway target.

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

The private endpoint configuration for the gateway target.

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

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

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

The protocol type of the updated gateway target.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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 = ...

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.