Bedrock / Client / get_foundation_model

get_foundation_model

Bedrock.Client.get_foundation_model(**kwargs)

Get details about a Amazon Bedrock foundation model.

See also: AWS API Documentation

Request Syntax

response = client.get_foundation_model(
    modelIdentifier='string'
)

Parameters:

modelIdentifier (string) –

[REQUIRED]

The model identifier.

Return type:

dict

Returns:

Response Syntax

{
    'modelDetails': {
        'modelArn': 'string',
        'modelId': 'string',
        'modelName': 'string',
        'providerName': 'string',
        'inputModalities': [
            'TEXT'|'IMAGE'|'EMBEDDING',
        ],
        'outputModalities': [
            'TEXT'|'IMAGE'|'EMBEDDING',
        ],
        'responseStreamingSupported': True|False,
        'customizationsSupported': [
            'FINE_TUNING'|'CONTINUED_PRE_TRAINING',
        ],
        'inferenceTypesSupported': [
            'ON_DEMAND'|'PROVISIONED',
        ],
        'modelLifecycle': {
            'status': 'ACTIVE'|'LEGACY'
        }
    }
}

Response Structure

• (dict) –

  • modelDetails (dict) –

    Information about the foundation model.

    • modelArn (string) –

      The model Amazon Resource Name (ARN).

    • modelId (string) –

      The model identifier.

    • modelName (string) –

      The model name.

    • providerName (string) –

      The model’s provider name.

    • inputModalities (list) –

      The input modalities that the model supports.

      • (string) –

    • outputModalities (list) –

      The output modalities that the model supports.

      • (string) –

    • responseStreamingSupported (boolean) –

      Indicates whether the model supports streaming.

    • customizationsSupported (list) –

      The customization that the model supports.

      • (string) –

    • inferenceTypesSupported (list) –

      The inference types that the model supports.

      • (string) –

    • modelLifecycle (dict) –

      Contains details about whether a model version is available or deprecated

      • status (string) –

        Specifies whether a model version is available ( ACTIVE) or deprecated ( LEGACY.

Exceptions

• Bedrock.Client.exceptions.ResourceNotFoundException

• Bedrock.Client.exceptions.AccessDeniedException

• Bedrock.Client.exceptions.ValidationException

• Bedrock.Client.exceptions.InternalServerException

• Bedrock.Client.exceptions.ThrottlingException