Skip to content

Bedrock  >  Operations  >  create_foundation_model_agreement

create_foundation_model_agreement

Operation

create_foundation_model_agreement async 

create_foundation_model_agreement(input: CreateFoundationModelAgreementInput, plugins: list[Plugin] | None = None) -> CreateFoundationModelAgreementOutput

Request a model access agreement for the specified model.

Parameters:

Name Type Description Default
input CreateFoundationModelAgreementInput

An instance of CreateFoundationModelAgreementInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CreateFoundationModelAgreementOutput

An instance of CreateFoundationModelAgreementOutput.

Input

CreateFoundationModelAgreementInput dataclass

Dataclass for CreateFoundationModelAgreementInput structure.

Attributes

model_id class-attribute instance-attribute 
model_id: str | None = None

Model Id of the model for the access request.

offer_token class-attribute instance-attribute 
offer_token: str | None = None

An offer token encapsulates the information for an offer.

Output

CreateFoundationModelAgreementOutput dataclass

Dataclass for CreateFoundationModelAgreementOutput structure.

Attributes

model_id instance-attribute 
model_id: str

Model Id of the model for the access request.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.