Creates a target for a gateway¶

Description¶

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

Usage¶

bedrockagentcorecontrol_create_gateway_target(gatewayIdentifier, name,
  description, clientToken, targetConfiguration,
  credentialProviderConfigurations, metadataConfiguration,
  privateEndpoint, certificateConfigurations)

Arguments¶

gatewayIdentifier

[required] The identifier of the gateway to create a target for.
name

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

The description of the gateway target.
clientToken

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

[required] The configuration settings for the target, including endpoint information and schema definitions.
credentialProviderConfigurations

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

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

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

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.

Value¶

A list with the following syntax:

list(
  gatewayArn = "string",
  targetId = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  status = "CREATING"|"UPDATING"|"UPDATE_UNSUCCESSFUL"|"DELETING"|"READY"|"FAILED"|"SYNCHRONIZING"|"SYNCHRONIZE_UNSUCCESSFUL"|"CREATE_PENDING_AUTH"|"UPDATE_PENDING_AUTH"|"SYNCHRONIZE_PENDING_AUTH",
  statusReasons = list(
    "string"
  ),
  name = "string",
  description = "string",
  targetConfiguration = list(
    mcp = list(
      openApiSchema = list(
        s3 = list(
          uri = "string",
          bucketOwnerAccountId = "string"
        ),
        inlinePayload = "string"
      ),
      smithyModel = list(
        s3 = list(
          uri = "string",
          bucketOwnerAccountId = "string"
        ),
        inlinePayload = "string"
      ),
      lambda = list(
        lambdaArn = "string",
        toolSchema = list(
          s3 = list(
            uri = "string",
            bucketOwnerAccountId = "string"
          ),
          inlinePayload = list(
            list(
              name = "string",
              description = "string",
              inputSchema = list(
                type = "string"|"number"|"object"|"array"|"boolean"|"integer",
                properties = list(
                  list()
                ),
                required = list(
                  "string"
                ),
                items = list(),
                description = "string"
              ),
              outputSchema = list(
                type = "string"|"number"|"object"|"array"|"boolean"|"integer",
                properties = list(
                  list()
                ),
                required = list(
                  "string"
                ),
                items = list(),
                description = "string"
              )
            )
          )
        )
      ),
      mcpServer = list(
        endpoint = "string",
        mcpToolSchema = list(
          s3 = list(
            uri = "string",
            bucketOwnerAccountId = "string"
          ),
          inlinePayload = "string"
        ),
        listingMode = "DEFAULT"|"DYNAMIC",
        resourcePriority = 123
      ),
      apiGateway = list(
        restApiId = "string",
        stage = "string",
        apiGatewayToolConfiguration = list(
          toolOverrides = list(
            list(
              name = "string",
              description = "string",
              path = "string",
              method = "GET"|"DELETE"|"HEAD"|"OPTIONS"|"PATCH"|"PUT"|"POST"
            )
          ),
          toolFilters = list(
            list(
              filterPath = "string",
              methods = list(
                "GET"|"DELETE"|"HEAD"|"OPTIONS"|"PATCH"|"PUT"|"POST"
              )
            )
          )
        )
      ),
      connector = list(
        source = list(
          connectorId = "string",
          version = "string"
        ),
        enabled = list(
          "string"
        ),
        configurations = list(
          list(
            name = "string",
            description = "string",
            parameterValues = list(),
            parameterOverrides = list(
              list(
                path = "string",
                description = "string",
                visible = TRUE|FALSE
              )
            )
          )
        )
      )
    ),
    http = list(
      agentcoreRuntime = list(
        arn = "string",
        qualifier = "string",
        schema = list(
          source = list(
            s3 = list(
              uri = "string",
              bucketOwnerAccountId = "string"
            ),
            inlinePayload = "string"
          )
        )
      ),
      passthrough = list(
        endpoint = "string",
        protocolType = "MCP"|"A2A"|"INFERENCE"|"CUSTOM",
        schema = list(
          source = list(
            s3 = list(
              uri = "string",
              bucketOwnerAccountId = "string"
            ),
            inlinePayload = "string"
          )
        ),
        stickinessConfiguration = list(
          identifier = "string",
          timeout = 123,
          compositeIdentifier = list(
            "string"
          )
        ),
        staticQueryParameters = list(
          "string"
        ),
        staticQueryParameterConflictResolution = "CLIENT_OVERRIDE"|"STATIC_OVERRIDE"
      ),
      connector = list(
        source = list(
          connectorId = "string"
        ),
        parameters = list(
          "string"
        )
      )
    ),
    inference = list(
      connector = list(
        source = list(
          connectorId = "string"
        )
      ),
      provider = list(
        endpoint = "string",
        modelMapping = list(
          providerPrefix = list(
            strip = TRUE|FALSE,
            separator = "string"
          )
        ),
        operations = list(
          list(
            path = "string",
            providerPath = "string",
            models = list(
              list(
                model = "string"
              )
            )
          )
        )
      )
    )
  ),
  credentialProviderConfigurations = list(
    list(
      credentialProviderType = "GATEWAY_IAM_ROLE"|"OAUTH"|"API_KEY"|"CALLER_IAM_CREDENTIALS"|"JWT_PASSTHROUGH",
      credentialProvider = list(
        oauthCredentialProvider = list(
          providerArn = "string",
          scopes = list(
            "string"
          ),
          customParameters = list(
            "string"
          ),
          grantType = "CLIENT_CREDENTIALS"|"AUTHORIZATION_CODE"|"TOKEN_EXCHANGE",
          defaultReturnUrl = "string"
        ),
        apiKeyCredentialProvider = list(
          providerArn = "string",
          credentialParameterName = "string",
          credentialPrefix = "string",
          credentialLocation = "HEADER"|"QUERY_PARAMETER"
        ),
        iamCredentialProvider = list(
          service = "string",
          region = "string"
        )
      )
    )
  ),
  lastSynchronizedAt = as.POSIXct(
    "2015-01-01"
  ),
  metadataConfiguration = list(
    allowedRequestHeaders = list(
      "string"
    ),
    allowedQueryParameters = list(
      "string"
    ),
    allowedResponseHeaders = list(
      "string"
    )
  ),
  privateEndpoint = list(
    selfManagedLatticeResource = list(
      resourceConfigurationIdentifier = "string"
    ),
    managedVpcResource = list(
      vpcIdentifier = "string",
      subnetIds = list(
        "string"
      ),
      endpointIpAddressType = "IPV4"|"IPV6",
      securityGroupIds = list(
        "string"
      ),
      tags = list(
        "string"
      ),
      routingDomain = "string"
    )
  ),
  privateEndpointManagedResources = list(
    list(
      domain = "string",
      resourceGatewayArn = "string",
      resourceAssociationArn = "string"
    )
  ),
  authorizationData = list(
    oauth2 = list(
      authorizationUrl = "string",
      userId = "string"
    )
  ),
  protocolType = "MCP"|"HTTP",
  certificateConfigurations = list(
    list(
      s3 = list(
        uri = "string",
        bucketOwnerAccountId = "string"
      ),
      secretsManager = list(
        secretArn = "string"
      )
    )
  )
)

Request syntax¶

svc$create_gateway_target(
  gatewayIdentifier = "string",
  name = "string",
  description = "string",
  clientToken = "string",
  targetConfiguration = list(
    mcp = list(
      openApiSchema = list(
        s3 = list(
          uri = "string",
          bucketOwnerAccountId = "string"
        ),
        inlinePayload = "string"
      ),
      smithyModel = list(
        s3 = list(
          uri = "string",
          bucketOwnerAccountId = "string"
        ),
        inlinePayload = "string"
      ),
      lambda = list(
        lambdaArn = "string",
        toolSchema = list(
          s3 = list(
            uri = "string",
            bucketOwnerAccountId = "string"
          ),
          inlinePayload = list(
            list(
              name = "string",
              description = "string",
              inputSchema = list(
                type = "string"|"number"|"object"|"array"|"boolean"|"integer",
                properties = list(
                  list()
                ),
                required = list(
                  "string"
                ),
                items = list(),
                description = "string"
              ),
              outputSchema = list(
                type = "string"|"number"|"object"|"array"|"boolean"|"integer",
                properties = list(
                  list()
                ),
                required = list(
                  "string"
                ),
                items = list(),
                description = "string"
              )
            )
          )
        )
      ),
      mcpServer = list(
        endpoint = "string",
        mcpToolSchema = list(
          s3 = list(
            uri = "string",
            bucketOwnerAccountId = "string"
          ),
          inlinePayload = "string"
        ),
        listingMode = "DEFAULT"|"DYNAMIC",
        resourcePriority = 123
      ),
      apiGateway = list(
        restApiId = "string",
        stage = "string",
        apiGatewayToolConfiguration = list(
          toolOverrides = list(
            list(
              name = "string",
              description = "string",
              path = "string",
              method = "GET"|"DELETE"|"HEAD"|"OPTIONS"|"PATCH"|"PUT"|"POST"
            )
          ),
          toolFilters = list(
            list(
              filterPath = "string",
              methods = list(
                "GET"|"DELETE"|"HEAD"|"OPTIONS"|"PATCH"|"PUT"|"POST"
              )
            )
          )
        )
      ),
      connector = list(
        source = list(
          connectorId = "string",
          version = "string"
        ),
        enabled = list(
          "string"
        ),
        configurations = list(
          list(
            name = "string",
            description = "string",
            parameterValues = list(),
            parameterOverrides = list(
              list(
                path = "string",
                description = "string",
                visible = TRUE|FALSE
              )
            )
          )
        )
      )
    ),
    http = list(
      agentcoreRuntime = list(
        arn = "string",
        qualifier = "string",
        schema = list(
          source = list(
            s3 = list(
              uri = "string",
              bucketOwnerAccountId = "string"
            ),
            inlinePayload = "string"
          )
        )
      ),
      passthrough = list(
        endpoint = "string",
        protocolType = "MCP"|"A2A"|"INFERENCE"|"CUSTOM",
        schema = list(
          source = list(
            s3 = list(
              uri = "string",
              bucketOwnerAccountId = "string"
            ),
            inlinePayload = "string"
          )
        ),
        stickinessConfiguration = list(
          identifier = "string",
          timeout = 123,
          compositeIdentifier = list(
            "string"
          )
        ),
        staticQueryParameters = list(
          "string"
        ),
        staticQueryParameterConflictResolution = "CLIENT_OVERRIDE"|"STATIC_OVERRIDE"
      ),
      connector = list(
        source = list(
          connectorId = "string"
        ),
        parameters = list(
          "string"
        )
      )
    ),
    inference = list(
      connector = list(
        source = list(
          connectorId = "string"
        )
      ),
      provider = list(
        endpoint = "string",
        modelMapping = list(
          providerPrefix = list(
            strip = TRUE|FALSE,
            separator = "string"
          )
        ),
        operations = list(
          list(
            path = "string",
            providerPath = "string",
            models = list(
              list(
                model = "string"
              )
            )
          )
        )
      )
    )
  ),
  credentialProviderConfigurations = list(
    list(
      credentialProviderType = "GATEWAY_IAM_ROLE"|"OAUTH"|"API_KEY"|"CALLER_IAM_CREDENTIALS"|"JWT_PASSTHROUGH",
      credentialProvider = list(
        oauthCredentialProvider = list(
          providerArn = "string",
          scopes = list(
            "string"
          ),
          customParameters = list(
            "string"
          ),
          grantType = "CLIENT_CREDENTIALS"|"AUTHORIZATION_CODE"|"TOKEN_EXCHANGE",
          defaultReturnUrl = "string"
        ),
        apiKeyCredentialProvider = list(
          providerArn = "string",
          credentialParameterName = "string",
          credentialPrefix = "string",
          credentialLocation = "HEADER"|"QUERY_PARAMETER"
        ),
        iamCredentialProvider = list(
          service = "string",
          region = "string"
        )
      )
    )
  ),
  metadataConfiguration = list(
    allowedRequestHeaders = list(
      "string"
    ),
    allowedQueryParameters = list(
      "string"
    ),
    allowedResponseHeaders = list(
      "string"
    )
  ),
  privateEndpoint = list(
    selfManagedLatticeResource = list(
      resourceConfigurationIdentifier = "string"
    ),
    managedVpcResource = list(
      vpcIdentifier = "string",
      subnetIds = list(
        "string"
      ),
      endpointIpAddressType = "IPV4"|"IPV6",
      securityGroupIds = list(
        "string"
      ),
      tags = list(
        "string"
      ),
      routingDomain = "string"
    )
  ),
  certificateConfigurations = list(
    list(
      s3 = list(
        uri = "string",
        bucketOwnerAccountId = "string"
      ),
      secretsManager = list(
        secretArn = "string"
      )
    )
  )
)