Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SearchProfilesCommand

Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key is a data type pair that consists of a KeyName and Values list.

This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either AND or OR logic.

example

Use a bare-bones client and the command you need to make an API call.

import { CustomerProfilesClient, SearchProfilesCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
// const { CustomerProfilesClient, SearchProfilesCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
const client = new CustomerProfilesClient(config);
const command = new SearchProfilesCommand(input);
const response = await client.send(command);
see

SearchProfilesCommandInput for command's input shape.

see

SearchProfilesCommandOutput for command's response shape.

see

config for CustomerProfilesClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: SearchProfilesCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<SearchProfilesCommandInput, SearchProfilesCommandOutput>

Methods

Static getEndpointParameterInstructions