DeleteProfileCommand

Suggest an Edit

Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.

Example Syntax

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

import { B2biClient, DeleteProfileCommand } from "@aws-sdk/client-b2bi"; // ES Modules import
// const { B2biClient, DeleteProfileCommand } = require("@aws-sdk/client-b2bi"); // CommonJS import
const client = new B2biClient(config);
const input = { // DeleteProfileRequest
  profileId: "STRING_VALUE", // required
};
const command = new DeleteProfileCommand(input);
const response = await client.send(command);
// {};

Example Usage

 Loading code editor

DeleteProfileCommand Input

See DeleteProfileCommandInput for more details

Parameter
Type
Description
profileId
Required
string | undefined

Specifies the unique, system-generated identifier for the profile.

DeleteProfileCommand Output

See DeleteProfileCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.

InternalServerException
server

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

ResourceNotFoundException
client

Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.

ThrottlingException
client

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

ValidationException
client

Occurs when a B2BI object cannot be validated against a request from another object.

B2biServiceException
Base exception class for all service exceptions from B2bi service.