Bedrock Agentcore Control  >  Operations  >  get_gateway_target

get_gateway_target

Operation

get_gateway_target async

get_gateway_target(input: GetGatewayTargetInput, plugins: list[Plugin] | None = None) -> GetGatewayTargetOutput

Retrieves information about a specific gateway target.

Parameters:

Name	Type	Description	Default
input	GetGatewayTargetInput	An instance of GetGatewayTargetInput.	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
GetGatewayTargetOutput	An instance of GetGatewayTargetOutput.

Input

GetGatewayTargetInput dataclass

Dataclass for GetGatewayTargetInput structure.

Attributes

gateway_identifier class-attribute instance-attribute

gateway_identifier: str | None = None

The identifier of the gateway that contains the target.

target_id class-attribute instance-attribute

target_id: str | None = None

The unique identifier of the target to retrieve.

Output

GetGatewayTargetOutput dataclass

Dataclass for GetGatewayTargetOutput structure.

Attributes

authorization_data class-attribute instance-attribute

authorization_data: AuthorizationData | None = 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.

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 = field(repr=False, default=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 = None

The last synchronization of the target.

metadata_configuration class-attribute instance-attribute

metadata_configuration: MetadataConfiguration | None = None

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

name class-attribute instance-attribute

name: str = field(repr=False)

The 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: TargetProtocolType | None = None

The protocol type of the gateway target.

status instance-attribute

status: TargetStatus

The current status of the gateway target.

status_reasons class-attribute instance-attribute

status_reasons: list[str] | None = 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.