Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetProfile

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.

Request Syntax


{
   "profileId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

profileId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

Response Syntax


{
   "businessName": "string",
   "createdAt": "string",
   "email": "string",
   "logging": "string",
   "logGroupName": "string",
   "modifiedAt": "string",
   "name": "string",
   "phone": "string",
   "profileArn": "string",
   "profileId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

businessName

Returns the name for the business associated with this profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 254.

createdAt

Returns a timestamp for creation date and time of the transformer.

Type: Timestamp

email

Returns the email address associated with this customer profile.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 254.

Pattern: [\w\.\-]+@[\w\.\-]+

logging

Returns whether or not logging is enabled for this profile.

Type: String

Valid Values: ENABLED | DISABLED

logGroupName

Returns the name of the logging group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

modifiedAt

Returns a timestamp for last time the profile was modified.

Type: Timestamp

name

Returns the name of the profile, used to identify it.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 254.

phone

Returns the phone number associated with the profile.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 22.

Pattern: \+?([0-9 \t\-()\/]{7,})(?:\s*(?:#|x\.?|ext\.?|extension) \t*(\d+))?

profileArn

Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

profileId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

This exception is thrown when an error occurs in the AWS B2B Data Interchange service.

HTTP Status Code: 500

ResourceNotFoundException

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.

HTTP Status Code: 400

ThrottlingException

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

HTTP Status Code: 400

ValidationException

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

HTTP Status Code: 400

Examples

Example

The following example retrieves details for the specified profile.

Sample Request


{
    "profileId": "p-ABCDE111122223333"
}

Sample Response


{
    "businessName": "John's Trucking",
    "createdAt": "2023-11-01T21:51:05.504Z",
    "email": "john@example.com",
    "logging": "ENABLED",
    "logGroupName": "b2bi/p-ABCDE111122223333-Logs",
    "name": "Shipping Profile",
    "phone": "5555555555",
    "profileArn": "arn:aws:b2bi:us-west-2:123456789012:profile/p-ABCDE111122223333",
    "profileId": "p-ABCDE111122223333"
}