Class: AWS.BedrockAgent

var params = {
  agentName: 'STRING_VALUE', /* required */
  agentResourceRoleArn: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  customerEncryptionKeyArn: 'STRING_VALUE',
  description: 'STRING_VALUE',
  foundationModel: 'STRING_VALUE',
  guardrailConfiguration: {
    guardrailIdentifier: 'STRING_VALUE',
    guardrailVersion: 'STRING_VALUE'
  },
  idleSessionTTLInSeconds: 'NUMBER_VALUE',
  instruction: 'STRING_VALUE',
  memoryConfiguration: {
    enabledMemoryTypes: [ /* required */
      SESSION_SUMMARY,
      /* more items */
    ],
    storageDays: 'NUMBER_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.

  • guardrailConfiguration — (map)

    The unique Guardrail configuration assigned to the agent when it is created.

    • guardrailIdentifier — (String)

      The unique identifier of the guardrail.

    • guardrailVersion — (String)

      The version of the guardrail.

  • 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.

  • memoryConfiguration — (map)

    Contains the details of the memory configured for the agent.

    • enabledMemoryTypes — required — (Array<String>)

      The type of memory that is stored.

    • storageDays — (Integer)

      The number of days the agent is configured to retain the conversational context.

  • 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. For more information, see Parser Lambda function in Agents for Amazon Bedrock.

    • 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. For more information, see Configure the prompt templates.

      • 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.

      • guardrailConfiguration — (map)

        Details about the guardrail associated with the agent.

        • guardrailIdentifier — (String)

          The unique identifier of the guardrail.

        • guardrailVersion — (String)

          The version of the guardrail.

      • 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.

      • memoryConfiguration — (map)

        Contains memory configuration for the agent.

        • enabledMemoryTypes — required — (Array<String>)

          The type of memory that is stored.

        • storageDays — (Integer)

          The number of days the agent is configured to retain the conversational context.

      • 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. For more information, see Parser Lambda function in Agents for Amazon Bedrock.

        • 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. For more information, see Configure the prompt templates.

          • 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>': ... */
        },
        requireConfirmation: ENABLED | DISABLED
      },
      /* more items */
    ]
  },
  parentActionGroupSignature: AMAZON.UserInput | AMAZON.CodeInterpreter
};
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 or the custom control method for handling the information elicited from the user.

    • 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 for the S3 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"
      • requireConfirmation — (String)

        Contains information if user confirmation is required to invoke the function.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
  • 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.

    To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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"
    • "AMAZON.CodeInterpreter"

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 or the custom control method for handling the information elicited from the user.

        • 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 for the S3 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"
          • requireConfirmation — (String)

            Contains information if user confirmation is required to invoke the function.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
      • 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"
        • "AMAZON.CodeInterpreter"
      • 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',
      provisionedThroughput: 'STRING_VALUE'
    },
    /* 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 — (String)

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

    • provisionedThroughput — (String)

      Information on the Provisioned Throughput assigned to an agent alias.

  • 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 — (String)

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

          • provisionedThroughput — (String)

            Information on the Provisioned Throughput assigned to an agent alias.

        • 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.

      • failureReasons — (Array<String>)

        Information on the failure of Provisioned Throughput assigned to an agent alias.

      • routingConfiguration — required — (Array<map>)

        Contains details about the routing configuration of the alias.

        • agentVersion — (String)

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

        • provisionedThroughput — (String)

          Information on the Provisioned Throughput assigned to an agent alias.

      • 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 | WEB | CONFLUENCE | SALESFORCE | SHAREPOINT, /* required */
    confluenceConfiguration: {
      sourceConfiguration: { /* required */
        authType: BASIC | OAUTH2_CLIENT_CREDENTIALS, /* required */
        credentialsSecretArn: 'STRING_VALUE', /* required */
        hostType: SAAS, /* required */
        hostUrl: 'STRING_VALUE' /* required */
      },
      crawlerConfiguration: {
        filterConfiguration: {
          type: PATTERN, /* required */
          patternObjectFilter: {
            filters: [ /* required */
              {
                objectType: 'STRING_VALUE', /* required */
                exclusionFilters: [
                  'STRING_VALUE',
                  /* more items */
                ],
                inclusionFilters: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              /* more items */
            ]
          }
        }
      }
    },
    s3Configuration: {
      bucketArn: 'STRING_VALUE', /* required */
      bucketOwnerAccountId: 'STRING_VALUE',
      inclusionPrefixes: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    salesforceConfiguration: {
      sourceConfiguration: { /* required */
        authType: OAUTH2_CLIENT_CREDENTIALS, /* required */
        credentialsSecretArn: 'STRING_VALUE', /* required */
        hostUrl: 'STRING_VALUE' /* required */
      },
      crawlerConfiguration: {
        filterConfiguration: {
          type: PATTERN, /* required */
          patternObjectFilter: {
            filters: [ /* required */
              {
                objectType: 'STRING_VALUE', /* required */
                exclusionFilters: [
                  'STRING_VALUE',
                  /* more items */
                ],
                inclusionFilters: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              /* more items */
            ]
          }
        }
      }
    },
    sharePointConfiguration: {
      sourceConfiguration: { /* required */
        authType: OAUTH2_CLIENT_CREDENTIALS, /* required */
        credentialsSecretArn: 'STRING_VALUE', /* required */
        domain: 'STRING_VALUE', /* required */
        hostType: ONLINE, /* required */
        siteUrls: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        tenantId: 'STRING_VALUE'
      },
      crawlerConfiguration: {
        filterConfiguration: {
          type: PATTERN, /* required */
          patternObjectFilter: {
            filters: [ /* required */
              {
                objectType: 'STRING_VALUE', /* required */
                exclusionFilters: [
                  'STRING_VALUE',
                  /* more items */
                ],
                inclusionFilters: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              /* more items */
            ]
          }
        }
      }
    },
    webConfiguration: {
      sourceConfiguration: { /* required */
        urlConfiguration: { /* required */
          seedUrls: [
            {
              url: 'STRING_VALUE'
            },
            /* more items */
          ]
        }
      },
      crawlerConfiguration: {
        crawlerLimits: {
          rateLimit: 'NUMBER_VALUE'
        },
        exclusionFilters: [
          'STRING_VALUE',
          /* more items */
        ],
        inclusionFilters: [
          'STRING_VALUE',
          /* more items */
        ],
        scope: HOST_ONLY | SUBDOMAINS
      }
    }
  },
  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 | HIERARCHICAL | SEMANTIC, /* required */
      fixedSizeChunkingConfiguration: {
        maxTokens: 'NUMBER_VALUE', /* required */
        overlapPercentage: 'NUMBER_VALUE' /* required */
      },
      hierarchicalChunkingConfiguration: {
        levelConfigurations: [ /* required */
          {
            maxTokens: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ],
        overlapTokens: 'NUMBER_VALUE' /* required */
      },
      semanticChunkingConfiguration: {
        breakpointPercentileThreshold: 'NUMBER_VALUE', /* required */
        bufferSize: 'NUMBER_VALUE', /* required */
        maxTokens: 'NUMBER_VALUE' /* required */
      }
    },
    customTransformationConfiguration: {
      intermediateStorage: { /* required */
        s3Location: { /* required */
          uri: 'STRING_VALUE' /* required */
        }
      },
      transformations: [ /* required */
        {
          stepToApply: POST_CHUNKING, /* required */
          transformationFunction: { /* required */
            transformationLambdaConfiguration: { /* required */
              lambdaArn: 'STRING_VALUE' /* required */
            }
          }
        },
        /* more items */
      ]
    },
    parsingConfiguration: {
      parsingStrategy: BEDROCK_FOUNDATION_MODEL, /* required */
      bedrockFoundationModelConfiguration: {
        modelArn: 'STRING_VALUE', /* required */
        parsingPrompt: {
          parsingPromptText: 'STRING_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 data deletion policy for the data source.

    You can set the data deletion policy to:

    • DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted, only the data. This flag is ignored if an Amazon Web Services account is deleted.

    • RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted if you delete a knowledge base or data source resource.

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

    The connection configuration for the data source.

    • confluenceConfiguration — (map)

      The configuration information to connect to Confluence as your data source.

      Note: Confluence data source connector is in preview release and is subject to change.
      • crawlerConfiguration — (map)

        The configuration of the Confluence content. For example, configuring specific types of Confluence content.

        • filterConfiguration — (map)

          The configuration of filtering the Confluence content. For example, configuring regular expression patterns to include or exclude certain content.

          • patternObjectFilter — (map)

            The configuration of filtering certain objects or content types of the data source.

            • filters — required — (Array<map>)

              The configuration of specific filters applied to your data source content. You can filter out or include certain content.

              • exclusionFilters — (Array<String>)

                A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

              • inclusionFilters — (Array<String>)

                A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

              • objectType — required — (String)

                The supported object type or content type of the data source.

          • type — required — (String)

            The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.

            Possible values include:
            • "PATTERN"
      • sourceConfiguration — required — (map)

        The endpoint information to connect to your Confluence data source.

        • authType — required — (String)

          The supported authentication type to authenticate and connect to your Confluence instance.

          Possible values include:
          • "BASIC"
          • "OAUTH2_CLIENT_CREDENTIALS"
        • credentialsSecretArn — required — (String)

          The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Confluence connection configuration.

        • hostType — required — (String)

          The supported host type, whether online/cloud or server/on-premises.

          Possible values include:
          • "SAAS"
        • hostUrl — required — (String)

          The Confluence host URL or instance URL.

    • s3Configuration — (map)

      The configuration information to connect to Amazon S3 as your data source.

      • bucketArn — required — (String)

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

      • bucketOwnerAccountId — (String)

        The account ID for the owner of the S3 bucket.

      • inclusionPrefixes — (Array<String>)

        A list of S3 prefixes to include certain files or content. For more information, see Organizing objects using prefixes.

    • salesforceConfiguration — (map)

      The configuration information to connect to Salesforce as your data source.

      Note: Salesforce data source connector is in preview release and is subject to change.
      • crawlerConfiguration — (map)

        The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.

        • filterConfiguration — (map)

          The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content.

          • patternObjectFilter — (map)

            The configuration of filtering certain objects or content types of the data source.

            • filters — required — (Array<map>)

              The configuration of specific filters applied to your data source content. You can filter out or include certain content.

              • exclusionFilters — (Array<String>)

                A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

              • inclusionFilters — (Array<String>)

                A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

              • objectType — required — (String)

                The supported object type or content type of the data source.

          • type — required — (String)

            The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.

            Possible values include:
            • "PATTERN"
      • sourceConfiguration — required — (map)

        The endpoint information to connect to your Salesforce data source.

        • authType — required — (String)

          The supported authentication type to authenticate and connect to your Salesforce instance.

          Possible values include:
          • "OAUTH2_CLIENT_CREDENTIALS"
        • credentialsSecretArn — required — (String)

          The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Salesforce connection configuration.

        • hostUrl — required — (String)

          The Salesforce host URL or instance URL.

    • sharePointConfiguration — (map)

      The configuration information to connect to SharePoint as your data source.

      Note: SharePoint data source connector is in preview release and is subject to change.
      • crawlerConfiguration — (map)

        The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.

        • filterConfiguration — (map)

          The configuration of filtering the SharePoint content. For example, configuring regular expression patterns to include or exclude certain content.

          • patternObjectFilter — (map)

            The configuration of filtering certain objects or content types of the data source.

            • filters — required — (Array<map>)

              The configuration of specific filters applied to your data source content. You can filter out or include certain content.

              • exclusionFilters — (Array<String>)

                A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

              • inclusionFilters — (Array<String>)

                A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

              • objectType — required — (String)

                The supported object type or content type of the data source.

          • type — required — (String)

            The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.

            Possible values include:
            • "PATTERN"
      • sourceConfiguration — required — (map)

        The endpoint information to connect to your SharePoint data source.

        • authType — required — (String)

          The supported authentication type to authenticate and connect to your SharePoint site/sites.

          Possible values include:
          • "OAUTH2_CLIENT_CREDENTIALS"
        • credentialsSecretArn — required — (String)

          The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration.

        • domain — required — (String)

          The domain of your SharePoint instance or site URL/URLs.

        • hostType — required — (String)

          The supported host type, whether online/cloud or server/on-premises.

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

          A list of one or more SharePoint site URLs.

        • tenantId — (String)

          The identifier of your Microsoft 365 tenant.

    • type — required — (String)

      The type of data source.

      Possible values include:
      • "S3"
      • "WEB"
      • "CONFLUENCE"
      • "SALESFORCE"
      • "SHAREPOINT"
    • webConfiguration — (map)

      The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs.

      Note: Crawling web URLs as your data source is in preview release and is subject to change.
      • crawlerConfiguration — (map)

        The Web Crawler configuration details for the web data source.

        • crawlerLimits — (map)

          The configuration of crawl limits for the web URLs.

          • rateLimit — (Integer)

            The max rate at which pages are crawled, up to 300 per minute per host.

        • exclusionFilters — (Array<String>)

          A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.

        • inclusionFilters — (Array<String>)

          A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.

        • scope — (String)

          The scope of what is crawled for your URLs.

          You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".

          Possible values include:
          • "HOST_ONLY"
          • "SUBDOMAINS"
      • sourceConfiguration — required — (map)

        The source configuration details for the web data source.

        • urlConfiguration — required — (map)

          The configuration of the URL/URLs.

          • seedUrls — (Array<map>)

            One or more seed or starting point URLs.

            • url — (String)

              A seed or starting point URL.

  • 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.

        • HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

        • SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.

        • 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"
        • "HIERARCHICAL"
        • "SEMANTIC"
      • 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.

      • hierarchicalChunkingConfiguration — (map)

        Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

        • levelConfigurations — required — (Array<map>)

          Token settings for each layer.

          • maxTokens — required — (Integer)

            The maximum number of tokens that a chunk can contain in this layer.

        • overlapTokens — required — (Integer)

          The number of tokens to repeat across chunks in the same layer.

      • semanticChunkingConfiguration — (map)

        Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.

        • breakpointPercentileThreshold — required — (Integer)

          The dissimilarity threshold for splitting chunks.

        • bufferSize — required — (Integer)

          The buffer size.

        • maxTokens — required — (Integer)

          The maximum number of tokens that a chunk can contain.

    • customTransformationConfiguration — (map)

      A custom document transformer for parsed data source documents.

      • intermediateStorage — required — (map)

        An S3 bucket path for input and output objects.

        • s3Location — required — (map)

          An S3 bucket path.

          • uri — required — (String)

            The location's URI. For example, s3://my-bucket/chunk-processor/.

      • transformations — required — (Array<map>)

        A Lambda function that processes documents.

        • stepToApply — required — (String)

          When the service applies the transformation.

          Possible values include:
          • "POST_CHUNKING"
        • transformationFunction — required — (map)

          A Lambda function that processes documents.

          • transformationLambdaConfiguration — required — (map)

            The Lambda function.

            • lambdaArn — required — (String)

              The function's ARN identifier.

    • parsingConfiguration — (map)

      A custom parser for data source documents.

      • bedrockFoundationModelConfiguration — (map)

        Settings for a foundation model used to parse documents for a data source.

        • modelArn — required — (String)

          The model's ARN.

        • parsingPrompt — (map)

          Instructions for interpreting the contents of a document.

          • parsingPromptText — required — (String)

            Instructions for interpreting the contents of a document.

      • parsingStrategy — required — (String)

        The parsing strategy for the data source.

        Possible values include:
        • "BEDROCK_FOUNDATION_MODEL"

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 data deletion policy for the data source.

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

        The connection configuration for the data source.

        • confluenceConfiguration — (map)

          The configuration information to connect to Confluence as your data source.

          Note: Confluence data source connector is in preview release and is subject to change.
          • crawlerConfiguration — (map)

            The configuration of the Confluence content. For example, configuring specific types of Confluence content.

            • filterConfiguration — (map)

              The configuration of filtering the Confluence content. For example, configuring regular expression patterns to include or exclude certain content.

              • patternObjectFilter — (map)

                The configuration of filtering certain objects or content types of the data source.

                • filters — required — (Array<map>)

                  The configuration of specific filters applied to your data source content. You can filter out or include certain content.

                  • exclusionFilters — (Array<String>)

                    A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

                  • inclusionFilters — (Array<String>)

                    A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

                  • objectType — required — (String)

                    The supported object type or content type of the data source.

              • type — required — (String)

                The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.

                Possible values include:
                • "PATTERN"
          • sourceConfiguration — required — (map)

            The endpoint information to connect to your Confluence data source.

            • authType — required — (String)

              The supported authentication type to authenticate and connect to your Confluence instance.

              Possible values include:
              • "BASIC"
              • "OAUTH2_CLIENT_CREDENTIALS"
            • credentialsSecretArn — required — (String)

              The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Confluence connection configuration.

            • hostType — required — (String)

              The supported host type, whether online/cloud or server/on-premises.

              Possible values include:
              • "SAAS"
            • hostUrl — required — (String)

              The Confluence host URL or instance URL.

        • s3Configuration — (map)

          The configuration information to connect to Amazon S3 as your data source.

          • bucketArn — required — (String)

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

          • bucketOwnerAccountId — (String)

            The account ID for the owner of the S3 bucket.

          • inclusionPrefixes — (Array<String>)

            A list of S3 prefixes to include certain files or content. For more information, see Organizing objects using prefixes.

        • salesforceConfiguration — (map)

          The configuration information to connect to Salesforce as your data source.

          Note: Salesforce data source connector is in preview release and is subject to change.
          • crawlerConfiguration — (map)

            The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.

            • filterConfiguration — (map)

              The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content.

              • patternObjectFilter — (map)

                The configuration of filtering certain objects or content types of the data source.

                • filters — required — (Array<map>)

                  The configuration of specific filters applied to your data source content. You can filter out or include certain content.

                  • exclusionFilters — (Array<String>)

                    A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

                  • inclusionFilters — (Array<String>)

                    A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

                  • objectType — required — (String)

                    The supported object type or content type of the data source.

              • type — required — (String)

                The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.

                Possible values include:
                • "PATTERN"
          • sourceConfiguration — required — (map)

            The endpoint information to connect to your Salesforce data source.

            • authType — required — (String)

              The supported authentication type to authenticate and connect to your Salesforce instance.

              Possible values include:
              • "OAUTH2_CLIENT_CREDENTIALS"
            • credentialsSecretArn — required — (String)

              The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Salesforce connection configuration.

            • hostUrl — required — (String)

              The Salesforce host URL or instance URL.

        • sharePointConfiguration — (map)

          The configuration information to connect to SharePoint as your data source.

          Note: SharePoint data source connector is in preview release and is subject to change.
          • crawlerConfiguration — (map)

            The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.

            • filterConfiguration — (map)

              The configuration of filtering the SharePoint content. For example, configuring regular expression patterns to include or exclude certain content.

              • patternObjectFilter — (map)

                The configuration of filtering certain objects or content types of the data source.

                • filters — required — (Array<map>)

                  The configuration of specific filters applied to your data source content. You can filter out or include certain content.

                  • exclusionFilters — (Array<String>)

                    A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

                  • inclusionFilters — (Array<String>)

                    A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

                  • objectType — required — (String)

                    The supported object type or content type of the data source.

              • type — required — (String)

                The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.

                Possible values include:
                • "PATTERN"
          • sourceConfiguration — required — (map)

            The endpoint information to connect to your SharePoint data source.

            • authType — required — (String)

              The supported authentication type to authenticate and connect to your SharePoint site/sites.

              Possible values include:
              • "OAUTH2_CLIENT_CREDENTIALS"
            • credentialsSecretArn — required — (String)

              The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration.

            • domain — required — (String)

              The domain of your SharePoint instance or site URL/URLs.

            • hostType — required — (String)

              The supported host type, whether online/cloud or server/on-premises.

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

              A list of one or more SharePoint site URLs.

            • tenantId — (String)

              The identifier of your Microsoft 365 tenant.

        • type — required — (String)

          The type of data source.

          Possible values include:
          • "S3"
          • "WEB"
          • "CONFLUENCE"
          • "SALESFORCE"
          • "SHAREPOINT"
        • webConfiguration — (map)

          The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs.

          Note: Crawling web URLs as your data source is in preview release and is subject to change.
          • crawlerConfiguration — (map)

            The Web Crawler configuration details for the web data source.

            • crawlerLimits — (map)

              The configuration of crawl limits for the web URLs.

              • rateLimit — (Integer)

                The max rate at which pages are crawled, up to 300 per minute per host.

            • exclusionFilters — (Array<String>)

              A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.

            • inclusionFilters — (Array<String>)

              A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.

            • scope — (String)

              The scope of what is crawled for your URLs.

              You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".

              Possible values include:
              • "HOST_ONLY"
              • "SUBDOMAINS"
          • sourceConfiguration — required — (map)

            The source configuration details for the web data source.

            • urlConfiguration — required — (map)

              The configuration of the URL/URLs.

              • seedUrls — (Array<map>)

                One or more seed or starting point URLs.

                • url — (String)

                  A seed or starting point URL.

      • dataSourceId — required — (String)

        The unique identifier of the data source.

      • description — (String)

        The description of the data source.

      • failureReasons — (Array<String>)

        The detailed reasons on the failure to delete a 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.

            • HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

            • SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.

            • 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"
            • "HIERARCHICAL"
            • "SEMANTIC"
          • 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.

          • hierarchicalChunkingConfiguration — (map)

            Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

            • levelConfigurations — required — (Array<map>)

              Token settings for each layer.

              • maxTokens — required — (Integer)

                The maximum number of tokens that a chunk can contain in this layer.

            • overlapTokens — required — (Integer)

              The number of tokens to repeat across chunks in the same layer.

          • semanticChunkingConfiguration — (map)

            Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.

            • breakpointPercentileThreshold — required — (Integer)

              The dissimilarity threshold for splitting chunks.

            • bufferSize — required — (Integer)

              The buffer size.

            • maxTokens — required — (Integer)

              The maximum number of tokens that a chunk can contain.

        • customTransformationConfiguration — (map)

          A custom document transformer for parsed data source documents.

          • intermediateStorage — required — (map)

            An S3 bucket path for input and output objects.

            • s3Location — required — (map)

              An S3 bucket path.

              • uri — required — (String)

                The location's URI. For example, s3://my-bucket/chunk-processor/.

          • transformations — required — (Array<map>)

            A Lambda function that processes documents.

            • stepToApply — required — (String)

              When the service applies the transformation.

              Possible values include:
              • "POST_CHUNKING"
            • transformationFunction — required — (map)

              A Lambda function that processes documents.

              • transformationLambdaConfiguration — required — (map)

                The Lambda function.

                • lambdaArn — required — (String)

                  The function's ARN identifier.

        • parsingConfiguration — (map)

          A custom parser for data source documents.

          • bedrockFoundationModelConfiguration — (map)

            Settings for a foundation model used to parse documents for a data source.

            • modelArn — required — (String)

              The model's ARN.

            • parsingPrompt — (map)

              Instructions for interpreting the contents of a document.

              • parsingPromptText — required — (String)

                Instructions for interpreting the contents of a document.

          • parsingStrategy — required — (String)

            The parsing strategy for the data source.

            Possible values include:
            • "BEDROCK_FOUNDATION_MODEL"

Returns:

• (AWS.Request) —

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

var params = {
  executionRoleArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  customerEncryptionKeyArn: 'STRING_VALUE',
  definition: {
    connections: [
      {
        name: 'STRING_VALUE', /* required */
        source: 'STRING_VALUE', /* required */
        target: 'STRING_VALUE', /* required */
        type: Data | Conditional, /* required */
        configuration: {
          conditional: {
            condition: 'STRING_VALUE' /* required */
          },
          data: {
            sourceOutput: 'STRING_VALUE', /* required */
            targetInput: 'STRING_VALUE' /* required */
          }
        }
      },
      /* more items */
    ],
    nodes: [
      {
        name: 'STRING_VALUE', /* required */
        type: Input | Output | KnowledgeBase | Condition | Lex | Prompt | LambdaFunction | Storage | Agent | Retrieval | Iterator | Collector, /* required */
        configuration: {
          agent: {
            agentAliasArn: 'STRING_VALUE' /* required */
          },
          collector: {
          },
          condition: {
            conditions: [ /* required */
              {
                name: 'STRING_VALUE', /* required */
                expression: 'STRING_VALUE'
              },
              /* more items */
            ]
          },
          input: {
          },
          iterator: {
          },
          knowledgeBase: {
            knowledgeBaseId: 'STRING_VALUE', /* required */
            modelId: 'STRING_VALUE'
          },
          lambdaFunction: {
            lambdaArn: 'STRING_VALUE' /* required */
          },
          lex: {
            botAliasArn: 'STRING_VALUE', /* required */
            localeId: 'STRING_VALUE' /* required */
          },
          output: {
          },
          prompt: {
            sourceConfiguration: { /* required */
              inline: {
                modelId: 'STRING_VALUE', /* required */
                templateConfiguration: { /* required */
                  text: {
                    text: 'STRING_VALUE', /* required */
                    inputVariables: [
                      {
                        name: 'STRING_VALUE'
                      },
                      /* more items */
                    ]
                  }
                },
                templateType: TEXT, /* required */
                inferenceConfiguration: {
                  text: {
                    maxTokens: 'NUMBER_VALUE',
                    stopSequences: [
                      'STRING_VALUE',
                      /* more items */
                    ],
                    temperature: 'NUMBER_VALUE',
                    topK: 'NUMBER_VALUE',
                    topP: 'NUMBER_VALUE'
                  }
                }
              },
              resource: {
                promptArn: 'STRING_VALUE' /* required */
              }
            }
          },
          retrieval: {
            serviceConfiguration: { /* required */
              s3: {
                bucketName: 'STRING_VALUE' /* required */
              }
            }
          },
          storage: {
            serviceConfiguration: { /* required */
              s3: {
                bucketName: 'STRING_VALUE' /* required */
              }
            }
          }
        },
        inputs: [
          {
            expression: 'STRING_VALUE', /* required */
            name: 'STRING_VALUE', /* required */
            type: String | Number | Boolean | Object | Array /* required */
          },
          /* more items */
        ],
        outputs: [
          {
            name: 'STRING_VALUE', /* required */
            type: String | Number | Boolean | Object | Array /* required */
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
bedrockagent.createFlow(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.
  • customerEncryptionKeyArn — (String)

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

  • definition — (map)

    A definition of the nodes and connections between nodes in the flow.

    • connections — (Array<map>)

      An array of connection definitions in the flow.

      • configuration — (map)

        The configuration of the connection.

        • conditional — (map)

          The configuration of a connection originating from a Condition node.

          • condition — required — (String)

            The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the Node types topic in the Amazon Bedrock User Guide.

        • data — (map)

          The configuration of a connection originating from a node that isn't a Condition node.

          • sourceOutput — required — (String)

            The name of the output in the source node that the connection begins from.

          • targetInput — required — (String)

            The name of the input in the target node that the connection ends at.

      • name — required — (String)

        A name for the connection that you can reference.

      • source — required — (String)

        The node that the connection starts at.

      • target — required — (String)

        The node that the connection ends at.

      • type — required — (String)

        Whether the source node that the connection begins from is a condition node (Conditional) or not (Data).

        Possible values include:
        • "Data"
        • "Conditional"
    • nodes — (Array<map>)

      An array of node definitions in the flow.

      • configuration — (map)

        Contains configurations for the node.

        • agent — (map)

          Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.

          • agentAliasArn — required — (String)

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

        • collector — (map)

          Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.

        • condition — (map)

          Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.

          • conditions — required — (Array<map>)

            An array of conditions. Each member contains the name of a condition and an expression that defines the condition.

            • expression — (String)

              Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in Node types in prompt flows.

            • name — required — (String)

              A name for the condition that you can reference.

        • input — (map)

          Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.

        • iterator — (map)

          Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

          The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

        • knowledgeBase — (map)

          Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

          • knowledgeBaseId — required — (String)

            The unique identifier of the knowledge base to query.

          • modelId — (String)

            The unique identifier of the model to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.

        • lambdaFunction — (map)

          Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.

          • lambdaArn — required — (String)

            The Amazon Resource Name (ARN) of the Lambda function to invoke.

        • lex — (map)

          Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.

          • botAliasArn — required — (String)

            The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.

          • localeId — required — (String)

            The Region to invoke the Amazon Lex bot in.

        • output — (map)

          Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.

        • prompt — (map)

          Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.

          • sourceConfiguration — required — (map)

            Specifies whether the prompt is from Prompt management or defined inline.

            • inline — (map)

              Contains configurations for a prompt that is defined inline

              • inferenceConfiguration — (map)

                Contains inference configurations for the prompt.

                • text — (map)

                  Contains inference configurations for a text prompt.

                  • maxTokens — (Integer)

                    The maximum number of tokens to return in the response.

                  • stopSequences — (Array<String>)

                    A list of strings that define sequences after which the model will stop generating.

                  • temperature — (Float)

                    Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

                  • topK — (Integer)

                    The number of most-likely candidates that the model considers for the next token during generation.

                  • topP — (Float)

                    The percentage of most-likely candidates that the model considers for the next token.

              • modelId — required — (String)

                The unique identifier of the model to run inference with.

              • templateConfiguration — required — (map)

                Contains a prompt and variables in the prompt that can be replaced with values at runtime.

                • text — (map)

                  Contains configurations for the text in a message for a prompt.

                  • inputVariables — (Array<map>)

                    An array of the variables in the prompt template.

                    • name — (String)

                      The name of the variable.

                  • text — required — (String)

                    The message for the prompt.

              • templateType — required — (String)

                The type of prompt template.

                Possible values include:
                • "TEXT"
            • resource — (map)

              Contains configurations for a prompt from Prompt management.

              • promptArn — required — (String)

                The Amazon Resource Name (ARN) of the prompt from Prompt management.

        • retrieval — (map)

          Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.

          • serviceConfiguration — required — (map)

            Contains configurations for the service to use for retrieving data to return as the output from the node.

            • s3 — (map)

              Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.

              • bucketName — required — (String)

                The name of the Amazon S3 bucket from which to retrieve data.

        • storage — (map)

          Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.

          • serviceConfiguration — required — (map)

            Contains configurations for the service to use for storing the input into the node.

            • s3 — (map)

              Contains configurations for the Amazon S3 location in which to store the input into the node.

              • bucketName — required — (String)

                The name of the Amazon S3 bucket in which to store the input into the node.

      • inputs — (Array<map>)

        An array of objects, each of which contains information about an input into the node.

        • expression — required — (String)

          An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.

        • name — required — (String)

          A name for the input that you can reference.

        • type — required — (String)

          The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.

          Possible values include:
          • "String"
          • "Number"
          • "Boolean"
          • "Object"
          • "Array"
      • name — required — (String)

        A name for the node.

      • outputs — (Array<map>)

        A list of objects, each of which contains information about an output from the node.

        • name — required — (String)

          A name for the output that you can reference.

        • type — required — (String)

          The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.

          Possible values include:
          • "String"
          • "Number"
          • "Boolean"
          • "Object"
          • "Array"
      • type — required — (String)

        The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.

        Possible values include:
        • "Input"
        • "Output"
        • "KnowledgeBase"
        • "Condition"
        • "Lex"
        • "Prompt"
        • "LambdaFunction"
        • "Storage"
        • "Agent"
        • "Retrieval"
        • "Iterator"
        • "Collector"
  • description — (String)

    A description for the flow.

  • executionRoleArn — (String)

    The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

  • name — (String)

    A name for the flow.

  • tags — (map<String>)

    Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the flow.

    • createdAt — (Date)

      The time at which the flow was created.

    • customerEncryptionKeyArn — (String)

      The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.

    • definition — (map)

      A definition of the nodes and connections between nodes in the flow.

      • connections — (Array<map>)

        An array of connection definitions in the flow.

        • configuration — (map)

          The configuration of the connection.

          • conditional — (map)

            The configuration of a connection originating from a Condition node.

            • condition — required — (String)

              The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the Node types topic in the Amazon Bedrock User Guide.

          • data — (map)

            The configuration of a connection originating from a node that isn't a Condition node.

            • sourceOutput — required — (String)

              The name of the output in the source node that the connection begins from.

            • targetInput — required — (String)

              The name of the input in the target node that the connection ends at.

        • name — required — (String)

          A name for the connection that you can reference.

        • source — required — (String)

          The node that the connection starts at.

        • target — required — (String)

          The node that the connection ends at.

        • type — required — (String)

          Whether the source node that the connection begins from is a condition node (Conditional) or not (Data).

          Possible values include:
          • "Data"
          • "Conditional"
      • nodes — (Array<map>)

        An array of node definitions in the flow.

        • configuration — (map)

          Contains configurations for the node.

          • agent — (map)

            Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.

            • agentAliasArn — required — (String)

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

          • collector — (map)

            Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.

          • condition — (map)

            Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.

            • conditions — required — (Array<map>)

              An array of conditions. Each member contains the name of a condition and an expression that defines the condition.

              • expression — (String)

                Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in Node types in prompt flows.

              • name — required — (String)

                A name for the condition that you can reference.

          • input — (map)

            Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.

          • iterator — (map)

            Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

            The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

          • knowledgeBase — (map)

            Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

            • knowledgeBaseId — required — (String)

              The unique identifier of the knowledge base to query.

            • modelId — (String)

              The unique identifier of the model to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.

          • lambdaFunction — (map)

            Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.

            • lambdaArn — required — (String)

              The Amazon Resource Name (ARN) of the Lambda function to invoke.

          • lex — (map)

            Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.

            • botAliasArn — required — (String)

              The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.

            • localeId — required — (String)

              The Region to invoke the Amazon Lex bot in.

          • output — (map)

            Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.

          • prompt — (map)

            Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.

            • sourceConfiguration — required — (map)

              Specifies whether the prompt is from Prompt management or defined inline.

              • inline — (map)

                Contains configurations for a prompt that is defined inline

                • inferenceConfiguration — (map)

                  Contains inference configurations for the prompt.

                  • text — (map)

                    Contains inference configurations for a text prompt.

                    • maxTokens — (Integer)

                      The maximum number of tokens to return in the response.

                    • stopSequences — (Array<String>)

                      A list of strings that define sequences after which the model will stop generating.

                    • temperature — (Float)

                      Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

                    • topK — (Integer)

                      The number of most-likely candidates that the model considers for the next token during generation.

                    • topP — (Float)

                      The percentage of most-likely candidates that the model considers for the next token.

                • modelId — required — (String)

                  The unique identifier of the model to run inference with.

                • templateConfiguration — required — (map)

                  Contains a prompt and variables in the prompt that can be replaced with values at runtime.

                  • text — (map)

                    Contains configurations for the text in a message for a prompt.

                    • inputVariables — (Array<map>)

                      An array of the variables in the prompt template.

                      • name — (String)

                        The name of the variable.

                    • text — required — (String)

                      The message for the prompt.

                • templateType — required — (String)

                  The type of prompt template.

                  Possible values include:
                  • "TEXT"
              • resource — (map)

                Contains configurations for a prompt from Prompt management.

                • promptArn — required — (String)

                  The Amazon Resource Name (ARN) of the prompt from Prompt management.

          • retrieval — (map)

            Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.

            • serviceConfiguration — required — (map)

              Contains configurations for the service to use for retrieving data to return as the output from the node.

              • s3 — (map)

                Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.

                • bucketName — required — (String)

                  The name of the Amazon S3 bucket from which to retrieve data.

          • storage — (map)

            Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.

            • serviceConfiguration — required — (map)

              Contains configurations for the service to use for storing the input into the node.

              • s3 — (map)

                Contains configurations for the Amazon S3 location in which to store the input into the node.

                • bucketName — required — (String)

                  The name of the Amazon S3 bucket in which to store the input into the node.

        • inputs — (Array<map>)

          An array of objects, each of which contains information about an input into the node.

          • expression — required — (String)

            An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.

          • name — required — (String)

            A name for the input that you can reference.

          • type — required — (String)

            The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.

            Possible values include:
            • "String"
            • "Number"
            • "Boolean"
            • "Object"
            • "Array"
        • name — required — (String)

          A name for the node.

        • outputs — (Array<map>)

          A list of objects, each of which contains information about an output from the node.

          • name — required — (String)

            A name for the output that you can reference.

          • type — required — (String)

            The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.

            Possible values include:
            • "String"
            • "Number"
            • "Boolean"
            • "Object"
            • "Array"
        • type — required — (String)

          The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.

          Possible values include:
          • "Input"
          • "Output"
          • "KnowledgeBase"
          • "Condition"
          • "Lex"
          • "Prompt"
          • "LambdaFunction"
          • "Storage"
          • "Agent"
          • "Retrieval"
          • "Iterator"
          • "Collector"
    • description — (String)

      The description of the flow.

    • executionRoleArn — (String)

      The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

    • id — (String)

      The unique identifier of the flow.

    • name — (String)

      The name of the flow.

    • status — (String)

      The status of the flow. When you submit this request, the status will be NotPrepared. If creation fails, the status becomes Failed.

      Possible values include:
      • "Failed"
      • "Prepared"
      • "Preparing"
      • "NotPrepared"
    • updatedAt — (Date)

      The time at which the flow was last updated.

    • version — (String)

      The version of the flow. When you create a flow, the version created is the DRAFT version.

Returns:

• (AWS.Request) —

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

var params = {
  flowIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  routingConfiguration: [ /* required */
    {
      flowVersion: 'STRING_VALUE'
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
bedrockagent.createFlowAlias(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 for the alias.

  • flowIdentifier — (String)

    The unique identifier of the flow for which to create an alias.

  • name — (String)

    A name for the alias.

  • routingConfiguration — (Array<map>)

    Contains information about the version to which to map the alias.

    • flowVersion — (String)

      The version that the alias maps to.

  • tags — (map<String>)

    Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the alias.

    • createdAt — (Date)

      The time at which the alias was created.

    • description — (String)

      The description of the alias.

    • flowId — (String)

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

    • id — (String)

      The unique identifier of the alias.

    • name — (String)

      The name of the alias.

    • routingConfiguration — (Array<map>)

      Contains information about the version that the alias is mapped to.

      • flowVersion — (String)

        The version that the alias maps to.

    • updatedAt — (Date)

      The time at which the alias of the flow was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  flowIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
bedrockagent.createFlowVersion(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 version of the flow.

  • flowIdentifier — (String)

    The unique identifier of the flow that you want to create a version of.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the flow.

    • createdAt — (Date)

      The time at which the flow was created.

    • customerEncryptionKeyArn — (String)

      The KMS key that the flow is encrypted with.

    • definition — (map)

      A definition of the nodes and connections in the flow.

      • connections — (Array<map>)

        An array of connection definitions in the flow.

        • configuration — (map)

          The configuration of the connection.

          • conditional — (map)

            The configuration of a connection originating from a Condition node.

            • condition — required — (String)

              The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the Node types topic in the Amazon Bedrock User Guide.

          • data — (map)

            The configuration of a connection originating from a node that isn't a Condition node.

            • sourceOutput — required — (String)

              The name of the output in the source node that the connection begins from.

            • targetInput — required — (String)

              The name of the input in the target node that the connection ends at.

        • name — required — (String)

          A name for the connection that you can reference.

        • source — required — (String)

          The node that the connection starts at.

        • target — required — (String)

          The node that the connection ends at.

        • type — required — (String)

          Whether the source node that the connection begins from is a condition node (Conditional) or not (Data).

          Possible values include:
          • "Data"
          • "Conditional"
      • nodes — (Array<map>)

        An array of node definitions in the flow.

        • configuration — (map)

          Contains configurations for the node.

          • agent — (map)

            Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.

            • agentAliasArn — required — (String)

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

          • collector — (map)

            Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.

          • condition — (map)

            Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.

            • conditions — required — (Array<map>)

              An array of conditions. Each member contains the name of a condition and an expression that defines the condition.

              • expression — (String)

                Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in Node types in prompt flows.

              • name — required — (String)

                A name for the condition that you can reference.

          • input — (map)

            Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.

          • iterator — (map)

            Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

            The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

          • knowledgeBase — (map)

            Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

            • knowledgeBaseId — required — (String)

              The unique identifier of the knowledge base to query.

            • modelId — (String)

              The unique identifier of the model to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.

          • lambdaFunction — (map)

            Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.

            • lambdaArn — required — (String)

              The Amazon Resource Name (ARN) of the Lambda function to invoke.

          • lex — (map)

            Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.

            • botAliasArn — required — (String)

              The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.

            • localeId — required — (String)

              The Region to invoke the Amazon Lex bot in.

          • output — (map)

            Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.

          • prompt — (map)

            Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.

            • sourceConfiguration — required — (map)

              Specifies whether the prompt is from Prompt management or defined inline.

              • inline — (map)

                Contains configurations for a prompt that is defined inline

                • inferenceConfiguration — (map)

                  Contains inference configurations for the prompt.

                  • text — (map)

                    Contains inference configurations for a text prompt.

                    • maxTokens — (Integer)

                      The maximum number of tokens to return in the response.

                    • stopSequences — (Array<String>)

                      A list of strings that define sequences after which the model will stop generating.

                    • temperature — (Float)

                      Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

                    • topK — (Integer)

                      The number of most-likely candidates that the model considers for the next token during generation.

                    • topP — (Float)

                      The percentage of most-likely candidates that the model considers for the next token.

                • modelId — required — (String)

                  The unique identifier of the model to run inference with.

                • templateConfiguration — required — (map)

                  Contains a prompt and variables in the prompt that can be replaced with values at runtime.

                  • text — (map)

                    Contains configurations for the text in a message for a prompt.

                    • inputVariables — (Array<map>)

                      An array of the variables in the prompt template.

                      • name — (String)

                        The name of the variable.

                    • text — required — (String)

                      The message for the prompt.

                • templateType — required — (String)

                  The type of prompt template.

                  Possible values include:
                  • "TEXT"
              • resource — (map)

                Contains configurations for a prompt from Prompt management.

                • promptArn — required — (String)

                  The Amazon Resource Name (ARN) of the prompt from Prompt management.

          • retrieval — (map)

            Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.

            • serviceConfiguration — required — (map)

              Contains configurations for the service to use for retrieving data to return as the output from the node.

              • s3 — (map)

                Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.

                • bucketName — required — (String)

                  The name of the Amazon S3 bucket from which to retrieve data.

          • storage — (map)

            Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.

            • serviceConfiguration — required — (map)

              Contains configurations for the service to use for storing the input into the node.

              • s3 — (map)

                Contains configurations for the Amazon S3 location in which to store the input into the node.

                • bucketName — required — (String)

                  The name of the Amazon S3 bucket in which to store the input into the node.

        • inputs — (Array<map>)

          An array of objects, each of which contains information about an input into the node.

          • expression — required — (String)

            An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.

          • name — required — (String)

            A name for the input that you can reference.

          • type — required — (String)

            The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.

            Possible values include:
            • "String"
            • "Number"
            • "Boolean"
            • "Object"
            • "Array"
        • name — required — (String)

          A name for the node.

        • outputs — (Array<map>)

          A list of objects, each of which contains information about an output from the node.

          • name — required — (String)

            A name for the output that you can reference.

          • type — required — (String)

            The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.

            Possible values include:
            • "String"
            • "Number"
            • "Boolean"
            • "Object"
            • "Array"
        • type — required — (String)

          The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.

          Possible values include:
          • "Input"
          • "Output"
          • "KnowledgeBase"
          • "Condition"
          • "Lex"
          • "Prompt"
          • "LambdaFunction"
          • "Storage"
          • "Agent"
          • "Retrieval"
          • "Iterator"
          • "Collector"
    • description — (String)

      The description of the version.

    • executionRoleArn — (String)

      The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

    • id — (String)

      The unique identifier of the flow.

    • name — (String)

      The name of the version.

    • status — (String)

      The status of the flow.

      Possible values include:
      • "Failed"
      • "Prepared"
      • "Preparing"
      • "NotPrepared"
    • version — (String)

      The version of the flow that was created. Versions are numbered incrementally, starting from 1.

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 */
      embeddingModelConfiguration: {
        bedrockEmbeddingModelConfiguration: {
          dimensions: 'NUMBER_VALUE'
        }
      }
    }
  },
  name: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  storageConfiguration: { /* required */
    type: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS | MONGO_DB_ATLAS, /* required */
    mongoDbAtlasConfiguration: {
      collectionName: 'STRING_VALUE', /* required */
      credentialsSecretArn: 'STRING_VALUE', /* required */
      databaseName: '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 */
      endpointServiceName: 'STRING_VALUE'
    },
    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.

      • embeddingModelConfiguration — (map)

        The embeddings model configuration details for the vector model used in Knowledge Base.

        • bedrockEmbeddingModelConfiguration — (map)

          The vector configuration details on the Bedrock embeddings model.

          • dimensions — (Integer)

            The dimensions details for the vector configuration used on the Bedrock embeddings model.

  • 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.

    • mongoDbAtlasConfiguration — (map)

      Contains the storage configuration of the knowledge base in MongoDB Atlas.

      • collectionName — required — (String)

        The collection name of the knowledge base in MongoDB Atlas.

      • credentialsSecretArn — required — (String)

        The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.

      • databaseName — required — (String)

        The database name in your MongoDB Atlas cluster for your knowledge base.

      • endpoint — required — (String)

        The endpoint URL of your MongoDB Atlas cluster for your knowledge base.

      • endpointServiceName — (String)

        The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.

      • 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 MongoDB Atlas vector search index.

    • 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"
      • "MONGO_DB_ATLAS"
  • 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.

          • embeddingModelConfiguration — (map)

            The embeddings model configuration details for the vector model used in Knowledge Base.

            • bedrockEmbeddingModelConfiguration — (map)

              The vector configuration details on the Bedrock embeddings model.

              • dimensions — (Integer)

                The dimensions details for the vector configuration used on the Bedrock embeddings model.

      • 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.

        • mongoDbAtlasConfiguration — (map)

          Contains the storage configuration of the knowledge base in MongoDB Atlas.

          • collectionName — required — (String)

            The collection name of the knowledge base in MongoDB Atlas.

          • credentialsSecretArn — required — (String)

            The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.

          • databaseName — required — (String)

            The database name in your MongoDB Atlas cluster for your knowledge base.

          • endpoint — required — (String)

            The endpoint URL of your MongoDB Atlas cluster for your knowledge base.

          • endpointServiceName — (String)

            The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.

          • 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 MongoDB Atlas vector search index.

        • 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"
          • "MONGO_DB_ATLAS"
      • 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 = {
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  customerEncryptionKeyArn: 'STRING_VALUE',
  defaultVariant: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  variants: [
    {
      name: 'STRING_VALUE', /* required */
      templateType: TEXT, /* required */
      inferenceConfiguration: {
        text: {
          maxTokens: 'NUMBER_VALUE',
          stopSequences: [
            'STRING_VALUE',
            /* more items */
          ],
          temperature: 'NUMBER_VALUE',
          topK: 'NUMBER_VALUE',
          topP: 'NUMBER_VALUE'
        }
      },
      metadata: [
        {
          key: 'STRING_VALUE', /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      modelId: 'STRING_VALUE',
      templateConfiguration: {
        text: {
          text: 'STRING_VALUE', /* required */
          inputVariables: [
            {
              name: 'STRING_VALUE'
            },
            /* more items */
          ]
        }
      }
    },
    /* more items */
  ]
};
bedrockagent.createPrompt(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.
  • customerEncryptionKeyArn — (String)

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

  • defaultVariant — (String)

    The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

  • description — (String)

    A description for the prompt.

  • name — (String)

    A name for the prompt.

  • tags — (map<String>)

    Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.

  • variants — (Array<map>)

    A list of objects, each containing details about a variant of the prompt.

    • inferenceConfiguration — (map)

      Contains inference configurations for the prompt variant.

      • text — (map)

        Contains inference configurations for a text prompt.

        • maxTokens — (Integer)

          The maximum number of tokens to return in the response.

        • stopSequences — (Array<String>)

          A list of strings that define sequences after which the model will stop generating.

        • temperature — (Float)

          Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

        • topK — (Integer)

          The number of most-likely candidates that the model considers for the next token during generation.

        • topP — (Float)

          The percentage of most-likely candidates that the model considers for the next token.

    • metadata — (Array<map>)

      An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.

      • key — required — (String)

        The key of a metadata tag for a prompt variant.

      • value — required — (String)

        The value of a metadata tag for a prompt variant.

    • modelId — (String)

      The unique identifier of the model with which to run inference on the prompt.

    • name — required — (String)

      The name of the prompt variant.

    • templateConfiguration — (map)

      Contains configurations for the prompt template.

      • text — (map)

        Contains configurations for the text in a message for a prompt.

        • inputVariables — (Array<map>)

          An array of the variables in the prompt template.

          • name — (String)

            The name of the variable.

        • text — required — (String)

          The message for the prompt.

    • templateType — required — (String)

      The type of prompt template to use.

      Possible values include:
      • "TEXT"

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the prompt.

    • createdAt — (Date)

      The time at which the prompt was created.

    • customerEncryptionKeyArn — (String)

      The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.

    • defaultVariant — (String)

      The name of the default variant for your prompt.

    • description — (String)

      The description of the prompt.

    • id — (String)

      The unique identifier of the prompt.

    • name — (String)

      The name of the prompt.

    • updatedAt — (Date)

      The time at which the prompt was last updated.

    • variants — (Array<map>)

      A list of objects, each containing details about a variant of the prompt.

      • inferenceConfiguration — (map)

        Contains inference configurations for the prompt variant.

        • text — (map)

          Contains inference configurations for a text prompt.

          • maxTokens — (Integer)

            The maximum number of tokens to return in the response.

          • stopSequences — (Array<String>)

            A list of strings that define sequences after which the model will stop generating.

          • temperature — (Float)

            Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

          • topK — (Integer)

            The number of most-likely candidates that the model considers for the next token during generation.

          • topP — (Float)

            The percentage of most-likely candidates that the model considers for the next token.

      • metadata — (Array<map>)

        An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.

        • key — required — (String)

          The key of a metadata tag for a prompt variant.

        • value — required — (String)

          The value of a metadata tag for a prompt variant.

      • modelId — (String)

        The unique identifier of the model with which to run inference on the prompt.

      • name — required — (String)

        The name of the prompt variant.

      • templateConfiguration — (map)

        Contains configurations for the prompt template.

        • text — (map)

          Contains configurations for the text in a message for a prompt.

          • inputVariables — (Array<map>)

            An array of the variables in the prompt template.

            • name — (String)

              The name of the variable.

          • text — required — (String)

            The message for the prompt.

      • templateType — required — (String)

        The type of prompt template to use.

        Possible values include:
        • "TEXT"
    • version — (String)

      The version of the prompt. When you create a prompt, the version created is the DRAFT version.

Returns:

• (AWS.Request) —

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

var params = {
  promptIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
bedrockagent.createPromptVersion(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 for the version of the prompt.

  • promptIdentifier — (String)

    The unique identifier of the prompt that you want to create a version of.

  • tags — (map<String>)

    Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the version of the prompt.

    • createdAt — (Date)

      The time at which the prompt was created.

    • customerEncryptionKeyArn — (String)

      The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.

    • defaultVariant — (String)

      The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

    • description — (String)

      A description for the version.

    • id — (String)

      The unique identifier of the prompt.

    • name — (String)

      The name of the prompt.

    • updatedAt — (Date)

      The time at which the prompt was last updated.

    • variants — (Array<map>)

      A list of objects, each containing details about a variant of the prompt.

      • inferenceConfiguration — (map)

        Contains inference configurations for the prompt variant.

        • text — (map)

          Contains inference configurations for a text prompt.

          • maxTokens — (Integer)

            The maximum number of tokens to return in the response.

          • stopSequences — (Array<String>)

            A list of strings that define sequences after which the model will stop generating.

          • temperature — (Float)

            Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

          • topK — (Integer)

            The number of most-likely candidates that the model considers for the next token during generation.

          • topP — (Float)

            The percentage of most-likely candidates that the model considers for the next token.

      • metadata — (Array<map>)

        An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.

        • key — required — (String)

          The key of a metadata tag for a prompt variant.

        • value — required — (String)

          The value of a metadata tag for a prompt variant.

      • modelId — (String)

        The unique identifier of the model with which to run inference on the prompt.

      • name — required — (String)

        The name of the prompt variant.

      • templateConfiguration — (map)

        Contains configurations for the prompt template.

        • text — (map)

          Contains configurations for the text in a message for a prompt.

          • inputVariables — (Array<map>)

            An array of the variables in the prompt template.

            • name — (String)

              The name of the variable.

          • text — required — (String)

            The message for the prompt.

      • templateType — required — (String)

        The type of prompt template to use.

        Possible values include:
        • "TEXT"
    • version — (String)

      The version of the prompt that was created. Versions are numbered incrementally, starting from 1.

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 = {
  flowIdentifier: 'STRING_VALUE', /* required */
  skipResourceInUseCheck: true || false
};
bedrockagent.deleteFlow(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: {}) —
  • flowIdentifier — (String)

    The unique identifier of the flow.

  • 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:

    • id — (String)

      The unique identifier of the flow.

Returns:

• (AWS.Request) —

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

var params = {
  aliasIdentifier: 'STRING_VALUE', /* required */
  flowIdentifier: 'STRING_VALUE' /* required */
};
bedrockagent.deleteFlowAlias(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: {}) —
  • aliasIdentifier — (String)

    The unique identifier of the alias to be deleted.

  • flowIdentifier — (String)

    The unique identifier of the flow 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:

    • flowId — (String)

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

    • id — (String)

      The unique identifier of the flow.

Returns:

• (AWS.Request) —

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

var params = {
  flowIdentifier: 'STRING_VALUE', /* required */
  flowVersion: 'STRING_VALUE', /* required */
  skipResourceInUseCheck: true || false
};
bedrockagent.deleteFlowVersion(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: {}) —
  • flowIdentifier — (String)

    The unique identifier of the flow whose version that you want to delete

  • flowVersion — (String)

    The version of the flow that you want 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:

    • id — (String)

      The unique identifier of the flow.

    • version — (String)

      The version of the flow being deleted.

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 = {
  promptIdentifier: 'STRING_VALUE', /* required */
  promptVersion: 'STRING_VALUE'
};
bedrockagent.deletePrompt(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: {}) —
  • promptIdentifier — (String)

    The unique identifier of the prompt.

  • promptVersion — (String)

    The version of the prompt to delete. To delete the prompt, omit this field.

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:

    • id — (String)

      The unique identifier of the prompt that was deleted.

    • version — (String)

      The version of the prompt that was deleted.

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.

      • guardrailConfiguration — (map)

        Details about the guardrail associated with the agent.

        • guardrailIdentifier — (String)

          The unique identifier of the guardrail.

        • guardrailVersion — (String)

          The version of the guardrail.

      • 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.

      • memoryConfiguration — (map)

        Contains memory configuration for the agent.

        • enabledMemoryTypes — required — (Array<String>)

          The type of memory that is stored.

        • storageDays — (Integer)

          The number of days the agent is configured to retain the conversational context.

      • 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. For more information, see Parser Lambda function in Agents for Amazon Bedrock.

        • 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. For more information, see Configure the prompt templates.

          • 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.