ListCustomerAccountBulkJobResults
Use ListCustomerAccountBulkJobResults to list the outcome of each record in a bulk job. You can filter the results to records that succeeded or failed. A job that failed before it processed any records returns an empty list.
Results are paginated. Use NextToken to retrieve additional results.
Request Syntax
{
"Catalog": "string",
"Identifier": "string",
"MaxResults": number,
"NextToken": "string",
"Status": "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 bulk job.
Type: String
Pattern:
(arn:.*|bulkjob-[0-9a-z]{13})Required: Yes
- MaxResults
-
Specifies the maximum number of results to return in a single call. Use this value together with
NextTokento control pagination.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
Specifies the token for the next page of results. Use the
NextTokenvalue from a previous response to retrieve the next page.Type: String
Required: No
- Status
-
Filters the results to records with the specified outcome. If you omit this field, records with all outcomes are returned.
Type: String
Valid Values:
SUCCEEDED | FAILEDRequired: No
Response Syntax
{
"NextToken": "string",
"Results": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"RequestId": "string",
"ResourceIdentifier": "string",
"Status": "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.
- Results
-
The outcome of each record in the bulk job.
Type: Array of BulkJobResult objects
- NextToken
-
The token to retrieve the next page of results. This value is absent when there are no more results.
Type: String
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: