Bedrock / Client / list_foundation_model_agreement_offers

list_foundation_model_agreement_offers

Bedrock.Client.list_foundation_model_agreement_offers(**kwargs)

Get the offers associated with the specified model.

See also: AWS API Documentation

Request Syntax

response = client.list_foundation_model_agreement_offers(
    modelId='string',
    offerType='ALL'|'PUBLIC'
)
Parameters:
  • modelId (string) –

    [REQUIRED]

    Model Id of the foundation model.

  • offerType (string) – Type of offer associated with the model.

Return type:

dict

Returns:

Response Syntax

{
    'modelId': 'string',
    'offers': [
        {
            'offerId': 'string',
            'offerToken': 'string',
            'termDetails': {
                'usageBasedPricingTerm': {
                    'rateCard': [
                        {
                            'dimension': 'string',
                            'price': 'string',
                            'description': 'string',
                            'unit': 'string'
                        },
                    ]
                },
                'legalTerm': {
                    'url': 'string'
                },
                'supportTerm': {
                    'refundPolicyDescription': 'string'
                },
                'validityTerm': {
                    'agreementDuration': 'string'
                }
            }
        },
    ]
}

Response Structure

  • (dict) –

    • modelId (string) –

      Model Id of the foundation model.

    • offers (list) –

      List of the offers associated with the specified model.

      • (dict) –

        An offer dictates usage terms for the model.

        • offerId (string) –

          Offer Id for a model offer.

        • offerToken (string) –

          Offer token.

        • termDetails (dict) –

          Details about the terms of the offer.

          • usageBasedPricingTerm (dict) –

            Describes the usage-based pricing term.

            • rateCard (list) –

              Describes a usage price for each dimension.

              • (dict) –

                Dimensional price rate.

                • dimension (string) –

                  Dimension for the price rate.

                • price (string) –

                  Single-dimensional rate information.

                • description (string) –

                  Description of the price rate.

                • unit (string) –

                  Unit associated with the price.

          • legalTerm (dict) –

            Describes the legal terms.

            • url (string) –

              URL to the legal term document.

          • supportTerm (dict) –

            Describes the support terms.

            • refundPolicyDescription (string) –

              Describes the refund policy.

          • validityTerm (dict) –

            Describes the validity terms.

            • agreementDuration (string) –

              Describes the agreement duration.

Exceptions

  • Bedrock.Client.exceptions.ResourceNotFoundException

  • Bedrock.Client.exceptions.AccessDeniedException

  • Bedrock.Client.exceptions.ValidationException

  • Bedrock.Client.exceptions.InternalServerException

  • Bedrock.Client.exceptions.ThrottlingException