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

CreateProfile

Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.

Request Syntax


{
   "businessName": "string",
   "clientToken": "string",
   "email": "string",
   "logging": "string",
   "name": "string",
   "phone": "string",
   "tags": [ 
      { 
         "Key": "string",
         "Value": "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.

businessName

Specifies the name for the business associated with this profile.

Type: String

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

Required: Yes

clientToken

Reserved for future use.

Type: String

Required: No

email

Specifies the email address associated with this customer profile.

Type: String

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

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

Required: No

logging

Specifies whether or not logging is enabled for this profile.

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes

name

Specifies the name of the profile.

Type: String

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

Required: Yes

phone

Specifies 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+))?

Required: Yes

tags

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


{
   "businessName": "string",
   "createdAt": "string",
   "email": "string",
   "logging": "string",
   "logGroupName": "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 representing the time the profile was created.

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 turned on 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.

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 the profile.

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

ConflictException

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.

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

ServiceQuotaExceededException

Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.

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 creates a profile.

Sample Request


{
    "capabilities": [
        "ca-1111aaaa2222bbbb3"
    ],
    "clientToken": "foo",
    "email": "john@example.com",
    "name": "b2bipartner",
    "phone": "5555555555",
    "profileId": "p-ABCDE111122223333",
    "tags": [
        {
            "Key": "sampleKey1",
            "Value": "sampleValue1"
        }
    ]
}

Sample Response


{
    "capabilities": [
        "ca-1111aaaa2222bbbb3"
    ],
    "createdAt": "2023-11-01T21:51:05.504Z",
    "email": "john@example.com",
    "name": "b2bipartner",
    "partnershipArn": "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-5555zzzz4444yyyyy",
    "partnershipId": "ps-5555zzzz4444yyyyy",
    "phone": "5555555555",
    "profileId": "p-ABCDE111122223333",
    "tradingPartnerId": "tp-11112222333344445"
}