We are excited to announce our new API Documentation.
Protected
Deletes the standard customer profile and all data pertaining to the profile.
Use a bare-bones client and the command you need to make an API call.
import { CustomerProfilesClient, DeleteProfileCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import// const { CustomerProfilesClient, DeleteProfileCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS importconst client = new CustomerProfilesClient(config);const input = { // DeleteProfileRequest ProfileId: "STRING_VALUE", // required DomainName: "STRING_VALUE", // required};const command = new DeleteProfileCommand(input);const response = await client.send(command);// { // DeleteProfileResponse// Message: "STRING_VALUE",// };
DeleteProfileCommandInput
DeleteProfileCommandOutput
input
response
config
AccessDeniedException (client fault)
You do not have sufficient access to perform this action.
BadRequestException (client fault)
The input you provided is invalid.
InternalServerException (server fault)
An internal service error occurred.
ResourceNotFoundException (client fault)
The requested resource does not exist, or access was denied.
ThrottlingException (client fault)
You exceeded the maximum number of requests.
CustomerProfilesServiceException
Base exception class for all service exceptions from CustomerProfiles service.
Readonly
Static
Deletes the standard customer profile and all data pertaining to the profile.
Example
Use a bare-bones client and the command you need to make an API call.
Param
DeleteProfileCommandInput
Returns
DeleteProfileCommandOutput
See
input
shape.response
shape.config
shape.Throws
AccessDeniedException (client fault)
You do not have sufficient access to perform this action.
Throws
BadRequestException (client fault)
The input you provided is invalid.
Throws
InternalServerException (server fault)
An internal service error occurred.
Throws
ResourceNotFoundException (client fault)
The requested resource does not exist, or access was denied.
Throws
ThrottlingException (client fault)
You exceeded the maximum number of requests.
Throws
CustomerProfilesServiceException
Base exception class for all service exceptions from CustomerProfiles service.