Skip to content

Get Gateway Target

bedrockagentcorecontrol_get_gateway_target R Documentation

Retrieves information about a specific gateway target

Description

Retrieves information about a specific gateway target.

Usage

bedrockagentcorecontrol_get_gateway_target(gatewayIdentifier, targetId)

Arguments

gatewayIdentifier

[required] The identifier of the gateway that contains the target.

targetId

[required] The unique identifier of the target to retrieve.

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"
              )
            )
          )
        )
      )
    ),
    http = list(
      agentcoreRuntime = list(
        arn = "string",
        qualifier = "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"
)

Request syntax

svc$get_gateway_target(
  gatewayIdentifier = "string",
  targetId = "string"
)