选择您的 Cookie 首选项

我们使用必要 Cookie 和类似工具提供我们的网站和服务。我们使用性能 Cookie 收集匿名统计数据,以便我们可以了解客户如何使用我们的网站并进行改进。必要 Cookie 无法停用,但您可以单击“自定义”或“拒绝”来拒绝性能 Cookie。

如果您同意,AWS 和经批准的第三方还将使用 Cookie 提供有用的网站功能、记住您的首选项并显示相关内容,包括相关广告。要接受或拒绝所有非必要 Cookie,请单击“接受”或“拒绝”。要做出更详细的选择,请单击“自定义”。

GetProfile - AWS B2B Data Interchange
此页面尚未翻译为您的语言。 请求翻译

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" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

隐私网站条款Cookie 首选项
© 2025, Amazon Web Services, Inc. 或其附属公司。保留所有权利。