Amazon Bedrock

Request a model access agreement for the specified model.

See also: AWS API Documentation

Request Syntax

client.create_foundation_model_agreement(
    offerToken='string',
    modelId='string'
)

type offerToken:

string

param offerToken:

[REQUIRED]

An offer token encapsulates the information for an offer.

type modelId:

string

param modelId:

[REQUIRED]

Model Id of the model for the access request.

rtype:

dict

returns:

Response Syntax

{
    'modelId': 'string'
}

Response Structure

• (dict) --

  • modelId (string) --

    Model Id of the model for the access request.

Get information about the Foundation model availability.

See also: AWS API Documentation

Request Syntax

client.get_foundation_model_availability(
    modelId='string'
)

type modelId:

string

param modelId:

[REQUIRED]

The model Id of the foundation model.

rtype:

dict

returns:

Response Syntax

{
    'modelId': 'string',
    'agreementAvailability': {
        'status': 'AVAILABLE'|'PENDING'|'NOT_AVAILABLE'|'ERROR',
        'errorMessage': 'string'
    },
    'authorizationStatus': 'AUTHORIZED'|'NOT_AUTHORIZED',
    'entitlementAvailability': 'AVAILABLE'|'NOT_AVAILABLE',
    'regionAvailability': 'AVAILABLE'|'NOT_AVAILABLE'
}

Response Structure

• (dict) --

  • modelId (string) --

    The model Id of the foundation model.

  • agreementAvailability (dict) --

    Agreement availability.

    • status (string) --

      Status of the agreement.

    • errorMessage (string) --

      Error message.

  • authorizationStatus (string) --

    Authorization status.

  • entitlementAvailability (string) --

    Entitlement availability.

  • regionAvailability (string) --

    Region availability.

Get the offers associated with the specified model.

See also: AWS API Documentation

Request Syntax

client.list_foundation_model_agreement_offers(
    modelId='string',
    offerType='ALL'|'PUBLIC'
)

type modelId:

string

param modelId:

[REQUIRED]

Model Id of the foundation model.

type offerType:

string

param offerType:

Type of offer associated with the model.

rtype:

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.

Put usecase for model access.

See also: AWS API Documentation

Request Syntax

client.put_use_case_for_model_access(
    formData=b'bytes'
)

type formData:

bytes

param formData:

[REQUIRED]

Put customer profile Request.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Get usecase for model access.

See also: AWS API Documentation

Request Syntax

client.get_use_case_for_model_access()

rtype:

dict

returns:

Response Syntax

{
    'formData': b'bytes'
}

Response Structure

• (dict) --

  • formData (bytes) --

    Get customer profile Response.

Delete the model access agreement for the specified model.

See also: AWS API Documentation

Request Syntax

client.delete_foundation_model_agreement(
    modelId='string'
)

type modelId:

string

param modelId:

[REQUIRED]

Model Id of the model access to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --