Updates an existing gateway¶

Description¶

Updates an existing gateway.

Usage¶

bedrockagentcorecontrol_update_gateway(gatewayIdentifier, name,
  description, roleArn, protocolType, protocolConfiguration,
  authorizerType, authorizerConfiguration, kmsKeyArn,
  customTransformConfiguration, interceptorConfigurations,
  policyEngineConfiguration, exceptionLevel, wafConfiguration)

Arguments¶

gatewayIdentifier

[required] The identifier of the gateway to update.
name

[required] The name of the gateway. This name must be the same as the one when the gateway was created.
description

The updated description for the gateway.
roleArn

[required] The updated IAM role ARN that provides permissions for the gateway.
protocolType

The updated protocol type for the gateway.
protocolConfiguration

The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.
authorizerType

[required] The updated authorizer type for the gateway.
authorizerConfiguration

The updated authorizer configuration for the gateway.
kmsKeyArn

The updated ARN of the KMS key used to encrypt the gateway.
customTransformConfiguration

The updated custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.
interceptorConfigurations

The updated interceptor configurations for the gateway.
policyEngineConfiguration

The updated policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.
exceptionLevel

The level of detail in error messages returned when invoking the gateway.
- If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.
- If the value is omitted, a generic error message is returned to the end user.
wafConfiguration

The updated Amazon Web Services WAF configuration for the gateway.

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
      ),
      disableMcpListToolsPagination = 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"
      ),
      advertisedScopeMapping = 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"
            )
          )
        )
      ),
      allowedWorkloadConfiguration = list(
        hostingEnvironments = list(
          list(
            arn = "string"
          )
        ),
        workloadIdentities = list(
          "string"
        )
      )
    )
  ),
  kmsKeyArn = "string",
  customTransformConfiguration = list(
    lambda = list(
      arn = "string"
    )
  ),
  interceptorConfigurations = list(
    list(
      interceptor = list(
        lambda = list(
          arn = "string"
        )
      ),
      interceptionPoints = list(
        "REQUEST"|"RESPONSE"
      ),
      inputConfiguration = list(
        passRequestHeaders = TRUE|FALSE,
        payloadFilter = list(
          exclude = list(
            list(
              field = "RESPONSE_BODY"
            )
          )
        )
      )
    )
  ),
  policyEngineConfiguration = list(
    arn = "string",
    mode = "LOG_ONLY"|"ENFORCE"
  ),
  workloadIdentityDetails = list(
    workloadIdentityArn = "string"
  ),
  exceptionLevel = "DEBUG",
  webAclArn = "string",
  wafConfiguration = list(
    failureMode = "FAIL_CLOSE"|"FAIL_OPEN"
  )
)

Request syntax¶

svc$update_gateway(
  gatewayIdentifier = "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
      ),
      disableMcpListToolsPagination = 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"
      ),
      advertisedScopeMapping = 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"
            )
          )
        )
      ),
      allowedWorkloadConfiguration = list(
        hostingEnvironments = list(
          list(
            arn = "string"
          )
        ),
        workloadIdentities = list(
          "string"
        )
      )
    )
  ),
  kmsKeyArn = "string",
  customTransformConfiguration = list(
    lambda = list(
      arn = "string"
    )
  ),
  interceptorConfigurations = list(
    list(
      interceptor = list(
        lambda = list(
          arn = "string"
        )
      ),
      interceptionPoints = list(
        "REQUEST"|"RESPONSE"
      ),
      inputConfiguration = list(
        passRequestHeaders = TRUE|FALSE,
        payloadFilter = list(
          exclude = list(
            list(
              field = "RESPONSE_BODY"
            )
          )
        )
      )
    )
  ),
  policyEngineConfiguration = list(
    arn = "string",
    mode = "LOG_ONLY"|"ENFORCE"
  ),
  exceptionLevel = "DEBUG",
  wafConfiguration = list(
    failureMode = "FAIL_CLOSE"|"FAIL_OPEN"
  )
)