Skip to content

Bedrock Agentcore Control  >  Structures  >  GatewayTarget

GatewayTarget

Structure Class

GatewayTarget dataclass

The gateway target.

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 date and time at which the target was created.

credential_provider_configurations instance-attribute
credential_provider_configurations: list[CredentialProviderConfiguration]

The provider configurations.

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

The description for the gateway target.

gateway_arn instance-attribute
gateway_arn: str

The Amazon Resource Name (ARN) of the gateway target.

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

The last synchronization time.

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

The metadata configuration for HTTP header and query parameter propagation to and from this 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 a gateway target. Defines how the gateway connects to private resources in your VPC.

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

A list of managed resources created by the gateway for private endpoint connectivity. These resources are created in your account when you use a managed VPC Lattice resource configuration.

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

The protocol type of the gateway target.

status instance-attribute
status: TargetStatus

The status of the gateway target.

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

The status reasons for the target status.

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 target ID.

updated_at instance-attribute
updated_at: datetime

The date and time at which the target was updated.