Skip to content

Updates an existing API key credential provider

Description

Updates an existing API key credential provider.

Usage

bedrockagentcorecontrol_update_api_key_credential_provider(name, apiKey,
  apiKeySecretConfig, apiKeySecretSource)

Arguments

  • name

    [required] The name of the API key credential provider to update.

  • apiKey

    The new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.

  • apiKeySecretConfig

    A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

  • apiKeySecretSource

    The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

Value

A list with the following syntax:

list(
  apiKeySecretArn = list(
    secretArn = "string"
  ),
  apiKeySecretJsonKey = "string",
  apiKeySecretSource = "MANAGED"|"EXTERNAL",
  name = "string",
  credentialProviderArn = "string",
  createdTime = as.POSIXct(
    "2015-01-01"
  ),
  lastUpdatedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$update_api_key_credential_provider(
  name = "string",
  apiKey = "string",
  apiKeySecretConfig = list(
    secretId = "string",
    jsonKey = "string"
  ),
  apiKeySecretSource = "MANAGED"|"EXTERNAL"
)