- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetProfileCommand
Retrieves the details for the profile specified by the profile ID. 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, GetProfileCommand } from "@aws-sdk/client-b2bi"; // ES Modules import
// const { B2biClient, GetProfileCommand } = require("@aws-sdk/client-b2bi"); // CommonJS import
const client = new B2biClient(config);
const input = { // GetProfileRequest
profileId: "STRING_VALUE", // required
};
const command = new GetProfileCommand(input);
const response = await client.send(command);
// { // GetProfileResponse
// profileId: "STRING_VALUE", // required
// profileArn: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// email: "STRING_VALUE",
// phone: "STRING_VALUE", // required
// businessName: "STRING_VALUE", // required
// logging: "ENABLED" || "DISABLED",
// logGroupName: "STRING_VALUE",
// createdAt: new Date("TIMESTAMP"), // required
// modifiedAt: new Date("TIMESTAMP"),
// };
Example Usage
GetProfileCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
profileId Required | string | undefined | Specifies the unique, system-generated identifier for the profile. |
GetProfileCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
businessName Required | string | undefined | Returns the name for the business associated with this profile. |
createdAt Required | Date | undefined | Returns a timestamp for creation date and time of the transformer. |
name Required | string | undefined | Returns the name of the profile, used to identify it. |
phone Required | string | undefined | Returns the phone number associated with the profile. |
profileArn Required | string | undefined | Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer. |
profileId Required | string | undefined | Returns the unique, system-generated identifier for the profile. |
email | string | undefined | Returns the email address associated with this customer profile. |
logGroupName | string | undefined | Returns the name of the logging group. |
logging | Logging | undefined | Returns whether or not logging is enabled for this profile. |
modifiedAt | Date | undefined | Returns a timestamp for last time the profile was modified. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
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. |