Skip to content

Get Gateway

bedrockagentcorecontrol_get_gateway R Documentation

Retrieves information about a specific Gateway

Description

Retrieves information about a specific Gateway.

Usage

bedrockagentcorecontrol_get_gateway(gatewayIdentifier)

Arguments

gatewayIdentifier

[required] The identifier of the gateway to retrieve.

Value

A list with the following syntax:

list(
  gatewayArn = "string",
  gatewayId = "string",
  gatewayUrl = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  status = "CREATING"|"UPDATING"|"UPDATE_UNSUCCESSFUL"|"DELETING"|"READY"|"FAILED",
  statusReasons = list(
    "string"
  ),
  name = "string",
  description = "string",
  roleArn = "string",
  protocolType = "MCP",
  protocolConfiguration = list(
    mcp = list(
      supportedVersions = list(
        "string"
      ),
      instructions = "string",
      searchType = "SEMANTIC",
      sessionConfiguration = list(
        sessionTimeoutInSeconds = 123
      ),
      streamingConfiguration = list(
        enableResponseStreaming = TRUE|FALSE
      )
    )
  ),
  authorizerType = "CUSTOM_JWT"|"AWS_IAM"|"NONE"|"AUTHENTICATE_ONLY",
  authorizerConfiguration = list(
    customJWTAuthorizer = list(
      discoveryUrl = "string",
      allowedAudience = list(
        "string"
      ),
      allowedClients = list(
        "string"
      ),
      allowedScopes = list(
        "string"
      ),
      customClaims = list(
        list(
          inboundTokenClaimName = "string",
          inboundTokenClaimValueType = "STRING"|"STRING_ARRAY",
          authorizingClaimMatchValue = list(
            claimMatchValue = list(
              matchValueString = "string",
              matchValueStringList = list(
                "string"
              )
            ),
            claimMatchOperator = "EQUALS"|"CONTAINS"|"CONTAINS_ANY"
          )
        )
      ),
      privateEndpoint = list(
        selfManagedLatticeResource = list(
          resourceConfigurationIdentifier = "string"
        ),
        managedVpcResource = list(
          vpcIdentifier = "string",
          subnetIds = list(
            "string"
          ),
          endpointIpAddressType = "IPV4"|"IPV6",
          securityGroupIds = list(
            "string"
          ),
          tags = list(
            "string"
          ),
          routingDomain = "string"
        )
      ),
      privateEndpointOverrides = list(
        list(
          domain = "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"
            )
          )
        )
      )
    )
  ),
  kmsKeyArn = "string",
  interceptorConfigurations = list(
    list(
      interceptor = list(
        lambda = list(
          arn = "string"
        )
      ),
      interceptionPoints = list(
        "REQUEST"|"RESPONSE"
      ),
      inputConfiguration = list(
        passRequestHeaders = TRUE|FALSE
      )
    )
  ),
  policyEngineConfiguration = list(
    arn = "string",
    mode = "LOG_ONLY"|"ENFORCE"
  ),
  workloadIdentityDetails = list(
    workloadIdentityArn = "string"
  ),
  exceptionLevel = "DEBUG"
)

Request syntax

svc$get_gateway(
  gatewayIdentifier = "string"
)