Skip to content

get_gateway_target

Operation

get_gateway_target

get_gateway_target(request: GetGatewayTargetInput | GetGatewayTargetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGatewayTargetInputDict]) -> GetGatewayTargetOutput

Retrieves information about a specific gateway target.

Parameters:

Name Type Description Default
request GetGatewayTargetInput | GetGatewayTargetInputDict | 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[GetGatewayTargetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetGatewayTargetOutput

An instance of GetGatewayTargetOutput.

get_gateway_target async

get_gateway_target(request: GetGatewayTargetInput | GetGatewayTargetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGatewayTargetInputDict]) -> GetGatewayTargetOutput

Retrieves information about a specific gateway target.

Parameters:

Name Type Description Default
request GetGatewayTargetInput | GetGatewayTargetInputDict | 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[GetGatewayTargetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetGatewayTargetOutput

An instance of GetGatewayTargetOutput.

Input

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

GetGatewayTargetInputDict

Bases: TypedDict

Dictionary form of GetGatewayTargetInput.

Attributes

gateway_identifier instance-attribute
gateway_identifier: Required[str]

The identifier of the gateway that contains the target.

target_id instance-attribute
target_id: Required[str]

The unique identifier of the target to retrieve.

GetGatewayTargetInput dataclass

Bases: _SerdeShape

Dataclass for GetGatewayTargetInput structure.

Attributes

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

The identifier of the gateway that contains the target.

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

The unique identifier of the target to retrieve.

Output

GetGatewayTargetOutput dataclass

Bases: _SerdeShape

Dataclass for GetGatewayTargetOutput structure.

Attributes

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

OAuth2 authorization data for the 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 credential provider configurations for the gateway target.

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

The 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 last synchronization of the target.

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

The metadata configuration for HTTP header and query parameter propagation for the retrieved gateway target.

name instance-attribute
name: str

The 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 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 gateway target.

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

The reasons for the current status of the 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 gateway target.

updated_at instance-attribute
updated_at: datetime

The timestamp when the gateway target was last updated.