ListFoundationModelAgreementOffers
Get the offers associated with the specified model.
Request Syntax
GET /list-foundation-model-agreement-offers/modelId
?offerType=offerType
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- modelId
-
Model Id of the foundation model.
Length Constraints: Minimum length of 0. Maximum length of 140.
Pattern:
[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)
Required: Yes
- offerType
-
Type of offer associated with the model.
Valid Values:
ALL | PUBLIC
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"modelId": "string",
"offers": [
{
"offerId": "string",
"offerToken": "string",
"termDetails": {
"legalTerm": {
"url": "string"
},
"supportTerm": {
"refundPolicyDescription": "string"
},
"usageBasedPricingTerm": {
"rateCard": [
{
"description": "string",
"dimension": "string",
"price": "string",
"unit": "string"
}
]
},
"validityTerm": {
"agreementDuration": "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.
- modelId
-
Model Id of the foundation model.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 140.
Pattern:
[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)
- offers
-
List of the offers associated with the specified model.
Type: Array of Offer objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions.
HTTP Status Code: 403
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: