Skip to content

Bedrock AgentCore Control  >  Operations  >  create_gateway_target

create_gateway_target

Operation

create_gateway_target async 

create_gateway_target(input: CreateGatewayTargetInput, plugins: list[Plugin] | None = None) -> CreateGatewayTargetOutput

Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.

Parameters:

Name Type Description Default
input CreateGatewayTargetInput

An instance of CreateGatewayTargetInput.

 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
CreateGatewayTargetOutput

An instance of CreateGatewayTargetOutput.

Input

CreateGatewayTargetInput dataclass

Dataclass for CreateGatewayTargetInput structure.

Attributes

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

client_token class-attribute instance-attribute 
client_token: str | None = None

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

credential_provider_configurations class-attribute instance-attribute 
credential_provider_configurations: list[CredentialProviderConfiguration] | None = None

The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.

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

The description of the gateway target.

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

The identifier of the gateway to create a target for.

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

Optional configuration for HTTP header and query parameter propagation to and from the gateway target.

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

The name of the gateway target. The name must be unique within the gateway.

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

target_configuration class-attribute instance-attribute 
target_configuration: TargetConfiguration | None = None

The configuration settings for the target, including endpoint information and schema definitions.

Output

CreateGatewayTargetOutput dataclass

Dataclass for CreateGatewayTargetOutput structure.

Attributes

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

OAuth2 authorization data for the created 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 = None

The private certificate authority (CA) configurations for the gateway target.

created_at instance-attribute 
created_at: datetime

The timestamp when the target was created.

credential_provider_configurations instance-attribute 
credential_provider_configurations: list[CredentialProviderConfiguration]

The credential provider configurations for the target.

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

The description of the 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 that was applied to the created gateway target.

name class-attribute instance-attribute 
name: str = field(repr=False)

The name of the 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: str | None = None

The protocol type of the created gateway target.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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

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

The reasons for the current status of the target.

target_configuration instance-attribute 
target_configuration: TargetConfiguration

The configuration settings for the target.

target_id instance-attribute 
target_id: str

The unique identifier of the created target.

updated_at instance-attribute 
updated_at: datetime

The timestamp when the target was last updated.