ListFulfillmentOptions
Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.
Request Syntax
POST /2026-02-05/listFulfillmentOptions HTTP/1.1
Content-type: application/json
{
"locale": "string",
"maxResults": number,
"nextToken": "string",
"productId": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- productId
-
The unique identifier of the product for which to list fulfillment options.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\w\-]+Required: Yes
- locale
-
A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See
Localefor supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^;,]+(\s*,\s*[^;,]+){0,1}Required: No
- maxResults
-
The maximum number of results that are returned per call. You can use
nextTokento get more results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- nextToken
-
If
nextTokenis returned, there are more results available. Make the call again using the returned token to retrieve the next page.Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
[a-zA-Z0-9+/=]+Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"fulfillmentOptions": [
{ ... }
],
"locale": "string",
"nextToken": "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.
- fulfillmentOptions
-
The fulfillment options available for the product. Each option describes how the buyer can deploy or access the product.
Type: Array of FulfillmentOption objects
- locale
-
A BCP 47 language tag or comma-separated priority list of language tags that specifies the preferred locale for response content. The field accepts a maximum of two language tags.
The service resolves a locale string to the nearest supported locale. If no supported locale matches, the service applies the fallback behavior described below.
-
Preferred locale (first tag) – The locale you want the service to return content in.
-
Fallback locale (optional, second tag) – The service default locale (
en-USoren). The service returns content in this locale when translated content for the preferred locale is unavailable.
The field is optional. If omitted or null, the service returns content in the default locale (
en-US).Supported locales:
-
en-US– English (service default, also resolves fromen) -
fr– French -
es– Spanish -
ko– Korean -
ja– Japanese
Fallback behavior:
-
If translated content for the preferred locale is unavailable, the service returns content in the default locale.
-
If the preferred locale is not supported and no fallback is provided, the service returns a
ValidationException. -
If you provide an unsupported locale with the default locale as fallback (for example,
xx, en-US), the service returns content in the default locale.
Response locale field (Get APIs): The
localefield in Get API responses indicates the locale of the returned content. You can use this field to determine whether the response contains content in the requested locale or the default locale.Examples:
-
fr– Request French content. If unavailable, falls back toen-US. -
fr, en-US– Request French content with explicit fallback to English. -
en-US– Request content in the default locale.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^;,]+(\s*,\s*[^;,]+){0,1} -
- nextToken
-
If
nextTokenis returned, there are more results available. Make the call again using the returned token to retrieve the next page.Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
[a-zA-Z0-9+/=]+
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
You don't have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
Unexpected error during processing of the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource doesn't exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by the service.
- reason
-
The reason that the input fails to satisfy the constraints specified by the service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: