Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetInvoicePDF

Returns a URL to download the invoice document and supplemental documents associated with an invoice. The URLs are pre-signed and have expiration time. For special cases like Brazil, where AWS generated invoice identifiers and government provided identifiers do not match, use the AWS generated invoice identifier when making API requests. To grant IAM permission to use this operation, the caller needs the invoicing:GetInvoicePDF policy action.

Request Syntax


{
   "InvoiceId": "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.

InvoiceId

Your unique invoice ID.

Type: String

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

Pattern: .*

Required: Yes

Response Syntax


{
   "InvoicePDF": { 
      "DocumentUrl": "string",
      "DocumentUrlExpirationDate": number,
      "InvoiceId": "string",
      "SupplementalDocuments": [ 
         { 
            "DocumentUrl": "string",
            "DocumentUrlExpirationDate": 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.

InvoicePDF

The invoice document and supplemental documents associated with the invoice.

Type: InvoicePDF object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action.

resourceName: You don't have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The processing request failed because of an unknown error, exception, or failure.

retryAfterSeconds: The processing request failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

resourceName: The resource could not be found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The input fails to satisfy the constraints specified by an AWS service.
reason: You don't have sufficient access to perform this action.
resourceName: You don't have sufficient access to perform this action.

HTTP Status Code: 400