GetCustomerAccount
Use GetCustomerAccount to retrieve the details of a customer account, including the customer information that you provided, the enrichment status, and the enrichment information that AWS provides when the status is ENRICHED.
Request Syntax
{
"Catalog": "string",
"Identifier": "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.
In the following list, the required parameters are described first.
- Catalog
-
Specifies the catalog for the request. Valid values:
-
AWS: Production. -
Sandbox: Testing environments.
Type: String
Pattern:
[a-zA-Z]+Required: Yes
-
- Identifier
-
Specifies the ARN or the identifier of the customer account.
Type: String
Pattern:
(arn:.*|cust-acc-[0-9a-z]{13})Required: Yes
Response Syntax
{
"Account": {
"Address": {
"City": "string",
"CountryCode": "string",
"PostalCode": "string",
"StateOrRegion": "string",
"StreetAddress": "string"
},
"CompanyName": "string",
"Domain": "string",
"Duns": "string",
"Industry": "string",
"OtherIndustry": "string",
"ParentCompanyName": "string",
"WebsiteUrl": "string"
},
"Arn": "string",
"AwsEnrichment": {
"Customer": {
"AccountName": "string",
"CompanySize": "string",
"Country": "string",
"CustomerAccountPlanningQualification": "string",
"EligiblePrograms": [ "string" ],
"Geo": "string",
"Industry": "string",
"Region": "string",
"Sector": "string",
"Segment": "string",
"SubIndustry": "string",
"SubRegion": "string"
},
"Insights": {
"MarketplaceEngagementScore": "string",
"SolutionCategory": "string",
"SolutionScore": "string",
"SolutionSubCategory": "string"
}
},
"Catalog": "string",
"CreatedDate": "string",
"EnrichmentStatus": "string",
"ExistingCustomerAccountArn": "string",
"Id": "string",
"Issues": [
{
"Code": "string",
"Message": "string",
"Severity": "string"
}
],
"LastModifiedDate": "string",
"Message": "string",
"PartnerAccountIdentifier": "string",
"ReasonCode": "string",
"Tags": [
{
"Key": "string",
"Value": "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.
- Account
-
The details of the customer that you provided.
Type: CustomerAccountData object
- Arn
-
The Amazon Resource Name (ARN) of the customer account.
Type: String
Pattern:
arn:[a-z\-]*:partnercentral:[a-z0-9\-]*:[0-9]{12}:catalog/[a-zA-Z]+/customer-account/cust-acc-[0-9a-z]{13} - Catalog
-
The catalog that the customer account belongs to.
Type: String
Pattern:
[a-zA-Z]+ - CreatedDate
-
The date and time when the customer account was created.
Type: Timestamp
- EnrichmentStatus
-
The enrichment status of the customer account.
Type: String
Valid Values:
PENDING | ENRICHED | NO_MATCH_FOUND | ACTION_REQUIRED - Id
-
The unique identifier of the customer account.
Type: String
Pattern:
cust-acc-[0-9a-z]{13} - LastModifiedDate
-
The date and time when the customer account was last modified.
Type: Timestamp
- AwsEnrichment
-
Enrichment information that AWS provides about the customer. Present only when
EnrichmentStatusisENRICHED.Type: AwsEnrichment object
- ExistingCustomerAccountArn
-
The ARN of the customer account that already maps this customer. Present only when
ReasonCodeisDUPLICATE_CUSTOMER_MATCH.Type: String
Pattern:
arn:[a-z\-]*:partnercentral:[a-z0-9\-]*:[0-9]{12}:catalog/[a-zA-Z]+/customer-account/cust-acc-[0-9a-z]{13} - Issues
-
The issues found with the customer account. Present only when there is at least one issue.
Type: Array of Issue objects
- Message
-
A description of the problem and the steps that you can take to resolve it.
Type: String
- PartnerAccountIdentifier
-
Your own identifier for the customer account, if you provided one.
Type: String
Pattern:
(?s).{0,64} - ReasonCode
-
The reason that the customer account needs your action. Present only when
EnrichmentStatusisACTION_REQUIRED.Type: String
Valid Values:
DUPLICATE_CUSTOMER_MATCH | PROCESSING_ERROR - Tags
-
The tags on the customer account. This member is absent if the tags can't be retrieved, which is different from an account that has no tags.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 200 items.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
This error occurs when you don't have permission to perform the requested action.
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.
- Message
-
A message that describes why access was denied.
- Reason
-
The reason why access was denied for the requested operation.
HTTP Status Code: 400
- InternalServerException
-
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.
- Message
-
A message that describes the internal error.
HTTP Status Code: 500
- ResourceNotFoundException
-
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.
- Message
-
A message that describes which resource the service couldn't find.
HTTP Status Code: 400
- ThrottlingException
-
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.
This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.
- Message
-
A message that describes why the service throttled the request.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by the service or business validation rules.
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.
- ErrorList
-
A list of issues that were discovered in the submitted request or the resource state.
- Message
-
A message that describes the validation error.
- Reason
-
The primary reason for this validation exception to occur.
-
REQUEST_VALIDATION_FAILED: The request format is not valid.
Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
-
BUSINESS_VALIDATION_FAILED: The requested change doesn't pass the business validation rules.
Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: