View a markdown version of this page

GetCustomerAccountBulkJob - AWS Partner Central

GetCustomerAccountBulkJob

Use GetCustomerAccountBulkJob to retrieve the status and record counts of a bulk job.

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.

Note

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

Response Syntax

{ "Arn": "string", "CompletedAt": "string", "CreatedAt": "string", "DeletedCount": number, "FailureCount": number, "FailureReason": "string", "FileName": "string", "Id": "string", "ProcessedRecords": number, "Status": "string", "SuccessCount": number, "TotalRecords": number }

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.

Arn

The Amazon Resource Name (ARN) of the bulk job.

Type: String

Pattern: arn:[a-z\-]*:partnercentral:[a-z0-9\-]*:[0-9]{12}:catalog/[a-zA-Z]+/customer-account-bulk-job/bulkjob-[0-9a-z]{13}

CreatedAt

The date and time when the bulk job was created.

Type: Timestamp

DeletedCount

The number of accounts imported by this job that have since been deleted. This counter only increases, so the accounts still present equal SuccessCount minus DeletedCount.

Type: Integer

FailureCount

The number of records that failed.

Type: Integer

Id

The unique identifier of the bulk job.

Type: String

Pattern: bulkjob-[0-9a-z]{13}

ProcessedRecords

The number of records that the job has finished processing.

Type: Integer

Status

The current status of the bulk job.

Type: String

Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED

SuccessCount

The number of records that the job processed successfully.

Type: Integer

TotalRecords

The total number of records in the file. The value is 0 until the job reads the file.

Type: Integer

CompletedAt

The date and time when the job finished. Absent while the job is running.

Type: Timestamp

FailureReason

The reason that the job failed. Present only when the job status is FAILED.

Type: String

FileName

The name of the file that the job processes.

Type: String

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

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: