Class: AWS.BedrockAgent

var params = {
  agentName: 'STRING_VALUE', /* required */
  agentResourceRoleArn: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  customerEncryptionKeyArn: 'STRING_VALUE',
  description: 'STRING_VALUE',
  foundationModel: 'STRING_VALUE',
  idleSessionTTLInSeconds: 'NUMBER_VALUE',
  instruction: 'STRING_VALUE',
  promptOverrideConfiguration: {
    promptConfigurations: [ /* required */
      {
        basePromptTemplate: 'STRING_VALUE',
        inferenceConfiguration: {
          maximumLength: 'NUMBER_VALUE',
          stopSequences: [
            'STRING_VALUE',
            /* more items */
          ],
          temperature: 'NUMBER_VALUE',
          topK: 'NUMBER_VALUE',
          topP: 'NUMBER_VALUE'
        },
        parserMode: DEFAULT | OVERRIDDEN,
        promptCreationMode: DEFAULT | OVERRIDDEN,
        promptState: ENABLED | DISABLED,
        promptType: PRE_PROCESSING | ORCHESTRATION | POST_PROCESSING | KNOWLEDGE_BASE_RESPONSE_GENERATION
      },
      /* more items */
    ],
    overrideLambda: 'STRING_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
bedrockagent.createAgent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentName — (String)

    A name for the agent that you create.

  • agentResourceRoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

  • clientToken — (String)

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    If a token is not provided, the SDK will use a version 4 UUID.
  • customerEncryptionKeyArn — (String)

    The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

  • description — (String)

    A description of the agent.

  • foundationModel — (String)

    The foundation model to be used for orchestration by the agent you create.

  • idleSessionTTLInSeconds — (Integer)

    The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

    A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

  • instruction — (String)

    Instructions that tell the agent what it should do and how it should interact with users.

  • promptOverrideConfiguration — (map)

    Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

    • overrideLambda — (String)

      The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN.

    • promptConfigurations — required — (Array<map>)

      Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

      • basePromptTemplate — (String)

        Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables.

      • inferenceConfiguration — (map)

        Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

        • maximumLength — (Integer)

          The maximum number of tokens to allow in the generated response.

        • stopSequences — (Array<String>)

          A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

        • temperature — (Float)

          The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

        • topK — (Integer)

          While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

        • topP — (Float)

          While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.

      • parserMode — (String)

        Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

        Possible values include:
        • "DEFAULT"
        • "OVERRIDDEN"
      • promptCreationMode — (String)

        Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

        Possible values include:
        • "DEFAULT"
        • "OVERRIDDEN"
      • promptState — (String)

        Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

        • PRE_PROCESSING – ENABLED

        • ORCHESTRATION – ENABLED

        • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED

        • POST_PROCESSING – DISABLED

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • promptType — (String)

        The step in the agent sequence that this prompt configuration applies to.

        Possible values include:
        • "PRE_PROCESSING"
        • "ORCHESTRATION"
        • "POST_PROCESSING"
        • "KNOWLEDGE_BASE_RESPONSE_GENERATION"
  • tags — (map<String>)

    Any tags that you want to attach to the agent.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agent — (map)

      Contains details about the agent created.

      • agentArn — required — (String)

        The Amazon Resource Name (ARN) of the agent.

      • agentId — required — (String)

        The unique identifier of the agent.

      • agentName — required — (String)

        The name of the agent.

      • agentResourceRoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

      • agentStatus — required — (String)

        The status of the agent and whether it is ready for use. The following statuses are possible:

        • CREATING – The agent is being created.

        • PREPARING – The agent is being prepared.

        • PREPARED – The agent is prepared and ready to be invoked.

        • NOT_PREPARED – The agent has been created but not yet prepared.

        • FAILED – The agent API operation failed.

        • UPDATING – The agent is being updated.

        • DELETING – The agent is being deleted.

        Possible values include:
        • "CREATING"
        • "PREPARING"
        • "PREPARED"
        • "NOT_PREPARED"
        • "DELETING"
        • "FAILED"
        • "VERSIONING"
        • "UPDATING"
      • agentVersion — required — (String)

        The version of the agent.

      • clientToken — (String)

        A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

      • createdAt — required — (Date)

        The time at which the agent was created.

      • customerEncryptionKeyArn — (String)

        The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.

      • description — (String)

        The description of the agent.

      • failureReasons — (Array<String>)

        Contains reasons that the agent-related API that you invoked failed.

      • foundationModel — (String)

        The foundation model used for orchestration by the agent.

      • idleSessionTTLInSeconds — required — (Integer)

        The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

        A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

      • instruction — (String)

        Instructions that tell the agent what it should do and how it should interact with users.

      • preparedAt — (Date)

        The time at which the agent was last prepared.

      • promptOverrideConfiguration — (map)

        Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.

        • overrideLambda — (String)

          The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN.

        • promptConfigurations — required — (Array<map>)

          Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

          • basePromptTemplate — (String)

            Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables.

          • inferenceConfiguration — (map)

            Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

            • maximumLength — (Integer)

              The maximum number of tokens to allow in the generated response.

            • stopSequences — (Array<String>)

              A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

            • temperature — (Float)

              The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

            • topK — (Integer)

              While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

            • topP — (Float)

              While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.

          • parserMode — (String)

            Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

            Possible values include:
            • "DEFAULT"
            • "OVERRIDDEN"
          • promptCreationMode — (String)

            Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

            Possible values include:
            • "DEFAULT"
            • "OVERRIDDEN"
          • promptState — (String)

            Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

            • PRE_PROCESSING – ENABLED

            • ORCHESTRATION – ENABLED

            • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED

            • POST_PROCESSING – DISABLED

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • promptType — (String)

            The step in the agent sequence that this prompt configuration applies to.

            Possible values include:
            • "PRE_PROCESSING"
            • "ORCHESTRATION"
            • "POST_PROCESSING"
            • "KNOWLEDGE_BASE_RESPONSE_GENERATION"
      • recommendedActions — (Array<String>)

        Contains recommended actions to take for the agent-related API that you invoked to succeed.

      • updatedAt — required — (Date)

        The time at which the agent was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  actionGroupName: 'STRING_VALUE', /* required */
  agentId: 'STRING_VALUE', /* required */
  agentVersion: 'STRING_VALUE', /* required */
  actionGroupExecutor: {
    customControl: RETURN_CONTROL,
    lambda: 'STRING_VALUE'
  },
  actionGroupState: ENABLED | DISABLED,
  apiSchema: {
    payload: 'STRING_VALUE',
    s3: {
      s3BucketName: 'STRING_VALUE',
      s3ObjectKey: 'STRING_VALUE'
    }
  },
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  functionSchema: {
    functions: [
      {
        name: 'STRING_VALUE', /* required */
        description: 'STRING_VALUE',
        parameters: {
          '<Name>': {
            type: string | number | integer | boolean | array, /* required */
            description: 'STRING_VALUE',
            required: true || false
          },
          /* '<Name>': ... */
        }
      },
      /* more items */
    ]
  },
  parentActionGroupSignature: AMAZON.UserInput
};
bedrockagent.createAgentActionGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • actionGroupExecutor — (map)

    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

    • customControl — (String)

      To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.

      Possible values include:
      • "RETURN_CONTROL"
    • lambda — (String)

      The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

  • actionGroupName — (String)

    The name to give the action group.

  • actionGroupState — (String)

    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • agentId — (String)

    The unique identifier of the agent for which to create the action group.

  • agentVersion — (String)

    The version of the agent for which to create the action group.

  • apiSchema — (map)

    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

    • payload — (String)

      The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

    • s3 — (map)

      Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

      • s3BucketName — (String)

        The name of the S3 bucket.

      • s3ObjectKey — (String)

        The S3 object key containing the resource.

  • clientToken — (String)

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    If a token is not provided, the SDK will use a version 4 UUID.
  • description — (String)

    A description of the action group.

  • functionSchema — (map)

    Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

    • functions — (Array<map>)

      A list of functions that each define an action in the action group.

      • description — (String)

        A description of the function and its purpose.

      • name — required — (String)

        A name for the function.

      • parameters — (map<map>)

        The parameters that the agent elicits from the user to fulfill the function.

        • description — (String)

          A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

        • required — (Boolean)

          Whether the parameter is required for the agent to complete the function for action group invocation.

        • type — required — (String)

          The data type of the parameter.

          Possible values include:
          • "string"
          • "number"
          • "integer"
          • "boolean"
          • "array"
  • parentActionGroupSignature — (String)

    To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

    During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

    Possible values include:
    • "AMAZON.UserInput"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentActionGroup — (map)

      Contains details about the action group that was created.

      • actionGroupExecutor — (map)

        The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

        • customControl — (String)

          To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.

          Possible values include:
          • "RETURN_CONTROL"
        • lambda — (String)

          The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

      • actionGroupId — required — (String)

        The unique identifier of the action group.

      • actionGroupName — required — (String)

        The name of the action group.

      • actionGroupState — required — (String)

        Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • agentId — required — (String)

        The unique identifier of the agent to which the action group belongs.

      • agentVersion — required — (String)

        The version of the agent to which the action group belongs.

      • apiSchema — (map)

        Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

        • payload — (String)

          The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

        • s3 — (map)

          Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

          • s3BucketName — (String)

            The name of the S3 bucket.

          • s3ObjectKey — (String)

            The S3 object key containing the resource.

      • clientToken — (String)

        A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

      • createdAt — required — (Date)

        The time at which the action group was created.

      • description — (String)

        The description of the action group.

      • functionSchema — (map)

        Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

        • functions — (Array<map>)

          A list of functions that each define an action in the action group.

          • description — (String)

            A description of the function and its purpose.

          • name — required — (String)

            A name for the function.

          • parameters — (map<map>)

            The parameters that the agent elicits from the user to fulfill the function.

            • description — (String)

              A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

            • required — (Boolean)

              Whether the parameter is required for the agent to complete the function for action group invocation.

            • type — required — (String)

              The data type of the parameter.

              Possible values include:
              • "string"
              • "number"
              • "integer"
              • "boolean"
              • "array"
      • parentActionSignature — (String)

        If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.

        During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

        Possible values include:
        • "AMAZON.UserInput"
      • updatedAt — required — (Date)

        The time at which the action group was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentAliasName: 'STRING_VALUE', /* required */
  agentId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  routingConfiguration: [
    {
      agentVersion: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
bedrockagent.createAgentAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentAliasName — (String)

    The name of the alias.

  • agentId — (String)

    The unique identifier of the agent.

  • clientToken — (String)

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    If a token is not provided, the SDK will use a version 4 UUID.
  • description — (String)

    A description of the alias of the agent.

  • routingConfiguration — (Array<map>)

    Contains details about the routing configuration of the alias.

    • agentVersion — required — (String)

      The version of the agent with which the alias is associated.

  • tags — (map<String>)

    Any tags that you want to attach to the alias of the agent.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentAlias — (map)

      Contains details about the alias that was created.

      • agentAliasArn — required — (String)

        The Amazon Resource Name (ARN) of the alias of the agent.

      • agentAliasHistoryEvents — (Array<map>)

        Contains details about the history of the alias.

        • endDate — (Date)

          The date that the alias stopped being associated to the version in the routingConfiguration object

        • routingConfiguration — (Array<map>)

          Contains details about the version of the agent with which the alias is associated.

          • agentVersion — required — (String)

            The version of the agent with which the alias is associated.

        • startDate — (Date)

          The date that the alias began being associated to the version in the routingConfiguration object.

      • agentAliasId — required — (String)

        The unique identifier of the alias of the agent.

      • agentAliasName — required — (String)

        The name of the alias of the agent.

      • agentAliasStatus — required — (String)

        The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

        • CREATING – The agent alias is being created.

        • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.

        • FAILED – The agent alias API operation failed.

        • UPDATING – The agent alias is being updated.

        • DELETING – The agent alias is being deleted.

        Possible values include:
        • "CREATING"
        • "PREPARED"
        • "FAILED"
        • "UPDATING"
        • "DELETING"
      • agentId — required — (String)

        The unique identifier of the agent.

      • clientToken — (String)

        A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

      • createdAt — required — (Date)

        The time at which the alias of the agent was created.

      • description — (String)

        The description of the alias of the agent.

      • routingConfiguration — required — (Array<map>)

        Contains details about the routing configuration of the alias.

        • agentVersion — required — (String)

          The version of the agent with which the alias is associated.

      • updatedAt — required — (Date)

        The time at which the alias was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dataSourceConfiguration: { /* required */
    type: S3, /* required */
    s3Configuration: {
      bucketArn: 'STRING_VALUE', /* required */
      bucketOwnerAccountId: 'STRING_VALUE',
      inclusionPrefixes: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  knowledgeBaseId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  dataDeletionPolicy: RETAIN | DELETE,
  description: 'STRING_VALUE',
  serverSideEncryptionConfiguration: {
    kmsKeyArn: 'STRING_VALUE'
  },
  vectorIngestionConfiguration: {
    chunkingConfiguration: {
      chunkingStrategy: FIXED_SIZE | NONE, /* required */
      fixedSizeChunkingConfiguration: {
        maxTokens: 'NUMBER_VALUE', /* required */
        overlapPercentage: 'NUMBER_VALUE' /* required */
      }
    }
  }
};
bedrockagent.createDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    If a token is not provided, the SDK will use a version 4 UUID.
  • dataDeletionPolicy — (String)

    The deletion policy for the requested data source

    Possible values include:
    • "RETAIN"
    • "DELETE"
  • dataSourceConfiguration — (map)

    Contains metadata about where the data source is stored.

    • s3Configuration — (map)

      Contains details about the configuration of the S3 object containing the data source.

      • bucketArn — required — (String)

        The Amazon Resource Name (ARN) of the bucket that contains the data source.

      • bucketOwnerAccountId — (String)

        The account ID for the owner of the S3 bucket.

      • inclusionPrefixes — (Array<String>)

        A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.

    • type — required — (String)

      The type of storage for the data source.

      Possible values include:
      • "S3"
  • description — (String)

    A description of the data source.

  • knowledgeBaseId — (String)

    The unique identifier of the knowledge base to which to add the data source.

  • name — (String)

    The name of the data source.

  • serverSideEncryptionConfiguration — (map)

    Contains details about the server-side encryption for the data source.

    • kmsKeyArn — (String)

      The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.

  • vectorIngestionConfiguration — (map)

    Contains details about how to ingest the documents in the data source.

    • chunkingConfiguration — (map)

      Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

      • chunkingStrategy — required — (String)

        Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

        • FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

        • NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

        Possible values include:
        • "FIXED_SIZE"
        • "NONE"
      • fixedSizeChunkingConfiguration — (map)

        Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

        • maxTokens — required — (Integer)

          The maximum number of tokens to include in a chunk.

        • overlapPercentage — required — (Integer)

          The percentage of overlap between adjacent chunks of a data source.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • dataSource — (map)

      Contains details about the data source.

      • createdAt — required — (Date)

        The time at which the data source was created.

      • dataDeletionPolicy — (String)

        The deletion policy for the data source.

        Possible values include:
        • "RETAIN"
        • "DELETE"
      • dataSourceConfiguration — required — (map)

        Contains details about how the data source is stored.

        • s3Configuration — (map)

          Contains details about the configuration of the S3 object containing the data source.

          • bucketArn — required — (String)

            The Amazon Resource Name (ARN) of the bucket that contains the data source.

          • bucketOwnerAccountId — (String)

            The account ID for the owner of the S3 bucket.

          • inclusionPrefixes — (Array<String>)

            A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.

        • type — required — (String)

          The type of storage for the data source.

          Possible values include:
          • "S3"
      • dataSourceId — required — (String)

        The unique identifier of the data source.

      • description — (String)

        The description of the data source.

      • failureReasons — (Array<String>)

        The details of the failure reasons related to the data source.

      • knowledgeBaseId — required — (String)

        The unique identifier of the knowledge base to which the data source belongs.

      • name — required — (String)

        The name of the data source.

      • serverSideEncryptionConfiguration — (map)

        Contains details about the configuration of the server-side encryption.

        • kmsKeyArn — (String)

          The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.

      • status — required — (String)

        The status of the data source. The following statuses are possible:

        • Available – The data source has been created and is ready for ingestion into the knowledge base.

        • Deleting – The data source is being deleted.

        Possible values include:
        • "AVAILABLE"
        • "DELETING"
        • "DELETE_UNSUCCESSFUL"
      • updatedAt — required — (Date)

        The time at which the data source was last updated.

      • vectorIngestionConfiguration — (map)

        Contains details about how to ingest the documents in the data source.

        • chunkingConfiguration — (map)

          Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

          • chunkingStrategy — required — (String)

            Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

            • FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

            • NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

            Possible values include:
            • "FIXED_SIZE"
            • "NONE"
          • fixedSizeChunkingConfiguration — (map)

            Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

            • maxTokens — required — (Integer)

              The maximum number of tokens to include in a chunk.

            • overlapPercentage — required — (Integer)

              The percentage of overlap between adjacent chunks of a data source.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  knowledgeBaseConfiguration: { /* required */
    type: VECTOR, /* required */
    vectorKnowledgeBaseConfiguration: {
      embeddingModelArn: 'STRING_VALUE' /* required */
    }
  },
  name: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  storageConfiguration: { /* required */
    type: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS, /* required */
    opensearchServerlessConfiguration: {
      collectionArn: 'STRING_VALUE', /* required */
      fieldMapping: { /* required */
        metadataField: 'STRING_VALUE', /* required */
        textField: 'STRING_VALUE', /* required */
        vectorField: 'STRING_VALUE' /* required */
      },
      vectorIndexName: 'STRING_VALUE' /* required */
    },
    pineconeConfiguration: {
      connectionString: 'STRING_VALUE', /* required */
      credentialsSecretArn: 'STRING_VALUE', /* required */
      fieldMapping: { /* required */
        metadataField: 'STRING_VALUE', /* required */
        textField: 'STRING_VALUE' /* required */
      },
      namespace: 'STRING_VALUE'
    },
    rdsConfiguration: {
      credentialsSecretArn: 'STRING_VALUE', /* required */
      databaseName: 'STRING_VALUE', /* required */
      fieldMapping: { /* required */
        metadataField: 'STRING_VALUE', /* required */
        primaryKeyField: 'STRING_VALUE', /* required */
        textField: 'STRING_VALUE', /* required */
        vectorField: 'STRING_VALUE' /* required */
      },
      resourceArn: 'STRING_VALUE', /* required */
      tableName: 'STRING_VALUE' /* required */
    },
    redisEnterpriseCloudConfiguration: {
      credentialsSecretArn: 'STRING_VALUE', /* required */
      endpoint: 'STRING_VALUE', /* required */
      fieldMapping: { /* required */
        metadataField: 'STRING_VALUE', /* required */
        textField: 'STRING_VALUE', /* required */
        vectorField: 'STRING_VALUE' /* required */
      },
      vectorIndexName: 'STRING_VALUE' /* required */
    }
  },
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
bedrockagent.createKnowledgeBase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    If a token is not provided, the SDK will use a version 4 UUID.
  • description — (String)

    A description of the knowledge base.

  • knowledgeBaseConfiguration — (map)

    Contains details about the embeddings model used for the knowledge base.

    • type — required — (String)

      The type of data that the data source is converted into for the knowledge base.

      Possible values include:
      • "VECTOR"
    • vectorKnowledgeBaseConfiguration — (map)

      Contains details about the embeddings model that'sused to convert the data source.

      • embeddingModelArn — required — (String)

        The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

  • name — (String)

    A name for the knowledge base.

  • roleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

  • storageConfiguration — (map)

    Contains details about the configuration of the vector database used for the knowledge base.

    • opensearchServerlessConfiguration — (map)

      Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.

      • collectionArn — required — (String)

        The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

      • fieldMapping — required — (map)

        Contains the names of the fields to which to map information about the vector store.

        • metadataField — required — (String)

          The name of the field in which Amazon Bedrock stores metadata about the vector store.

        • textField — required — (String)

          The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

        • vectorField — required — (String)

          The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

      • vectorIndexName — required — (String)

        The name of the vector store.

    • pineconeConfiguration — (map)

      Contains the storage configuration of the knowledge base in Pinecone.

      • connectionString — required — (String)

        The endpoint URL for your index management page.

      • credentialsSecretArn — required — (String)

        The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.

      • fieldMapping — required — (map)

        Contains the names of the fields to which to map information about the vector store.

        • metadataField — required — (String)

          The name of the field in which Amazon Bedrock stores metadata about the vector store.

        • textField — required — (String)

          The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

      • namespace — (String)

        The namespace to be used to write new data to your database.

    • rdsConfiguration — (map)

      Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

      • credentialsSecretArn — required — (String)

        The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.

      • databaseName — required — (String)

        The name of your Amazon RDS database.

      • fieldMapping — required — (map)

        Contains the names of the fields to which to map information about the vector store.

        • metadataField — required — (String)

          The name of the field in which Amazon Bedrock stores metadata about the vector store.

        • primaryKeyField — required — (String)

          The name of the field in which Amazon Bedrock stores the ID for each entry.

        • textField — required — (String)

          The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

        • vectorField — required — (String)

          The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

      • resourceArn — required — (String)

        The Amazon Resource Name (ARN) of the vector store.

      • tableName — required — (String)

        The name of the table in the database.

    • redisEnterpriseCloudConfiguration — (map)

      Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.

      • credentialsSecretArn — required — (String)

        The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.

      • endpoint — required — (String)

        The endpoint URL of the Redis Enterprise Cloud database.

      • fieldMapping — required — (map)

        Contains the names of the fields to which to map information about the vector store.

        • metadataField — required — (String)

          The name of the field in which Amazon Bedrock stores metadata about the vector store.

        • textField — required — (String)

          The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

        • vectorField — required — (String)

          The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

      • vectorIndexName — required — (String)

        The name of the vector index.

    • type — required — (String)

      The vector store service in which the knowledge base is stored.

      Possible values include:
      • "OPENSEARCH_SERVERLESS"
      • "PINECONE"
      • "REDIS_ENTERPRISE_CLOUD"
      • "RDS"
  • tags — (map<String>)

    Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • knowledgeBase — (map)

      Contains details about the knowledge base.

      • createdAt — required — (Date)

        The time at which the knowledge base was created.

      • description — (String)

        The description of the knowledge base.

      • failureReasons — (Array<String>)

        A list of reasons that the API operation on the knowledge base failed.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseConfiguration — required — (map)

        Contains details about the embeddings configuration of the knowledge base.

        • type — required — (String)

          The type of data that the data source is converted into for the knowledge base.

          Possible values include:
          • "VECTOR"
        • vectorKnowledgeBaseConfiguration — (map)

          Contains details about the embeddings model that'sused to convert the data source.

          • embeddingModelArn — required — (String)

            The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

      • knowledgeBaseId — required — (String)

        The unique identifier of the knowledge base.

      • name — required — (String)

        The name of the knowledge base.

      • roleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

      • status — required — (String)

        The status of the knowledge base. The following statuses are possible:

        • CREATING – The knowledge base is being created.

        • ACTIVE – The knowledge base is ready to be queried.

        • DELETING – The knowledge base is being deleted.

        • UPDATING – The knowledge base is being updated.

        • FAILED – The knowledge base API operation failed.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "FAILED"
        • "DELETE_UNSUCCESSFUL"
      • storageConfiguration — required — (map)

        Contains details about the storage configuration of the knowledge base.

        • opensearchServerlessConfiguration — (map)

          Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.

          • collectionArn — required — (String)

            The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

          • fieldMapping — required — (map)

            Contains the names of the fields to which to map information about the vector store.

            • metadataField — required — (String)

              The name of the field in which Amazon Bedrock stores metadata about the vector store.

            • textField — required — (String)

              The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

            • vectorField — required — (String)

              The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

          • vectorIndexName — required — (String)

            The name of the vector store.

        • pineconeConfiguration — (map)

          Contains the storage configuration of the knowledge base in Pinecone.

          • connectionString — required — (String)

            The endpoint URL for your index management page.

          • credentialsSecretArn — required — (String)

            The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.

          • fieldMapping — required — (map)

            Contains the names of the fields to which to map information about the vector store.

            • metadataField — required — (String)

              The name of the field in which Amazon Bedrock stores metadata about the vector store.

            • textField — required — (String)

              The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

          • namespace — (String)

            The namespace to be used to write new data to your database.

        • rdsConfiguration — (map)

          Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

          • credentialsSecretArn — required — (String)

            The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.

          • databaseName — required — (String)

            The name of your Amazon RDS database.

          • fieldMapping — required — (map)

            Contains the names of the fields to which to map information about the vector store.

            • metadataField — required — (String)

              The name of the field in which Amazon Bedrock stores metadata about the vector store.

            • primaryKeyField — required — (String)

              The name of the field in which Amazon Bedrock stores the ID for each entry.

            • textField — required — (String)

              The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

            • vectorField — required — (String)

              The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

          • resourceArn — required — (String)

            The Amazon Resource Name (ARN) of the vector store.

          • tableName — required — (String)

            The name of the table in the database.

        • redisEnterpriseCloudConfiguration — (map)

          Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.

          • credentialsSecretArn — required — (String)

            The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.

          • endpoint — required — (String)

            The endpoint URL of the Redis Enterprise Cloud database.

          • fieldMapping — required — (map)

            Contains the names of the fields to which to map information about the vector store.

            • metadataField — required — (String)

              The name of the field in which Amazon Bedrock stores metadata about the vector store.

            • textField — required — (String)

              The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

            • vectorField — required — (String)

              The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

          • vectorIndexName — required — (String)

            The name of the vector index.

        • type — required — (String)

          The vector store service in which the knowledge base is stored.

          Possible values include:
          • "OPENSEARCH_SERVERLESS"
          • "PINECONE"
          • "REDIS_ENTERPRISE_CLOUD"
          • "RDS"
      • updatedAt — required — (Date)

        The time at which the knowledge base was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentId: 'STRING_VALUE', /* required */
  skipResourceInUseCheck: true || false
};
bedrockagent.deleteAgent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentId — (String)

    The unique identifier of the agent to delete.

  • skipResourceInUseCheck — (Boolean)

    By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentId — (String)

      The unique identifier of the agent that was deleted.

    • agentStatus — (String)

      The status of the agent.

      Possible values include:
      • "CREATING"
      • "PREPARING"
      • "PREPARED"
      • "NOT_PREPARED"
      • "DELETING"
      • "FAILED"
      • "VERSIONING"
      • "UPDATING"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  actionGroupId: 'STRING_VALUE', /* required */
  agentId: 'STRING_VALUE', /* required */
  agentVersion: 'STRING_VALUE', /* required */
  skipResourceInUseCheck: true || false
};
bedrockagent.deleteAgentActionGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • actionGroupId — (String)

    The unique identifier of the action group to delete.

  • agentId — (String)

    The unique identifier of the agent that the action group belongs to.

  • agentVersion — (String)

    The version of the agent that the action group belongs to.

  • skipResourceInUseCheck — (Boolean)

    By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentAliasId: 'STRING_VALUE', /* required */
  agentId: 'STRING_VALUE' /* required */
};
bedrockagent.deleteAgentAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentAliasId — (String)

    The unique identifier of the alias to delete.

  • agentId — (String)

    The unique identifier of the agent that the alias belongs to.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentAliasId — (String)

      The unique identifier of the alias that was deleted.

    • agentAliasStatus — (String)

      The status of the alias.

      Possible values include:
      • "CREATING"
      • "PREPARED"
      • "FAILED"
      • "UPDATING"
      • "DELETING"
    • agentId — (String)

      The unique identifier of the agent that the alias belongs to.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentId: 'STRING_VALUE', /* required */
  agentVersion: 'STRING_VALUE', /* required */
  skipResourceInUseCheck: true || false
};
bedrockagent.deleteAgentVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentId — (String)

    The unique identifier of the agent that the version belongs to.

  • agentVersion — (String)

    The version of the agent to delete.

  • skipResourceInUseCheck — (Boolean)

    By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentId — (String)

      The unique identifier of the agent that the version belongs to.

    • agentStatus — (String)

      The status of the agent version.

      Possible values include:
      • "CREATING"
      • "PREPARING"
      • "PREPARED"
      • "NOT_PREPARED"
      • "DELETING"
      • "FAILED"
      • "VERSIONING"
      • "UPDATING"
    • agentVersion — (String)

      The version that was deleted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dataSourceId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
bedrockagent.deleteDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • dataSourceId — (String)

    The unique identifier of the data source to delete.

  • knowledgeBaseId — (String)

    The unique identifier of the knowledge base from which to delete the data source.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • dataSourceId — (String)

      The unique identifier of the data source that was deleted.

    • knowledgeBaseId — (String)

      The unique identifier of the knowledge base to which the data source that was deleted belonged.

    • status — (String)

      The status of the data source.

      Possible values include:
      • "AVAILABLE"
      • "DELETING"
      • "DELETE_UNSUCCESSFUL"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
bedrockagent.deleteKnowledgeBase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • knowledgeBaseId — (String)

    The unique identifier of the knowledge base to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • knowledgeBaseId — (String)

      The unique identifier of the knowledge base that was deleted.

    • status — (String)

      The status of the knowledge base and whether it has been successfully deleted.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
      • "UPDATING"
      • "FAILED"
      • "DELETE_UNSUCCESSFUL"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentId: 'STRING_VALUE', /* required */
  agentVersion: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
bedrockagent.disassociateAgentKnowledgeBase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentId — (String)

    The unique identifier of the agent from which to disassociate the knowledge base.

  • agentVersion — (String)

    The version of the agent from which to disassociate the knowledge base.

  • knowledgeBaseId — (String)

    The unique identifier of the knowledge base to disassociate.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentId: 'STRING_VALUE' /* required */
};
bedrockagent.getAgent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentId — (String)

    The unique identifier of the agent.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agent — (map)

      Contains details about the agent.

      • agentArn — required — (String)

        The Amazon Resource Name (ARN) of the agent.

      • agentId — required — (String)

        The unique identifier of the agent.

      • agentName — required — (String)

        The name of the agent.

      • agentResourceRoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

      • agentStatus — required — (String)

        The status of the agent and whether it is ready for use. The following statuses are possible:

        • CREATING – The agent is being created.

        • PREPARING – The agent is being prepared.

        • PREPARED – The agent is prepared and ready to be invoked.

        • NOT_PREPARED – The agent has been created but not yet prepared.

        • FAILED – The agent API operation failed.

        • UPDATING – The agent is being updated.

        • DELETING – The agent is being deleted.

        Possible values include:
        • "CREATING"
        • "PREPARING"
        • "PREPARED"
        • "NOT_PREPARED"
        • "DELETING"
        • "FAILED"
        • "VERSIONING"
        • "UPDATING"
      • agentVersion — required — (String)

        The version of the agent.

      • clientToken — (String)

        A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

      • createdAt — required — (Date)

        The time at which the agent was created.

      • customerEncryptionKeyArn — (String)

        The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.

      • description — (String)

        The description of the agent.

      • failureReasons — (Array<String>)

        Contains reasons that the agent-related API that you invoked failed.

      • foundationModel — (String)

        The foundation model used for orchestration by the agent.

      • idleSessionTTLInSeconds — required — (Integer)

        The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

        A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

      • instruction — (String)

        Instructions that tell the agent what it should do and how it should interact with users.

      • preparedAt — (Date)

        The time at which the agent was last prepared.

      • promptOverrideConfiguration — (map)

        Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.

        • overrideLambda — (String)

          The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN.

        • promptConfigurations — required — (Array<map>)

          Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

          • basePromptTemplate — (String)

            Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables.

          • inferenceConfiguration — (map)

            Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

            • maximumLength — (Integer)

              The maximum number of tokens to allow in the generated response.

            • stopSequences — (Array<String>)

              A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

            • temperature — (Float)

              The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

            • topK — (Integer)

              While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

            • topP — (Float)

              While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.

          • parserMode — (String)

            Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

            Possible values include:
            • "DEFAULT"
            • "OVERRIDDEN"
          • promptCreationMode — (String)

            Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

            Possible values include:
            • "DEFAULT"
            • "OVERRIDDEN"
          • promptState — (String)

            Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

            • PRE_PROCESSING – ENABLED

            • ORCHESTRATION – ENABLED

            • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED

            • POST_PROCESSING – DISABLED

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • promptType — (String)

            The step in the agent sequence that this prompt configuration applies to.

            Possible values include:
            • "PRE_PROCESSING"
            • "ORCHESTRATION"
            • "POST_PROCESSING"
            • "KNOWLEDGE_BASE_RESPONSE_GENERATION"
      • recommendedActions — (Array<String>)

        Contains recommended actions to take for the agent-related API that you invoked to succeed.

      • updatedAt — required — (Date)

        The time at which the agent was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  actionGroupId: 'STRING_VALUE', /* required */
  agentId: 'STRING_VALUE', /* required */
  agentVersion: 'STRING_VALUE' /* required */
};
bedrockagent.getAgentActionGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • actionGroupId — (String)

    The unique identifier of the action group for which to get information.

  • agentId — (String)

    The unique identifier of the agent that the action group belongs to.

  • agentVersion — (String)

    The version of the agent that the action group belongs to.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentActionGroup — (map)

      Contains details about the action group.

      • actionGroupExecutor — (map)

        The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

        • customControl — (String)

          To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.

          Possible values include:
          • "RETURN_CONTROL"
        • lambda — (String)

          The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

      • actionGroupId — required — (String)

        The unique identifier of the action group.

      • actionGroupName — required — (String)

        The name of the action group.

      • actionGroupState — required — (String)

        Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • agentId — required — (String)

        The unique identifier of the agent to which the action group belongs.

      • agentVersion — required — (String)

        The version of the agent to which the action group belongs.

      • apiSchema — (map)

        Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

        • payload — (String)

          The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

        • s3 — (map)

          Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

          • s3BucketName — (String)

            The name of the S3 bucket.

          • s3ObjectKey — (String)

            The S3 object key containing the resource.

      • clientToken — (String)

        A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

      • createdAt — required — (Date)

        The time at which the action group was created.

      • description — (String)

        The description of the action group.

      • functionSchema — (map)

        Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

        • functions — (Array<map>)

          A list of functions that each define an action in the action group.

          • description — (String)

            A description of the function and its purpose.

          • name — required — (String)

            A name for the function.

          • parameters — (map<map>)

            The parameters that the agent elicits from the user to fulfill the function.

            • description — (String)

              A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

            • required — (Boolean)

              Whether the parameter is required for the agent to complete the function for action group invocation.

            • type — required — (String)

              The data type of the parameter.

              Possible values include:
              • "string"
              • "number"
              • "integer"
              • "boolean"
              • "array"
      • parentActionSignature — (String)

        If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.

        During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

        Possible values include:
        • "AMAZON.UserInput"
      • updatedAt — required — (Date)

        The time at which the action group was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentAliasId: 'STRING_VALUE', /* required */
  agentId: 'STRING_VALUE' /* required */
};
bedrockagent.getAgentAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentAliasId — (String)

    The unique identifier of the alias for which to get information.

  • agentId — (String)

    The unique identifier of the agent to which the alias to get information belongs.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentAlias — (map)

      Contains information about the alias.

      • agentAliasArn — required — (String)

        The Amazon Resource Name (ARN) of the alias of the agent.

      • agentAliasHistoryEvents — (Array<map>)

        Contains details about the history of the alias.

        • endDate — (Date)

          The date that the alias stopped being associated to the version in the routingConfiguration object

        • routingConfiguration — (Array<map>)

          Contains details about the version of the agent with which the alias is associated.

          • agentVersion — required — (String)

            The version of the agent with which the alias is associated.

        • startDate — (Date)

          The date that the alias began being associated to the version in the routingConfiguration object.

      • agentAliasId — required — (String)

        The unique identifier of the alias of the agent.

      • agentAliasName — required — (String)

        The name of the alias of the agent.

      • agentAliasStatus — required — (String)

        The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

        • CREATING – The agent alias is being created.

        • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.

        • FAILED – The agent alias API operation failed.

        • UPDATING – The agent alias is being updated.

        • DELETING – The agent alias is being deleted.

        Possible values include:
        • "CREATING"
        • "PREPARED"
        • "FAILED"
        • "UPDATING"
        • "DELETING"
      • agentId — required — (String)

        The unique identifier of the agent.

      • clientToken — (String)

        A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

      • createdAt — required — (Date)

        The time at which the alias of the agent was created.

      • description — (String)

        The description of the alias of the agent.

      • routingConfiguration — required — (Array<map>)

        Contains details about the routing configuration of the alias.

        • agentVersion — required — (String)

          The version of the agent with which the alias is associated.

      • updatedAt — required — (Date)

        The time at which the alias was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentId: 'STRING_VALUE', /* required */
  agentVersion: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
bedrockagent.getAgentKnowledgeBase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentId — (String)

    The unique identifier of the agent with which the knowledge base is associated.

  • agentVersion — (String)

    The version of the agent with which the knowledge base is associated.

  • knowledgeBaseId — (String)

    The unique identifier of the knowledge base associated with the agent.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentKnowledgeBase — (map)

      Contains details about a knowledge base attached to an agent.

      • agentId — required — (String)

        The unique identifier of the agent with which the knowledge base is associated.

      • agentVersion — required — (String)

        The version of the agent with which the knowledge base is associated.

      • createdAt — required — (Date)

        The time at which the association between the agent and the knowledge base was created.

      • description — required — (String)

        The description of the association between the agent and the knowledge base.

      • knowledgeBaseId — required — (String)

        The unique identifier of the association between the agent and the knowledge base.

      • knowledgeBaseState — required — (String)

        Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • updatedAt — required — (Date)

        The time at which the association between the agent and the knowledge base was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentId: 'STRING_VALUE', /* required */
  agentVersion: 'STRING_VALUE' /* required */
};
bedrockagent.getAgentVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentId — (String)

    The unique identifier of the agent.

  • agentVersion — (String)

    The version of the agent.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentVersion — (map)

      Contains details about the version of the agent.

      • agentArn — required — (String)

        The Amazon Resource Name (ARN) of the agent that the version belongs to.

      • agentId — required — (String)

        The unique identifier of the agent that the version belongs to.

      • agentName — required — (String)

        The name of the agent that the version belongs to.

      • agentResourceRoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

      • agentStatus — required — (String)

        The status of the agent that the version belongs to.

        Possible values include:
        • "CREATING"
        • "PREPARING"
        • "PREPARED"
        • "NOT_PREPARED"
        • "DELETING"
        • "FAILED"
        • "VERSIONING"
        • "UPDATING"
      • createdAt — required — (Date)

        The time at which the version was created.

      • customerEncryptionKeyArn — (String)

        The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.

      • description — (String)

        The description of the version.

      • failureReasons — (Array<String>)

        A list of reasons that the API operation on the version failed.

      • foundationModel — (String)

        The foundation model that the version invokes.

      • idleSessionTTLInSeconds — required — (Integer)

        The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

        A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

      • instruction — (String)

        The instructions provided to the agent.

      • promptOverrideConfiguration — (map)

        Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.

        • overrideLambda — (String)

          The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN.

        • promptConfigurations — required — (Array<map>)

          Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

          • basePromptTemplate — (String)

            Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables.

          • inferenceConfiguration — (map)

            Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

            • maximumLength — (Integer)

              The maximum number of tokens to allow in the generated response.

            • stopSequences — (Array<String>)

              A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

            • temperature — (Float)

              The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

            • topK — (Integer)

              While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

            • topP — (Float)

              While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.

          • parserMode — (String)

            Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

            Possible values include:
            • "DEFAULT"
            • "OVERRIDDEN"
          • promptCreationMode — (String)

            Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

            Possible values include:
            • "DEFAULT"
            • "OVERRIDDEN"
          • promptState — (String)

            Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

            • PRE_PROCESSING – ENABLED

            • ORCHESTRATION – ENABLED

            • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED

            • POST_PROCESSING – DISABLED

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • promptType — (String)

            The step in the agent sequence that this prompt configuration applies to.

            Possible values include:
            • "PRE_PROCESSING"
            • "ORCHESTRATION"
            • "POST_PROCESSING"
            • "KNOWLEDGE_BASE_RESPONSE_GENERATION"
      • recommendedActions — (Array<String>)

        A list of recommended actions to take for the failed API operation on the version to succeed.

      • updatedAt — required — (Date)

        The time at which the version was last updated.

      • version — required — (String)

        The version number.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dataSourceId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
bedrockagent.getDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • dataSourceId — (String)

    The unique identifier of the data source.

  • knowledgeBaseId — (String)

    The unique identifier of the knowledge base that the data source was added to.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • dataSource — (map)

      Contains details about the data source.

      • createdAt — required — (Date)

        The time at which the data source was created.

      • dataDeletionPolicy — (String)

        The deletion policy for the data source.

        Possible values include:
        • "RETAIN"
        • "DELETE"
      • dataSourceConfiguration — required — (map)

        Contains details about how the data source is stored.

        • s3Configuration — (map)

          Contains details about the configuration of the S3 object containing the data source.

          • bucketArn — required — (String)

            The Amazon Resource Name (ARN) of the bucket that contains the data source.

          • bucketOwnerAccountId — (String)

            The account ID for the owner of the S3 bucket.

          • inclusionPrefixes — (Array<String>)

            A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.

        • type — required — (String)

          The type of storage for the data source.

          Possible values include:
          • "S3"
      • dataSourceId — required — (String)

        The unique identifier of the data source.

      • description — (String)

        The description of the data source.

      • failureReasons — (Array<String>)

        The details of the failure reasons related to the data source.

      • knowledgeBaseId — required — (String)

        The unique identifier of the knowledge base to which the data source belongs.

      • name — required — (String)

        The name of the data source.

      • serverSideEncryptionConfiguration — (map)

        Contains details about the configuration of the server-side encryption.

        • kmsKeyArn — (String)

          The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.

      • status — required — (String)

        The status of the data source. The following statuses are possible:

        • Available – The data source has been created and is ready for ingestion into the knowledge base.

        • Deleting – The data source is being deleted.

        Possible values include:
        • "AVAILABLE"
        • "DELETING"
        • "DELETE_UNSUCCESSFUL"
      • updatedAt — required — (Date)

        The time at which the data source was last updated.

      • vectorIngestionConfiguration — (map)

        Contains details about how to ingest the documents in the data source.

        • chunkingConfiguration — (map)

          Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

          • chunkingStrategy — required — (String)

            Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

            • FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

            • NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

            Possible values include:
            • "FIXED_SIZE"
            • "NONE"
          • fixedSizeChunkingConfiguration — (map)

            Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

            • maxTokens — required — (Integer)

              The maximum number of tokens to include in a chunk.

            • overlapPercentage — required — (Integer)

              The percentage of overlap between adjacent chunks of a data source.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dataSourceId: 'STRING_VALUE', /* required */
  ingestionJobId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
bedrockagent.getIngestionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • dataSourceId — (String)

    The unique identifier of the data source in the ingestion job.

  • ingestionJobId — (String)

    The unique identifier of the ingestion job.

  • knowledgeBaseId — (String)

    The unique identifier of the knowledge base for which the ingestion job applies.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ingestionJob — (map)

      Contains details about the ingestion job.

      • dataSourceId — required — (String)

        The unique identifier of the ingested data source.

      • description — (String)

        The description of the ingestion job.

      • failureReasons — (Array<String>)

        A list of reasons that the ingestion job failed.

      • ingestionJobId — required — (String)

        The unique identifier of the ingestion job.

      • knowledgeBaseId — required — (String)

        The unique identifier of the knowledge base to which the data source is being added.

      • startedAt — required — (Date)

        The time at which the ingestion job started.

      • statistics — (map)

        Contains statistics about the ingestion job.

        • numberOfDocumentsDeleted — (Integer)

          The number of source documents that was deleted.

        • numberOfDocumentsFailed — (Integer)

          The number of source documents that failed to be ingested.

        • numberOfDocumentsScanned — (Integer)

          The total number of source documents that were scanned. Includes new, updated, and unchanged documents.

        • numberOfMetadataDocumentsModified — (Integer)

          The number of metadata files that were updated or deleted.

        • numberOfMetadataDocumentsScanned — (Integer)

          The total number of metadata files that were scanned. Includes new, updated, and unchanged files.

        • numberOfModifiedDocumentsIndexed — (Integer)

          The number of modified source documents in the data source that were successfully indexed.

        • numberOfNewDocumentsIndexed — (Integer)

          The number of new source documents in the data source that were successfully indexed.

      • status — required — (String)

        The status of the ingestion job.

        Possible values include:
        • "STARTING"
        • "IN_PROGRESS"
        • "COMPLETE"
        • "FAILED"
      • updatedAt — required — (Date)

        The time at which the ingestion job was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
bedrockagent.getKnowledgeBase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • knowledgeBaseId — (String)

    The unique identifier of the knowledge base for which to get information.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • knowledgeBase — (map)

      Contains details about the knowledge base.

      • createdAt — required — (Date)

        The time at which the knowledge base was created.

      • description — (String)

        The description of the knowledge base.

      • failureReasons — (Array<String>)

        A list of reasons that the API operation on the knowledge base failed.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseConfiguration — required — (map)

        Contains details about the embeddings configuration of the knowledge base.

        • type — required — (String)

          The type of data that the data source is converted into for the knowledge base.

          Possible values include:
          • "VECTOR"
        • vectorKnowledgeBaseConfiguration — (map)

          Contains details about the embeddings model that'sused to convert the data source.

          • embeddingModelArn — required — (String)

            The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

      • knowledgeBaseId — required — (String)

        The unique identifier of the knowledge base.

      • name — required — (String)

        The name of the knowledge base.

      • roleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

      • status — required — (String)

        The status of the knowledge base. The following statuses are possible:

        • CREATING – The knowledge base is being created.

        • ACTIVE – The knowledge base is ready to be queried.

        • DELETING – The knowledge base is being deleted.

        • UPDATING – The knowledge base is being updated.

        • FAILED – The knowledge base API operation failed.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "FAILED"
        • "DELETE_UNSUCCESSFUL"
      • storageConfiguration — required — (map)

        Contains details about the storage configuration of the knowledge base.

        • opensearchServerlessConfiguration — (map)

          Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.

          • collectionArn — required — (String)

            The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

          • fieldMapping — required — (map)

            Contains the names of the fields to which to map information about the vector store.

            • metadataField — required — (String)

              The name of the field in which Amazon Bedrock stores metadata about the vector store.

            • textField — required — (String)

              The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

            • vectorField — required — (String)

              The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

          • vectorIndexName — required — (String)

            The name of the vector store.

        • pineconeConfiguration — (map)

          Contains the storage configuration of the knowledge base in Pinecone.

          • connectionString — required — (String)

            The endpoint URL for your index management page.

          • credentialsSecretArn — required — (String)

            The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.

          • fieldMapping — required — (map)

            Contains the names of the fields to which to map information about the vector store.

            • metadataField — required — (String)

              The name of the field in which Amazon Bedrock stores metadata about the vector store.

            • textField — required — (String)

              The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

          • namespace — (String)

            The namespace to be used to write new data to your database.

        • rdsConfiguration — (map)

          Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

          • credentialsSecretArn — required — (String)

            The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.

          • databaseName — required — (String)

            The name of your Amazon RDS database.

          • fieldMapping — required — (map)

            Contains the names of the fields to which to map information about the vector store.

            • metadataField — required — (String)

              The name of the field in which Amazon Bedrock stores metadata about the vector store.

            • primaryKeyField — required — (String)

              The name of the field in which Amazon Bedrock stores the ID for each entry.

            • textField — required — (String)

              The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

            • vectorField — required — (String)

              The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

          • resourceArn — required — (String)

            The Amazon Resource Name (ARN) of the vector store.

          • tableName — required — (String)

            The name of the table in the database.

        • redisEnterpriseCloudConfiguration — (map)

          Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.

          • credentialsSecretArn — required — (String)

            The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.

          • endpoint — required — (String)

            The endpoint URL of the Redis Enterprise Cloud database.

          • fieldMapping — required — (map)

            Contains the names of the fields to which to map information about the vector store.

            • metadataField — required — (String)

              The name of the field in which Amazon Bedrock stores metadata about the vector store.

            • textField — required — (String)

              The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

            • vectorField — required — (String)

              The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

          • vectorIndexName — required — (String)

            The name of the vector index.

        • type — required — (String)

          The vector store service in which the knowledge base is stored.

          Possible values include:
          • "OPENSEARCH_SERVERLESS"
          • "PINECONE"
          • "REDIS_ENTERPRISE_CLOUD"
          • "RDS"
      • updatedAt — required — (Date)

        The time at which the knowledge base was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentId: 'STRING_VALUE', /* required */
  agentVersion: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
bedrockagent.listAgentActionGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentId — (String)

    The unique identifier of the agent.

  • agentVersion — (String)

    The version of the agent.

  • maxResults — (Integer)

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken — (String)

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • actionGroupSummaries — (Array<map>)

      A list of objects, each of which contains information about an action group.

      • actionGroupId — required — (String)

        The unique identifier of the action group.

      • actionGroupName — required — (String)

        The name of the action group.

      • actionGroupState — required — (String)

        Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • description — (String)

        The description of the action group.

      • updatedAt — required — (Date)

        The time at which the action group was last updated.

    • nextToken — (String)

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
bedrockagent.listAgentAliases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentId — (String)

    The unique identifier of the agent.

  • maxResults — (Integer)

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken — (String)

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentAliasSummaries — (Array<map>)

      A list of objects, each of which contains information about an alias of the agent.

      • agentAliasId — required — (String)

        Contains details about

      • agentAliasName — required — (String)

        The name of the alias.

      • agentAliasStatus — required — (String)

        The status of the alias.

        Possible values include:
        • "CREATING"
        • "PREPARED"
        • "FAILED"
        • "UPDATING"
        • "DELETING"
      • createdAt — required — (Date)

        The time at which the alias of the agent was created.

      • description — (String)

        The description of the alias.

      • routingConfiguration — (Array<map>)

        Contains details about the version of the agent with which the alias is associated.

        • agentVersion — required — (String)

          The version of the agent with which the alias is associated.

      • updatedAt — required — (Date)

        The time at which the alias was last updated.

    • nextToken — (String)

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentId: 'STRING_VALUE', /* required */
  agentVersion: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
bedrockagent.listAgentKnowledgeBases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentId — (String)

    The unique identifier of the agent for which to return information about knowledge bases associated with it.

  • agentVersion — (String)

    The version of the agent for which to return information about knowledge bases associated with it.

  • maxResults — (Integer)

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken — (String)

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentKnowledgeBaseSummaries — (Array<map>)

      A list of objects, each of which contains information about a knowledge base associated with the agent.

      • description — (String)

        The description of the knowledge base associated with an agent.

      • knowledgeBaseId — required — (String)

        The unique identifier of the knowledge base associated with an agent.

      • knowledgeBaseState — required — (String)

        Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • updatedAt — required — (Date)

        The time at which the knowledge base associated with an agent was last updated.

    • nextToken — (String)

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
bedrockagent.listAgents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken — (String)

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentSummaries — (Array<map>)

      A list of objects, each of which contains information about an agent.

      • agentId — required — (String)

        The unique identifier of the agent.

      • agentName — required — (String)

        The name of the agent.

      • agentStatus — required — (String)

        The status of the agent.

        Possible values include:
        • "CREATING"
        • "PREPARING"
        • "PREPARED"
        • "NOT_PREPARED"
        • "DELETING"
        • "FAILED"
        • "VERSIONING"
        • "UPDATING"
      • description — (String)

        The description of the agent.

      • latestAgentVersion — (String)

        The latest version of the agent.

      • updatedAt — required — (Date)

        The time at which the agent was last updated.

    • nextToken — (String)

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
bedrockagent.listAgentVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentId — (String)

    The unique identifier of the agent.

  • maxResults — (Integer)

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken — (String)

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentVersionSummaries — (Array<map>)

      A list of objects, each of which contains information about a version of the agent.

      • agentName — required — (String)

        The name of the agent to which the version belongs.

      • agentStatus — required — (String)

        The status of the agent to which the version belongs.

        Possible values include:
        • "CREATING"
        • "PREPARING"
        • "PREPARED"
        • "NOT_PREPARED"
        • "DELETING"
        • "FAILED"
        • "VERSIONING"
        • "UPDATING"
      • agentVersion — required — (String)

        The version of the agent.

      • createdAt — required — (Date)

        The time at which the version was created.

      • description — (String)

        The description of the version of the agent.

      • updatedAt — required — (Date)

        The time at which the version was last updated.

    • nextToken — (String)

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  knowledgeBaseId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
bedrockagent.listDataSources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • knowledgeBaseId — (String)

    The unique identifier of the knowledge base for which to return a list of information.

  • maxResults — (Integer)

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken — (String)

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • dataSourceSummaries — (Array<map>)

      A list of objects, each of which contains information about a data source.

      • dataSourceId — required — (String)

        The unique identifier of the data source.

      • description — (String)

        The description of the data source.

      • knowledgeBaseId — required — (String)

        The unique identifier of the knowledge base to which the data source belongs.

      • name — required — (String)

        The name of the data source.

      • status — required — (String)

        The status of the data source.

        Possible values include:
        • "AVAILABLE"
        • "DELETING"
        • "DELETE_UNSUCCESSFUL"
      • updatedAt — required — (Date)

        The time at which the data source was last updated.

    • nextToken — (String)

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dataSourceId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE', /* required */
  filters: [
    {
      attribute: STATUS, /* required */
      operator: EQ, /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    attribute: STATUS | STARTED_AT, /* required */
    order: ASCENDING | DESCENDING /* required */
  }
};
bedrockagent.listIngestionJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • dataSourceId — (String)

    The unique identifier of the data source for which to return ingestion jobs.

  • filters — (Array<map>)

    Contains a definition of a filter for which to filter the results.

    • attribute — required — (String)

      The attribute by which to filter the results.

      Possible values include:
      • "STATUS"
    • operator — required — (String)

      The operation to carry out between the attribute and the values.

      Possible values include:
      • "EQ"
    • values — required — (Array<String>)

      A list of values for the attribute.

  • knowledgeBaseId — (String)

    The unique identifier of the knowledge base for which to return ingestion jobs.

  • maxResults — (Integer)

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken — (String)

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

  • sortBy — (map)

    Contains details about how to sort the results.

    • attribute — required — (String)

      The attribute by which to sort the results.

      Possible values include:
      • "STATUS"
      • "STARTED_AT"
    • order — required — (String)

      The order by which to sort the results.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ingestionJobSummaries — (Array<map>)

      A list of objects, each of which contains information about an ingestion job.

      • dataSourceId — required — (String)

        The unique identifier of the data source in the ingestion job.

      • description — (String)

        The description of the ingestion job.

      • ingestionJobId — required — (String)

        The unique identifier of the ingestion job.

      • knowledgeBaseId — required — (String)

        The unique identifier of the knowledge base to which the data source is added.

      • startedAt — required — (Date)

        The time at which the ingestion job was started.

      • statistics — (map)

        Contains statistics for the ingestion job.

        • numberOfDocumentsDeleted — (Integer)

          The number of source documents that was deleted.

        • numberOfDocumentsFailed — (Integer)

          The number of source documents that failed to be ingested.

        • numberOfDocumentsScanned — (Integer)

          The total number of source documents that were scanned. Includes new, updated, and unchanged documents.

        • numberOfMetadataDocumentsModified — (Integer)

          The number of metadata files that were updated or deleted.

        • numberOfMetadataDocumentsScanned — (Integer)

          The total number of metadata files that were scanned. Includes new, updated, and unchanged files.

        • numberOfModifiedDocumentsIndexed — (Integer)

          The number of modified source documents in the data source that were successfully indexed.

        • numberOfNewDocumentsIndexed — (Integer)

          The number of new source documents in the data source that were successfully indexed.

      • status — required — (String)

        The status of the ingestion job.

        Possible values include:
        • "STARTING"
        • "IN_PROGRESS"
        • "COMPLETE"
        • "FAILED"
      • updatedAt — required — (Date)

        The time at which the ingestion job was last updated.

    • nextToken — (String)

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
bedrockagent.listKnowledgeBases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken — (String)

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • knowledgeBaseSummaries — (Array<map>)

      A list of objects, each of which contains information about a knowledge base.

      • description — (String)

        The description of the knowledge base.

      • knowledgeBaseId — required — (String)

        The unique identifier of the knowledge base.

      • name — required — (String)

        The name of the knowledge base.

      • status — required — (String)

        The status of the knowledge base.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "FAILED"
        • "DELETE_UNSUCCESSFUL"
      • updatedAt — required — (Date)

        The time at which the knowledge base was last updated.

    • nextToken — (String)

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
bedrockagent.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource for which to list tags.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      The key-value pairs for the tags associated with the resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentId: 'STRING_VALUE' /* required */
};
bedrockagent.prepareAgent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentId — (String)

    The unique identifier of the agent for which to create a DRAFT version.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • agentId — (String)

      The unique identifier of the agent for which the DRAFT version was created.

    • agentStatus — (String)

      The status of the DRAFT version and whether it is ready for use.

      Possible values include:
      • "CREATING"
      • "PREPARING"
      • "PREPARED"
      • "NOT_PREPARED"
      • "DELETING"
      • "FAILED"
      • "VERSIONING"
      • "UPDATING"
    • agentVersion — (String)

      The version of the agent.

    • preparedAt — (Date)

      The time at which the DRAFT version of the agent was last prepared.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dataSourceId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
bedrockagent.startIngestionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    If a token is not provided, the SDK will use a version 4 UUID.
  • dataSourceId — (String)

    The unique identifier of the data source to ingest.

  • description — (String)

    A description of the ingestion job.

  • knowledgeBaseId — (String)

    The unique identifier of the knowledge base to which to add the data source.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ingestionJob — (map)

      An object containing information about the ingestion job.

      • dataSourceId — required — (String)

        The unique identifier of the ingested data source.

      • description — (String)

        The description of the ingestion job.

      • failureReasons — (Array<String>)

        A list of reasons that the ingestion job failed.

      • ingestionJobId — required — (String)

        The unique identifier of the ingestion job.

      • knowledgeBaseId — required — (String)

        The unique identifier of the knowledge base to which the data source is being added.

      • startedAt — required — (Date)

        The time at which the ingestion job started.

      • statistics — (map)

        Contains statistics about the ingestion job.

        • numberOfDocumentsDeleted — (Integer)

          The number of source documents that was deleted.

        • numberOfDocumentsFailed — (Integer)

          The number of source documents that failed to be ingested.

        • numberOfDocumentsScanned — (Integer)

          The total number of source documents that were scanned. Includes new, updated, and unchanged documents.

        • numberOfMetadataDocumentsModified — (Integer)

          The number of metadata files that were updated or deleted.

        • numberOfMetadataDocumentsScanned — (Integer)

          The total number of metadata files that were scanned. Includes new, updated, and unchanged files.

        • numberOfModifiedDocumentsIndexed — (Integer)

          The number of modified source documents in the data source that were successfully indexed.

        • numberOfNewDocumentsIndexed — (Integer)

          The number of new source documents in the data source that were successfully indexed.

      • status — required — (String)

        The status of the ingestion job.

        Possible values include:
        • "STARTING"
        • "IN_PROGRESS"
        • "COMPLETE"
        • "FAILED"
      • updatedAt — required — (Date)

        The time at which the ingestion job was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
bedrockagent.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource to tag.

  • tags — (map<String>)

    An object containing key-value pairs that define the tags to attach to the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
bedrockagent.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource from which to remove tags.

  • tagKeys — (Array<String>)

    A list of keys of the tags to remove from the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  agentId: 'STRING_VALUE', /* required */
  agentName: 'STRING_VALUE', /* required */
  agentResourceRoleArn: 'STRING_VALUE', /* required */
  foundationModel: 'STRING_VALUE', /* required */
  customerEncryptionKeyArn: 'STRING_VALUE',
  description: 'STRING_VALUE',
  idleSessionTTLInSeconds: 'NUMBER_VALUE',
  instruction: 'STRING_VALUE',
  promptOverrideConfiguration: {
    promptConfigurations: [ /* required */
      {
        basePromptTemplate: 'STRING_VALUE',
        inferenceConfiguration: {
          maximumLength: 'NUMBER_VALUE',
          stopSequences: [
            'STRING_VALUE',
            /* more items */
          ],
          temperature: 'NUMBER_VALUE',
          topK: 'NUMBER_VALUE',
          topP: 'NUMBER_VALUE'
        },
        parserMode: DEFAULT | OVERRIDDEN,
        promptCreationMode: DEFAULT | OVERRIDDEN,
        promptState: ENABLED | DISABLED,
        promptType: PRE_PROCESSING | ORCHESTRATION | POST_PROCESSING | KNOWLEDGE_BASE_RESPONSE_GENERATION
      },
      /* more items */
    ],
    overrideLambda: 'STRING_VALUE'
  }
};
bedrockagent.updateAgent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • agentId — (String)

    The unique identifier of the agent.

  • agentName — (String)

    Specifies a new name for the agent.

  • agentResourceRoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

  • customerEncryptionKeyArn — (String)

    The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

  • description — (String)

    Specifies a new description of the agent.

  • foundationModel — (String)

    Specifies a new foundation model to be used for orchestration by the agent.

  • idleSessionTTLInSeconds — (Integer)

    The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

    A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

  • instruction — (String)

    Specifies new instructions that tell the agent what it should do and how it should interact with users.

  • promptOverrideConfiguration — (map)

    Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

    • overrideLambda — (String)

      The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN.

    • promptConfigurations — required — (Array<map>)

      Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

      • basePromptTemplate — (String)

        Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables.

      • inferenceConfiguration — (map)

        Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

        • maximumLength — (Integer)

          The maximum number of tokens to allow in the generated response.

        • stopSequences — (Array<String>)

          A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

        • temperature — (Float)

          The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

        • topK — (Integer)

          While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

        • topP — (Float)

          While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.

      • parserMode — (String)

        Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

        Possible values include:
        • "DEFAULT"
        • "OVERRIDDEN"
      • promptCreationMode — (String)

        Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

        Possible values include:
        • "DEFAULT"
        • "OVERRIDDEN"
      • promptState — (String)

        Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

        • PRE_PROCESSING – ENABLED

        • ORCHESTRATION – ENABLED

        • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED

        • POST_PROCESSING – DISABLED

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • promptType — (String)

        The step in the agent sequence that this prompt configuration applies to.

        Possible values include:
        • "PRE_PROCESSING"
        • "ORCHESTRATION"
        • "POST_PROCESSING"
        • "KNOWLEDGE_BASE_RESPONSE_GENERATION"