View a markdown version of this page

GetOpportunityBulkJobReportUrl - AWS Partner Central

GetOpportunityBulkJobReportUrl

Gets the status of the failed-records report for a finished opportunity bulk job and, when the report is ready, a temporary URL to download it.

A report is available only after the job is COMPLETED or FAILED. The URL expires after 15 minutes, and the report expires after about 7 days.

Request Syntax

{ "Catalog": "string", "JobId": "string", "ReportFormat": "string", "ReportType": "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

JobId

Specifies the identifier of the bulk job.

Type: String

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

Required: Yes

ReportFormat

Specifies the format of the report. The only supported value is CSV.

Type: String

Valid Values: CSV

Required: Yes

ReportType

Specifies which records the report covers. If you omit this field, the report covers the records that failed. ALL_RECORDS isn't supported yet, and a request for it fails with a ValidationException.

Type: String

Valid Values: FAILED_RECORDS | ALL_RECORDS

Required: No

Response Syntax

{ "ExpiresAt": "string", "FailureReason": "string", "ReportFormat": "string", "ReportStatus": "string", "ReportType": "string", "Url": "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.

ReportFormat

The format of the report.

Type: String

Valid Values: CSV

ReportStatus

The status of the report. The Url is returned only when the status is AVAILABLE.

Type: String

Valid Values: NOT_STARTED | IN_PROGRESS | AVAILABLE | FAILED | EXPIRED

ReportType

The records that the report covers.

Type: String

Valid Values: FAILED_RECORDS | ALL_RECORDS

ExpiresAt

The date and time, in UTC, when the URL expires. Present only when ReportStatus is AVAILABLE.

Type: Timestamp

FailureReason

The reason that Partner Central couldn't generate the report. Present only when ReportStatus is FAILED.

Type: String

Url

A temporary URL for downloading the report. Present only when ReportStatus is AVAILABLE.

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

ConflictException

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

Message

A message that describes the conflict.

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: