Amazon Bedrock

2026/11/20 - Amazon Bedrock - 25 new4 updated api methods

Changes  Amazon Bedrock adds APIs to manage projects, discover and apply to Trusted Access Programs, manage enrollments, and configure data retention storage for accounts, organizations, and projects. Model and inference profile discovery now supports project context.

PutTrustedAccessProgramProjectEnrollment (new) Link ¶

Sets a named project's enrollment preference for a trusted access program. The project must be active in this Region and owned by the calling account. Enabling requires applicable project, account, or organization approval and no applicable revocation, including when repeating an enabled setting; otherwise returns ConflictException and preserves the stored setting. Authorized disable and inherit writes are allowed while ineligible or revoked. Archived projects reject all writes with ValidationException.

See also: AWS API Documentation

Request Syntax

client.put_trusted_access_program_project_enrollment(
    programIdentifier='string',
    projectIdentifier='string',
    optIn='inherit'|'enabled'|'disabled'
)
type programIdentifier:

string

param programIdentifier:

[REQUIRED]

The identifier of the trusted access program.

type projectIdentifier:

string

param projectIdentifier:

[REQUIRED]

The id or ARN of the named Bedrock project. The default project is not supported; use PutTrustedAccessProgramAccountEnrollment for account-level enrollment. An ARN from another account, Region, or partition returns ValidationException. A project that does not exist in the calling account returns ResourceNotFoundException.

type optIn:

string

param optIn:

[REQUIRED]

The enrollment preference to store. A transition to enabled accepts the program's terms. Changing the preference records a new updatedAt. Repeating the same stored preference preserves updatedAt.

rtype:

dict

returns:

Response Syntax

{
    'optIn': 'inherit'|'enabled'|'disabled',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    The project's resulting stored enrollment setting. An initial inherit write creates a stored setting with updatedAt.

    • optIn (string) --

      Stored preference at the addressed scope. A missing enrollment returns inherit without updatedAt.

    • updatedAt (datetime) --

      The time the stored enrollment setting last changed.

StartTrustedAccessProgramProjectApplication (new) Link ¶

Prepare a provider application handoff for a named project. The project must be active in this Region and owned by the calling account. Archived projects return ValidationException. This does not submit an application, grant eligibility, or change enrollment. Programs without self-service applications return ValidationException with guidance to contact the AWS account team. Repeated calls can issue fresh tokens. Successful responses use Cache-Control: no-store.

See also: AWS API Documentation

Request Syntax

client.start_trusted_access_program_project_application(
    programIdentifier='string',
    projectIdentifier='string'
)
type programIdentifier:

string

param programIdentifier:

[REQUIRED]

Identifier of the trusted access program.

type projectIdentifier:

string

param projectIdentifier:

[REQUIRED]

The id or ARN of the named Bedrock project. The default project is not supported; use StartTrustedAccessProgramAccountApplication for an account-level application. An ARN from another account, Region, or partition returns ValidationException. A project that does not exist in the calling account returns ResourceNotFoundException.

rtype:

dict

returns:

Response Syntax

{
    'result': {
        'providerHandoff': {
            'enrollmentUrl': 'string',
            'applicationToken': 'string',
            'applicationTokenExpiresAt': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    The information needed to continue the project's application with the provider.

    • result (dict) --

      Provider handoff for the named project.

      • providerHandoff (dict) --

        Information for continuing the application with the provider.

        • enrollmentUrl (string) --

          Provider intake URL. When present, open it and paste the complete application token into the provider's token field. Omitted when the provider receives the application token through a separate integration.

        • applicationToken (string) --

          Opaque token binding the application to the authenticated customer, requested program, and scope.

        • applicationTokenExpiresAt (datetime) --

          Deadline for the provider to accept the application context. Start another application handoff if the token expires before acceptance.

ArchiveProject (new) Link ¶

Archives a project. Archiving is terminal; there is no delete. Archiving an already-archived project succeeds without effect. The default project cannot be archived.

See also: AWS API Documentation

Request Syntax

client.archive_project(
    projectIdentifier='string'
)
type projectIdentifier:

string

param projectIdentifier:

[REQUIRED]

The id or ARN of the project to archive.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'status': 'active'|'archived',
    'createdAt': datetime(2015, 1, 1),
    'archivedAt': datetime(2015, 1, 1),
    'dataRetention': {
        'mode': 'default'|'none'|'aws_review'|'provider_data_share'|'inherit'
    }
}

Response Structure

  • (dict) --

    The project after the archive operation.

    • id (string) --

      The project ID. The account's default project uses default; a named project's generated ID starts with proj_.

    • arn (string) --

      The Amazon Resource Name (ARN) of the project.

    • name (string) --

      The project's display name. Project names do not have to be unique.

    • status (string) --

      The project's lifecycle status.

    • createdAt (datetime) --

      The time the project was created.

    • archivedAt (datetime) --

      The time the project was archived.

    • dataRetention (dict) --

      The project's data retention setting. A mode of inherit defers to the account setting or model default.

      • mode (string) --

        The project's data retention mode. Use inherit to defer to the account setting or model default.

PutProjectDataRetentionStorage (new) Link ¶

Creates or replaces a project's retention storage record for a model provider. The project must be active in this AWS Region and owned by the calling account. A missing or unowned project returns ResourceNotFoundException; an archived project returns ValidationException.

Requires applicable project, account, or organization approval for a storage-capable trusted access program of the provider, with no applicable revocation. Otherwise, the operation returns ConflictException. Enrollment is not required to save the configuration.

The request replaces the complete stored configuration. The last successful write wins.

For customer_managed destinations, Amazon Bedrock validates the caller's and service's access to the bucket and key before saving the configuration. The bucket and key must be in the AWS Region where you register the configuration. Validation failures reject the write.

See also: AWS API Documentation

Request Syntax

client.put_project_data_retention_storage(
    projectIdentifier='string',
    modelProvider='anthropic'|'openai',
    storageDestination='customer_managed'|'amazon_managed',
    storageConfiguration={
        'kmsKeyArn': 'string',
        's3BucketArn': 'string',
        's3BucketOwner': 'string'
    }
)
type projectIdentifier:

string

param projectIdentifier:

[REQUIRED]

The ID or ARN of a named project owned by the calling account in this AWS Region. The default project is not supported; use the account-level retention storage operations instead.

type modelProvider:

string

param modelProvider:

[REQUIRED]

The model provider whose retention storage configuration is addressed by this request.

type storageDestination:

string

param storageDestination:

[REQUIRED]

Where retained data is delivered for this scope. customer_managed requires storageConfiguration; amazon_managed forbids it.

type storageConfiguration:

dict

param storageConfiguration:

Destination bucket and key. Required when storageDestination is customer_managed; rejected with ValidationException when amazon_managed.

  • kmsKeyArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the customer managed AWS Key Management Service (AWS KMS) key you use to encrypt retained data. Specify an enabled symmetric encryption key in the AWS Region where you register the configuration. You cannot specify a key alias.

  • s3BucketArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the Amazon S3 bucket that receives retained data. The bucket must be in the AWS Region where you register the configuration.

  • s3BucketOwner (string) -- [REQUIRED]

    The AWS account ID of the destination bucket's owner. You must specify the owner, even when the bucket belongs to another account. Amazon Bedrock uses this ID to verify bucket ownership for each delivery request.

rtype:

dict

returns:

Response Syntax

{
    'scope': 'account'|'organization'|'project',
    'modelProvider': 'anthropic'|'openai',
    'storageDestination': 'customer_managed'|'amazon_managed',
    'storageConfiguration': {
        'kmsKeyArn': 'string',
        's3BucketArn': 'string',
        's3BucketOwner': 'string'
    },
    'updatedAt': datetime(2015, 1, 1),
    'kmsKeyStatus': 'pending'|'active'|'access_denied',
    's3BucketStatus': 'pending'|'active'|'access_denied',
    'projectArn': 'string'
}

Response Structure

  • (dict) --

    The project's stored retention storage configuration after the write.

    • scope (string) --

      Scope addressed by the operation that returned this record.

    • modelProvider (string) --

      Model provider this configuration applies to.

    • storageDestination (string) --

      Where this record delivers retained data.

    • storageConfiguration (dict) --

      The stored destination and key. Present only when storageDestination is customer_managed.

      • kmsKeyArn (string) --

        The Amazon Resource Name (ARN) of the customer managed AWS Key Management Service (AWS KMS) key you use to encrypt retained data. Specify an enabled symmetric encryption key in the AWS Region where you register the configuration. You cannot specify a key alias.

      • s3BucketArn (string) --

        The Amazon Resource Name (ARN) of the Amazon S3 bucket that receives retained data. The bucket must be in the AWS Region where you register the configuration.

      • s3BucketOwner (string) --

        The AWS account ID of the destination bucket's owner. You must specify the owner, even when the bucket belongs to another account. Amazon Bedrock uses this ID to verify bucket ownership for each delivery request.

    • updatedAt (datetime) --

      Time the stored record last changed.

    • kmsKeyStatus (string) --

      Validation state of the KMS key. Present only when storageDestination is customer_managed.

    • s3BucketStatus (string) --

      Validation state of the bucket. Present only when storageDestination is customer_managed.

    • projectArn (string) --

      ARN of the configured project.

ListProjects (new) Link ¶

Lists the account's projects. Results are paginated: when the response includes nextToken, pass it in the next request to fetch the following page. Page size is 1-100, default 20. By default every project is returned regardless of status; set statusFilter to list only active or only archived projects.

See also: AWS API Documentation

Request Syntax

client.list_projects(
    nextToken='string',
    maxResults=123,
    statusFilter='active'|'archived'
)
type nextToken:

string

param nextToken:

Continuation token from a previous ListProjects response.

type maxResults:

integer

param maxResults:

The maximum number of projects to return in one response, from 1 to 100. The default is 20.

type statusFilter:

string

param statusFilter:

Returns only the projects in this lifecycle status. When absent, no status filtering is applied and every project is returned. New lifecycle states extend the ProjectStatus enum, and with it this filter, compatibly.

rtype:

dict

returns:

Response Syntax

{
    'projectSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'status': 'active'|'archived',
            'createdAt': datetime(2015, 1, 1),
            'archivedAt': datetime(2015, 1, 1),
            'dataRetention': {
                'mode': 'default'|'none'|'aws_review'|'provider_data_share'|'inherit'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    A page of projects and a continuation token when more results are available.

    • projectSummaries (list) --

      The projects returned for this page, including their details and data retention settings.

      • (dict) --

        A project's details and data retention setting.

        • id (string) --

          The project ID. The account's default project uses default; a named project's generated ID starts with proj_.

        • arn (string) --

          The Amazon Resource Name (ARN) of the project.

        • name (string) --

          The project's display name. Project names do not have to be unique.

        • status (string) --

          The project's lifecycle status.

        • createdAt (datetime) --

          The time the project was created.

        • archivedAt (datetime) --

          The time the project was archived.

        • dataRetention (dict) --

          The project's data retention setting. A mode of inherit defers to the account setting or model default.

          • mode (string) --

            The project's data retention mode. Use inherit to defer to the account setting or model default.

    • nextToken (string) --

      Continuation token; present only when more results exist. Pass it in the next request to fetch the following page.

ListTrustedAccessPrograms (new) Link ¶

Lists all trusted access programs visible to your account, ordered by program ID. Amazon Bedrock resolves participation for your account and its current organization. If you specify a project, Amazon Bedrock resolves participation for the project, including inheritance from the account and organization. Archived projects remain readable until they expire. Amazon Bedrock returns all visible programs in one response.

See also: AWS API Documentation

Request Syntax

client.list_trusted_access_programs(
    projectIdentifier='string',
    maxResults=123,
    nextToken='string'
)
type projectIdentifier:

string

param projectIdentifier:

The ID or ARN of a named Bedrock project owned by the calling account in this Region. When omitted, resolves participation for the calling account, including participation inherited from its current organization. When specified, resolves participation for the project, including participation inherited from the account and its current organization. You cannot specify the default project. Omit this field to resolve its inherited participation. An ARN from another account, Region, or partition returns ValidationException. A project that does not exist in the calling account returns ResourceNotFoundException.

type maxResults:

integer

param maxResults:

Reserved for future pagination support. Currently ignored; the response includes all visible programs.

type nextToken:

string

param nextToken:

Reserved for future pagination support. Omit this field.

rtype:

dict

returns:

Response Syntax

{
    'programSummaries': [
        {
            'programId': 'string',
            'name': 'string',
            'description': 'string',
            'providerName': 'string',
            'detailsUrl': 'string',
            'enrollmentUrl': 'string',
            'status': 'requestable'|'eligible'|'enabled'|'disabled'|'revoked',
            'statusReason': 'string',
            'source': 'organization'|'account'|'project'|'program_default',
            'eligibilityScope': 'organization'|'account'|'project'|'program_default',
            'resolvedFor': {
                'accountId': 'string',
                'projectArn': 'string'
            },
            'optIn': 'inherit'|'enabled'|'disabled',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    The visible trusted access programs and their resolved participation statuses.

    • programSummaries (list) --

      All visible programs with resolved participation, ordered by program ID. Always present, including an empty array when no programs are visible.

      • (dict) --

        A visible trusted access program and its resolved participation status.

        • programId (string) --

          Identifier of the trusted access program.

        • name (string) --

          Display name of the program.

        • description (string) --

          Description of the program and its effects on model access or data handling.

        • providerName (string) --

          Name of the model provider offering the program.

        • detailsUrl (string) --

          URL with program details, terms, and instructions for obtaining access.

        • enrollmentUrl (string) --

          Provider application intake URL. Omitted when the program has no customer-facing intake URL.

        • status (string) --

          Participation status resolved for the account and optional project context.

        • statusReason (string) --

          Nonempty explanation for requestable or revoked status. Omitted for other statuses.

        • source (string) --

          Scope deciding the status. This can differ from the scope supplying the resolved opt-in preference and enrollment timestamps.

        • eligibilityScope (string) --

          Scope supplying the applicable approval or most-specific revocation. Omitted when no approval or revocation applies.

        • resolvedFor (dict) --

          Account and optional project context for which participation was resolved.

          • accountId (string) --

            AWS account for which the program status was resolved, including applicable organization settings.

          • projectArn (string) --

            The canonical ARN of the authorized named project for which participation was resolved. Omitted when the request has no project context.

        • optIn (string) --

          Resolved customer preference, preserved independently of eligibility, including while revoked.

        • updatedAt (datetime) --

          Last change to the enrollment supplying the resolved opt-in. Present for enabled or disabled, including while revoked; omitted for inherit.

    • nextToken (string) --

      Reserved for future pagination support. Currently omitted because the response contains the complete list.

CreateProject (new) Link ¶

Creates a project: a workload boundary within the account that inference requests can be associated with.

See also: AWS API Documentation

Request Syntax

client.create_project(
    name='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    dataRetention={
        'mode': 'default'|'none'|'aws_review'|'provider_data_share'|'inherit'
    }
)
type name:

string

param name:

[REQUIRED]

The display name for the project. Project names do not have to be unique.

type tags:

list

param tags:

The tags to associate with the project.

  • (dict) --

    Definition of the key/value pair for a tag.

    • key (string) -- [REQUIRED]

      Key for the tag.

    • value (string) -- [REQUIRED]

      Value for the tag.

type dataRetention:

dict

param dataRetention:

The project's data-retention mode. If you omit this field, Amazon Bedrock sets the mode to inherit. The project then uses the account setting or the model default.

  • mode (string) -- [REQUIRED]

    The project's data retention mode. Use inherit to defer to the account setting or model default.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'status': 'active'|'archived',
    'createdAt': datetime(2015, 1, 1),
    'archivedAt': datetime(2015, 1, 1),
    'dataRetention': {
        'mode': 'default'|'none'|'aws_review'|'provider_data_share'|'inherit'
    }
}

Response Structure

  • (dict) --

    The newly created project.

    • id (string) --

      The project ID. The account's default project uses default; a named project's generated ID starts with proj_.

    • arn (string) --

      The Amazon Resource Name (ARN) of the project.

    • name (string) --

      The project's display name. Project names do not have to be unique.

    • status (string) --

      The project's lifecycle status.

    • createdAt (datetime) --

      The time the project was created.

    • archivedAt (datetime) --

      The time the project was archived.

    • dataRetention (dict) --

      The project's data retention setting. A mode of inherit defers to the account setting or model default.

      • mode (string) --

        The project's data retention mode. Use inherit to defer to the account setting or model default.

GetOrganizationDataRetentionStorage (new) Link ¶

Returns the organization's retention storage configuration for a model provider. The caller must be the organization's management account or a delegated administrator. Returns ResourceNotFoundException when no configuration exists.

See also: AWS API Documentation

Request Syntax

client.get_organization_data_retention_storage(
    modelProvider='anthropic'|'openai'
)
type modelProvider:

string

param modelProvider:

[REQUIRED]

The model provider whose retention storage configuration is addressed by this request.

rtype:

dict

returns:

Response Syntax

{
    'scope': 'account'|'organization'|'project',
    'modelProvider': 'anthropic'|'openai',
    'storageDestination': 'customer_managed'|'amazon_managed',
    'storageConfiguration': {
        'kmsKeyArn': 'string',
        's3BucketArn': 'string',
        's3BucketOwner': 'string'
    },
    'updatedAt': datetime(2015, 1, 1),
    'kmsKeyStatus': 'pending'|'active'|'access_denied',
    's3BucketStatus': 'pending'|'active'|'access_denied'
}

Response Structure

  • (dict) --

    The organization's stored retention storage configuration for the requested model provider.

    • scope (string) --

      Scope addressed by the operation that returned this record.

    • modelProvider (string) --

      Model provider this configuration applies to.

    • storageDestination (string) --

      Where this record delivers retained data.

    • storageConfiguration (dict) --

      The stored destination and key. Present only when storageDestination is customer_managed.

      • kmsKeyArn (string) --

        The Amazon Resource Name (ARN) of the customer managed AWS Key Management Service (AWS KMS) key you use to encrypt retained data. Specify an enabled symmetric encryption key in the AWS Region where you register the configuration. You cannot specify a key alias.

      • s3BucketArn (string) --

        The Amazon Resource Name (ARN) of the Amazon S3 bucket that receives retained data. The bucket must be in the AWS Region where you register the configuration.

      • s3BucketOwner (string) --

        The AWS account ID of the destination bucket's owner. You must specify the owner, even when the bucket belongs to another account. Amazon Bedrock uses this ID to verify bucket ownership for each delivery request.

    • updatedAt (datetime) --

      Time the stored record last changed.

    • kmsKeyStatus (string) --

      Validation state of the KMS key. Present only when storageDestination is customer_managed.

    • s3BucketStatus (string) --

      Validation state of the bucket. Present only when storageDestination is customer_managed.

DeleteAccountDataRetentionStorage (new) Link ¶

Deletes your account's retention storage configuration for a model provider. Deleting an absent configuration succeeds. You do not need to participate in the program to delete the configuration. You can delete it even if your account is ineligible or its eligibility is revoked.

See also: AWS API Documentation

Request Syntax

client.delete_account_data_retention_storage(
    modelProvider='anthropic'|'openai'
)
type modelProvider:

string

param modelProvider:

[REQUIRED]

The model provider whose retention storage configuration is addressed by this request.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

    A successful deletion returns no response fields.

DeleteOrganizationDataRetentionStorage (new) Link ¶

Deletes the organization's retention storage configuration for a model provider. The caller must be the organization's management account or a delegated administrator. Deleting an absent configuration succeeds; no program participation is required to delete.

See also: AWS API Documentation

Request Syntax

client.delete_organization_data_retention_storage(
    modelProvider='anthropic'|'openai'
)
type modelProvider:

string

param modelProvider:

[REQUIRED]

The model provider whose retention storage configuration is addressed by this request.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

    A successful deletion returns no response fields.

StartTrustedAccessProgramOrganizationApplication (new) Link ¶

Prepare a provider application handoff for the calling account's current organization. Requires operation permission and management-account or Bedrock-specific delegated-administrator authority. This does not submit an application, grant eligibility, or change enrollment. Programs without self-service applications return ValidationException with guidance to contact the AWS account team. Repeated calls can issue fresh tokens. Successful responses use Cache-Control: no-store.

See also: AWS API Documentation

Request Syntax

client.start_trusted_access_program_organization_application(
    programIdentifier='string'
)
type programIdentifier:

string

param programIdentifier:

[REQUIRED]

Identifier of the trusted access program.

rtype:

dict

returns:

Response Syntax

{
    'result': {
        'providerHandoff': {
            'enrollmentUrl': 'string',
            'applicationToken': 'string',
            'applicationTokenExpiresAt': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    The information needed to continue the organization's application with the provider.

    • result (dict) --

      Provider handoff for the calling account's current organization.

      • providerHandoff (dict) --

        Information for continuing the application with the provider.

        • enrollmentUrl (string) --

          Provider intake URL. When present, open it and paste the complete application token into the provider's token field. Omitted when the provider receives the application token through a separate integration.

        • applicationToken (string) --

          Opaque token binding the application to the authenticated customer, requested program, and scope.

        • applicationTokenExpiresAt (datetime) --

          Deadline for the provider to accept the application context. Start another application handoff if the token expires before acceptance.

PutTrustedAccessProgramAccountEnrollment (new) Link ¶

Sets your account's enrollment preference for a trusted access program. Amazon Bedrock identifies the account from your authenticated request. To enable enrollment, your account needs applicable approval and no applicable revocation, including when you repeat an enabled setting. Otherwise, Amazon Bedrock returns ConflictException and preserves the stored setting. With the required permissions, you can set disabled or inherit even if your account is ineligible or its eligibility is revoked.

See also: AWS API Documentation

Request Syntax

client.put_trusted_access_program_account_enrollment(
    programIdentifier='string',
    optIn='inherit'|'enabled'|'disabled'
)
type programIdentifier:

string

param programIdentifier:

[REQUIRED]

The identifier of the trusted access program.

type optIn:

string

param optIn:

[REQUIRED]

The enrollment preference to store. A transition to enabled accepts the program's terms. Changing the preference records a new updatedAt. Repeating the same stored preference preserves updatedAt.

rtype:

dict

returns:

Response Syntax

{
    'optIn': 'inherit'|'enabled'|'disabled',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    The account's resulting stored enrollment setting. An initial inherit write creates a stored setting with updatedAt.

    • optIn (string) --

      Stored preference at the addressed scope. A missing enrollment returns inherit without updatedAt.

    • updatedAt (datetime) --

      The time the stored enrollment setting last changed.

UpdateProject (new) Link ¶

Updates one mutable project field per call: exactly one of name or dataRetention must be set. The default project and archived projects cannot be updated.

See also: AWS API Documentation

Request Syntax

client.update_project(
    projectIdentifier='string',
    name='string',
    dataRetention={
        'mode': 'default'|'none'|'aws_review'|'provider_data_share'|'inherit'
    }
)
type projectIdentifier:

string

param projectIdentifier:

[REQUIRED]

The id or ARN of the project to update.

type name:

string

param name:

The project's new display name. Specify this field only when dataRetention is omitted. Project names do not have to be unique.

type dataRetention:

dict

param dataRetention:

The project's new data-retention mode. Must be set on its own.

  • mode (string) -- [REQUIRED]

    The project's data retention mode. Use inherit to defer to the account setting or model default.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'status': 'active'|'archived',
    'createdAt': datetime(2015, 1, 1),
    'archivedAt': datetime(2015, 1, 1),
    'dataRetention': {
        'mode': 'default'|'none'|'aws_review'|'provider_data_share'|'inherit'
    }
}

Response Structure

  • (dict) --

    The project after the update.

    • id (string) --

      The project ID. The account's default project uses default; a named project's generated ID starts with proj_.

    • arn (string) --

      The Amazon Resource Name (ARN) of the project.

    • name (string) --

      The project's display name. Project names do not have to be unique.

    • status (string) --

      The project's lifecycle status.

    • createdAt (datetime) --

      The time the project was created.

    • archivedAt (datetime) --

      The time the project was archived.

    • dataRetention (dict) --

      The project's data retention setting. A mode of inherit defers to the account setting or model default.

      • mode (string) --

        The project's data retention mode. Use inherit to defer to the account setting or model default.

GetTrustedAccessProgramOrganizationEnrollment (new) Link ¶

Gets the current organization's stored enrollment setting for a trusted access program. The organization and payer account are derived from the authenticated context. Requires operation permission and management-account or Bedrock-specific delegated-administrator authority. The setting can differ from the caller's resolved status returned by GetTrustedAccessProgram. If no enrollment is stored, returns inherit without timestamps.

See also: AWS API Documentation

Request Syntax

client.get_trusted_access_program_organization_enrollment(
    programIdentifier='string'
)
type programIdentifier:

string

param programIdentifier:

[REQUIRED]

The identifier of the trusted access program.

rtype:

dict

returns:

Response Syntax

{
    'optIn': 'inherit'|'enabled'|'disabled',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    The organization's stored enrollment. updatedAt is present whenever a row exists, including an explicit inherit setting.

    • optIn (string) --

      Stored preference at the addressed scope. A missing enrollment returns inherit without updatedAt.

    • updatedAt (datetime) --

      Last change to the stored enrollment. Present whenever a row exists, including an explicitly stored inherit setting.

PutOrganizationDataRetentionStorage (new) Link ¶

Creates or replaces the organization's retention storage record for a model provider. The organization is resolved from the authenticated caller's management context; the caller must be the organization's management account or a delegated administrator. Requires resolved organization-scope trusted access eligibility for a storage-capable program of the provider; otherwise returns ConflictException. Writes replace the whole record; the last write wins.

For customer_managed destinations, Amazon Bedrock validates the caller's and service's access to the bucket and key before saving the configuration. The bucket and key must be in the AWS Region where you register the configuration. Validation failures reject the write.

See also: AWS API Documentation

Request Syntax

client.put_organization_data_retention_storage(
    modelProvider='anthropic'|'openai',
    storageDestination='customer_managed'|'amazon_managed',
    storageConfiguration={
        'kmsKeyArn': 'string',
        's3BucketArn': 'string',
        's3BucketOwner': 'string'
    }
)
type modelProvider:

string

param modelProvider:

[REQUIRED]

The model provider whose retention storage configuration is addressed by this request.

type storageDestination:

string

param storageDestination:

[REQUIRED]

Where retained data is delivered for this scope. customer_managed requires storageConfiguration; amazon_managed forbids it.

type storageConfiguration:

dict

param storageConfiguration:

Destination bucket and key. Required when storageDestination is customer_managed; rejected with ValidationException when amazon_managed.

  • kmsKeyArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the customer managed AWS Key Management Service (AWS KMS) key you use to encrypt retained data. Specify an enabled symmetric encryption key in the AWS Region where you register the configuration. You cannot specify a key alias.

  • s3BucketArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the Amazon S3 bucket that receives retained data. The bucket must be in the AWS Region where you register the configuration.

  • s3BucketOwner (string) -- [REQUIRED]

    The AWS account ID of the destination bucket's owner. You must specify the owner, even when the bucket belongs to another account. Amazon Bedrock uses this ID to verify bucket ownership for each delivery request.

rtype:

dict

returns:

Response Syntax

{
    'scope': 'account'|'organization'|'project',
    'modelProvider': 'anthropic'|'openai',
    'storageDestination': 'customer_managed'|'amazon_managed',
    'storageConfiguration': {
        'kmsKeyArn': 'string',
        's3BucketArn': 'string',
        's3BucketOwner': 'string'
    },
    'updatedAt': datetime(2015, 1, 1),
    'kmsKeyStatus': 'pending'|'active'|'access_denied',
    's3BucketStatus': 'pending'|'active'|'access_denied'
}

Response Structure

  • (dict) --

    The organization's stored retention storage configuration after the write.

    • scope (string) --

      Scope addressed by the operation that returned this record.

    • modelProvider (string) --

      Model provider this configuration applies to.

    • storageDestination (string) --

      Where this record delivers retained data.

    • storageConfiguration (dict) --

      The stored destination and key. Present only when storageDestination is customer_managed.

      • kmsKeyArn (string) --

        The Amazon Resource Name (ARN) of the customer managed AWS Key Management Service (AWS KMS) key you use to encrypt retained data. Specify an enabled symmetric encryption key in the AWS Region where you register the configuration. You cannot specify a key alias.

      • s3BucketArn (string) --

        The Amazon Resource Name (ARN) of the Amazon S3 bucket that receives retained data. The bucket must be in the AWS Region where you register the configuration.

      • s3BucketOwner (string) --

        The AWS account ID of the destination bucket's owner. You must specify the owner, even when the bucket belongs to another account. Amazon Bedrock uses this ID to verify bucket ownership for each delivery request.

    • updatedAt (datetime) --

      Time the stored record last changed.

    • kmsKeyStatus (string) --

      Validation state of the KMS key. Present only when storageDestination is customer_managed.

    • s3BucketStatus (string) --

      Validation state of the bucket. Present only when storageDestination is customer_managed.

PutTrustedAccessProgramOrganizationEnrollment (new) Link ¶

Sets the current organization's enrollment preference for a trusted access program. The organization and payer account are derived from the authenticated context. Every write requires operation permission and management-account or Bedrock-specific delegated-administrator authority. Enabling requires approval and no revocation for the organization, including when repeating an enabled setting; otherwise returns ConflictException and preserves the stored setting. Account approval alone is insufficient. If you have the required permissions, you can set the enrollment preference to disabled or inherit even if your organization is ineligible or its eligibility is revoked.

See also: AWS API Documentation

Request Syntax

client.put_trusted_access_program_organization_enrollment(
    programIdentifier='string',
    optIn='inherit'|'enabled'|'disabled'
)
type programIdentifier:

string

param programIdentifier:

[REQUIRED]

The identifier of the trusted access program.

type optIn:

string

param optIn:

[REQUIRED]

The enrollment preference to store for the organization. A transition to enabled accepts the program's terms. Changing the preference records a new updatedAt. Repeating the same stored preference preserves updatedAt.

rtype:

dict

returns:

Response Syntax

{
    'optIn': 'inherit'|'enabled'|'disabled',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    The organization's resulting stored enrollment setting. An initial inherit write creates a stored setting with updatedAt.

    • optIn (string) --

      Stored preference at the addressed scope. A missing enrollment returns inherit without updatedAt.

    • updatedAt (datetime) --

      The time the stored enrollment setting last changed.

DeleteProjectDataRetentionStorage (new) Link ¶

Deletes a project's retention storage configuration for a model provider. Deleting an absent configuration on an active project succeeds. If the project does not exist or your account does not own it, the operation returns ResourceNotFoundException. For an archived project, the operation returns ValidationException. You can read the archived project's stored configuration until Amazon Bedrock purges the project. You do not need to participate in the program to delete the configuration.

See also: AWS API Documentation

Request Syntax

client.delete_project_data_retention_storage(
    projectIdentifier='string',
    modelProvider='anthropic'|'openai'
)
type projectIdentifier:

string

param projectIdentifier:

[REQUIRED]

The ID or ARN of a named project owned by the calling account in this AWS Region. The default project is not supported; use the account-level retention storage operations instead.

type modelProvider:

string

param modelProvider:

[REQUIRED]

The model provider whose retention storage configuration is addressed by this request.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

    A successful deletion returns no response fields.

GetProjectDataRetentionStorage (new) Link ¶

Returns a project's retention storage configuration for a model provider. Returns ResourceNotFoundException when the project does not exist, is not owned by the calling account, or has no configuration.

See also: AWS API Documentation

Request Syntax

client.get_project_data_retention_storage(
    projectIdentifier='string',
    modelProvider='anthropic'|'openai'
)
type projectIdentifier:

string

param projectIdentifier:

[REQUIRED]

The ID or ARN of a named project owned by the calling account in this AWS Region. The default project is not supported; use the account-level retention storage operations instead.

type modelProvider:

string

param modelProvider:

[REQUIRED]

The model provider whose retention storage configuration is addressed by this request.

rtype:

dict

returns:

Response Syntax

{
    'scope': 'account'|'organization'|'project',
    'modelProvider': 'anthropic'|'openai',
    'storageDestination': 'customer_managed'|'amazon_managed',
    'storageConfiguration': {
        'kmsKeyArn': 'string',
        's3BucketArn': 'string',
        's3BucketOwner': 'string'
    },
    'updatedAt': datetime(2015, 1, 1),
    'kmsKeyStatus': 'pending'|'active'|'access_denied',
    's3BucketStatus': 'pending'|'active'|'access_denied',
    'projectArn': 'string'
}

Response Structure

  • (dict) --

    The project's stored retention storage configuration for the requested model provider.

    • scope (string) --

      Scope addressed by the operation that returned this record.

    • modelProvider (string) --

      Model provider this configuration applies to.

    • storageDestination (string) --

      Where this record delivers retained data.

    • storageConfiguration (dict) --

      The stored destination and key. Present only when storageDestination is customer_managed.

      • kmsKeyArn (string) --

        The Amazon Resource Name (ARN) of the customer managed AWS Key Management Service (AWS KMS) key you use to encrypt retained data. Specify an enabled symmetric encryption key in the AWS Region where you register the configuration. You cannot specify a key alias.

      • s3BucketArn (string) --

        The Amazon Resource Name (ARN) of the Amazon S3 bucket that receives retained data. The bucket must be in the AWS Region where you register the configuration.

      • s3BucketOwner (string) --

        The AWS account ID of the destination bucket's owner. You must specify the owner, even when the bucket belongs to another account. Amazon Bedrock uses this ID to verify bucket ownership for each delivery request.

    • updatedAt (datetime) --

      Time the stored record last changed.

    • kmsKeyStatus (string) --

      Validation state of the KMS key. Present only when storageDestination is customer_managed.

    • s3BucketStatus (string) --

      Validation state of the bucket. Present only when storageDestination is customer_managed.

    • projectArn (string) --

      ARN of the configured project.

StartTrustedAccessProgramAccountApplication (new) Link ¶

Prepare a provider application handoff for the calling account. This does not submit an application, grant eligibility, or change enrollment. Programs without self-service applications return ValidationException with guidance to contact the AWS account team. Repeated calls can issue fresh tokens. Successful responses use Cache-Control: no-store.

See also: AWS API Documentation

Request Syntax

client.start_trusted_access_program_account_application(
    programIdentifier='string'
)
type programIdentifier:

string

param programIdentifier:

[REQUIRED]

Identifier of the trusted access program.

rtype:

dict

returns:

Response Syntax

{
    'result': {
        'providerHandoff': {
            'enrollmentUrl': 'string',
            'applicationToken': 'string',
            'applicationTokenExpiresAt': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    The information needed to continue the account's application with the provider.

    • result (dict) --

      Provider handoff for the calling account.

      • providerHandoff (dict) --

        Information for continuing the application with the provider.

        • enrollmentUrl (string) --

          Provider intake URL. When present, open it and paste the complete application token into the provider's token field. Omitted when the provider receives the application token through a separate integration.

        • applicationToken (string) --

          Opaque token binding the application to the authenticated customer, requested program, and scope.

        • applicationTokenExpiresAt (datetime) --

          Deadline for the provider to accept the application context. Start another application handoff if the token expires before acceptance.

GetTrustedAccessProgramAccountEnrollment (new) Link ¶

Gets the calling account's stored enrollment setting for a trusted access program. The account is derived from the authenticated caller. Use GetTrustedAccessProgram to retrieve the resolved participation status, including organization inheritance. If no enrollment is stored, returns inherit without timestamps.

See also: AWS API Documentation

Request Syntax

client.get_trusted_access_program_account_enrollment(
    programIdentifier='string'
)
type programIdentifier:

string

param programIdentifier:

[REQUIRED]

The identifier of the trusted access program.

rtype:

dict

returns:

Response Syntax

{
    'optIn': 'inherit'|'enabled'|'disabled',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    The account's stored enrollment. updatedAt is present whenever a row exists, including an explicit inherit setting.

    • optIn (string) --

      Stored preference at the addressed scope. A missing enrollment returns inherit without updatedAt.

    • updatedAt (datetime) --

      Last change to the stored enrollment. Present whenever a row exists, including an explicitly stored inherit setting.

PutAccountDataRetentionStorage (new) Link ¶

Creates or replaces the calling account's retention storage record for a model provider. Amazon Bedrock identifies the account from your authenticated request. Requires resolved trusted access eligibility for a storage-capable program of the provider at a covering scope; otherwise returns ConflictException. Writes replace the whole record; the last write wins.

For customer_managed destinations, Amazon Bedrock validates the caller's and service's access to the bucket and key before saving the configuration. The bucket and key must be in the AWS Region where you register the configuration. Validation failures reject the write.

See also: AWS API Documentation

Request Syntax

client.put_account_data_retention_storage(
    modelProvider='anthropic'|'openai',
    storageDestination='customer_managed'|'amazon_managed',
    storageConfiguration={
        'kmsKeyArn': 'string',
        's3BucketArn': 'string',
        's3BucketOwner': 'string'
    }
)
type modelProvider:

string

param modelProvider:

[REQUIRED]

The model provider whose retention storage configuration is addressed by this request.

type storageDestination:

string

param storageDestination:

[REQUIRED]

Where retained data is delivered for this scope. customer_managed requires storageConfiguration; amazon_managed forbids it.

type storageConfiguration:

dict

param storageConfiguration:

Destination bucket and key. Required when storageDestination is customer_managed; rejected with ValidationException when amazon_managed.

  • kmsKeyArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the customer managed AWS Key Management Service (AWS KMS) key you use to encrypt retained data. Specify an enabled symmetric encryption key in the AWS Region where you register the configuration. You cannot specify a key alias.

  • s3BucketArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the Amazon S3 bucket that receives retained data. The bucket must be in the AWS Region where you register the configuration.

  • s3BucketOwner (string) -- [REQUIRED]

    The AWS account ID of the destination bucket's owner. You must specify the owner, even when the bucket belongs to another account. Amazon Bedrock uses this ID to verify bucket ownership for each delivery request.

rtype:

dict

returns:

Response Syntax

{
    'scope': 'account'|'organization'|'project',
    'modelProvider': 'anthropic'|'openai',
    'storageDestination': 'customer_managed'|'amazon_managed',
    'storageConfiguration': {
        'kmsKeyArn': 'string',
        's3BucketArn': 'string',
        's3BucketOwner': 'string'
    },
    'updatedAt': datetime(2015, 1, 1),
    'kmsKeyStatus': 'pending'|'active'|'access_denied',
    's3BucketStatus': 'pending'|'active'|'access_denied'
}

Response Structure

  • (dict) --

    The stored configuration after the write.

    • scope (string) --

      Scope addressed by the operation that returned this record.

    • modelProvider (string) --

      Model provider this configuration applies to.

    • storageDestination (string) --

      Where this record delivers retained data.

    • storageConfiguration (dict) --

      The stored destination and key. Present only when storageDestination is customer_managed.

      • kmsKeyArn (string) --

        The Amazon Resource Name (ARN) of the customer managed AWS Key Management Service (AWS KMS) key you use to encrypt retained data. Specify an enabled symmetric encryption key in the AWS Region where you register the configuration. You cannot specify a key alias.

      • s3BucketArn (string) --

        The Amazon Resource Name (ARN) of the Amazon S3 bucket that receives retained data. The bucket must be in the AWS Region where you register the configuration.

      • s3BucketOwner (string) --

        The AWS account ID of the destination bucket's owner. You must specify the owner, even when the bucket belongs to another account. Amazon Bedrock uses this ID to verify bucket ownership for each delivery request.

    • updatedAt (datetime) --

      Time the stored record last changed.

    • kmsKeyStatus (string) --

      Validation state of the KMS key. Present only when storageDestination is customer_managed.

    • s3BucketStatus (string) --

      Validation state of the bucket. Present only when storageDestination is customer_managed.

GetTrustedAccessProgram (new) Link ¶

Gets trusted access program details and resolves participation for your account and its current organization. If you specify a project, Amazon Bedrock resolves participation for the project, including inheritance from the account and organization. Archived projects remain readable until they expire. Returns the same flat summary as a ListTrustedAccessPrograms item. An absent or invisible program returns ResourceNotFoundException.

See also: AWS API Documentation

Request Syntax

client.get_trusted_access_program(
    programIdentifier='string',
    projectIdentifier='string'
)
type programIdentifier:

string

param programIdentifier:

[REQUIRED]

Identifier of the trusted access program.

type projectIdentifier:

string

param projectIdentifier:

The ID or ARN of a named Bedrock project owned by the calling account in this Region. When omitted, resolves participation for the calling account, including participation inherited from its current organization. When specified, resolves participation for the project, including participation inherited from the account and its current organization. You cannot specify the default project. Omit this field to resolve its inherited participation. An ARN from another account, Region, or partition returns ValidationException. A project that does not exist in the calling account returns ResourceNotFoundException.

rtype:

dict

returns:

Response Syntax

{
    'programId': 'string',
    'name': 'string',
    'description': 'string',
    'providerName': 'string',
    'detailsUrl': 'string',
    'enrollmentUrl': 'string',
    'status': 'requestable'|'eligible'|'enabled'|'disabled'|'revoked',
    'statusReason': 'string',
    'source': 'organization'|'account'|'project'|'program_default',
    'eligibilityScope': 'organization'|'account'|'project'|'program_default',
    'resolvedFor': {
        'accountId': 'string',
        'projectArn': 'string'
    },
    'optIn': 'inherit'|'enabled'|'disabled',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    The program's details and participation resolved for the calling account or requested project.

    • programId (string) --

      Identifier of the trusted access program.

    • name (string) --

      Display name of the program.

    • description (string) --

      Description of the program and its effects on model access or data handling.

    • providerName (string) --

      Name of the model provider offering the program.

    • detailsUrl (string) --

      URL with program details, terms, and instructions for obtaining access.

    • enrollmentUrl (string) --

      Provider application intake URL. Omitted when the program has no customer-facing intake URL.

    • status (string) --

      Participation status resolved for the account and optional project context.

    • statusReason (string) --

      Nonempty explanation for requestable or revoked status. Omitted for other statuses.

    • source (string) --

      Scope deciding the status. This can differ from the scope supplying the resolved opt-in preference and enrollment timestamps.

    • eligibilityScope (string) --

      Scope supplying the applicable approval or most-specific revocation. Omitted when no approval or revocation applies.

    • resolvedFor (dict) --

      Account and optional project context for which participation was resolved.

      • accountId (string) --

        AWS account for which the program status was resolved, including applicable organization settings.

      • projectArn (string) --

        The canonical ARN of the authorized named project for which participation was resolved. Omitted when the request has no project context.

    • optIn (string) --

      Resolved customer preference, preserved independently of eligibility, including while revoked.

    • updatedAt (datetime) --

      Last change to the enrollment supplying the resolved opt-in. Present for enabled or disabled, including while revoked; omitted for inherit.

GetProject (new) Link ¶

Retrieves a project.

See also: AWS API Documentation

Request Syntax

client.get_project(
    projectIdentifier='string'
)
type projectIdentifier:

string

param projectIdentifier:

[REQUIRED]

The id or ARN of the project to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'status': 'active'|'archived',
    'createdAt': datetime(2015, 1, 1),
    'archivedAt': datetime(2015, 1, 1),
    'dataRetention': {
        'mode': 'default'|'none'|'aws_review'|'provider_data_share'|'inherit'
    }
}

Response Structure

  • (dict) --

    The requested project's details and data retention setting.

    • id (string) --

      The project ID. The account's default project uses default; a named project's generated ID starts with proj_.

    • arn (string) --

      The Amazon Resource Name (ARN) of the project.

    • name (string) --

      The project's display name. Project names do not have to be unique.

    • status (string) --

      The project's lifecycle status.

    • createdAt (datetime) --

      The time the project was created.

    • archivedAt (datetime) --

      The time the project was archived.

    • dataRetention (dict) --

      The project's data retention setting. A mode of inherit defers to the account setting or model default.

      • mode (string) --

        The project's data retention mode. Use inherit to defer to the account setting or model default.

GetAccountDataRetentionStorage (new) Link ¶

Returns your account's stored retention storage configuration for a model provider. Amazon Bedrock determines whether the configuration applies when processing an inference request. Returns ResourceNotFoundException when no configuration exists.

See also: AWS API Documentation

Request Syntax

client.get_account_data_retention_storage(
    modelProvider='anthropic'|'openai'
)
type modelProvider:

string

param modelProvider:

[REQUIRED]

The model provider whose retention storage configuration is addressed by this request.

rtype:

dict

returns:

Response Syntax

{
    'scope': 'account'|'organization'|'project',
    'modelProvider': 'anthropic'|'openai',
    'storageDestination': 'customer_managed'|'amazon_managed',
    'storageConfiguration': {
        'kmsKeyArn': 'string',
        's3BucketArn': 'string',
        's3BucketOwner': 'string'
    },
    'updatedAt': datetime(2015, 1, 1),
    'kmsKeyStatus': 'pending'|'active'|'access_denied',
    's3BucketStatus': 'pending'|'active'|'access_denied'
}

Response Structure

  • (dict) --

    The calling account's stored retention storage configuration for the requested model provider.

    • scope (string) --

      Scope addressed by the operation that returned this record.

    • modelProvider (string) --

      Model provider this configuration applies to.

    • storageDestination (string) --

      Where this record delivers retained data.

    • storageConfiguration (dict) --

      The stored destination and key. Present only when storageDestination is customer_managed.

      • kmsKeyArn (string) --

        The Amazon Resource Name (ARN) of the customer managed AWS Key Management Service (AWS KMS) key you use to encrypt retained data. Specify an enabled symmetric encryption key in the AWS Region where you register the configuration. You cannot specify a key alias.

      • s3BucketArn (string) --

        The Amazon Resource Name (ARN) of the Amazon S3 bucket that receives retained data. The bucket must be in the AWS Region where you register the configuration.

      • s3BucketOwner (string) --

        The AWS account ID of the destination bucket's owner. You must specify the owner, even when the bucket belongs to another account. Amazon Bedrock uses this ID to verify bucket ownership for each delivery request.

    • updatedAt (datetime) --

      Time the stored record last changed.

    • kmsKeyStatus (string) --

      Validation state of the KMS key. Present only when storageDestination is customer_managed.

    • s3BucketStatus (string) --

      Validation state of the bucket. Present only when storageDestination is customer_managed.

GetTrustedAccessProgramProjectEnrollment (new) Link ¶

Gets a named project's stored enrollment setting for a trusted access program. The project must exist in this Region and be owned by the calling account. Archived projects remain readable until they expire. Use GetTrustedAccessProgram with projectIdentifier to retrieve resolved participation, including account and organization inheritance. If no enrollment is stored, returns inherit without timestamps.

See also: AWS API Documentation

Request Syntax

client.get_trusted_access_program_project_enrollment(
    programIdentifier='string',
    projectIdentifier='string'
)
type programIdentifier:

string

param programIdentifier:

[REQUIRED]

The identifier of the trusted access program.

type projectIdentifier:

string

param projectIdentifier:

[REQUIRED]

The id or ARN of the named Bedrock project. The default project is not supported; use GetTrustedAccessProgramAccountEnrollment for account-level enrollment. An ARN from another account, Region, or partition returns ValidationException. A project that does not exist in the calling account returns ResourceNotFoundException.

rtype:

dict

returns:

Response Syntax

{
    'optIn': 'inherit'|'enabled'|'disabled',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    The project's stored enrollment. updatedAt is present whenever a row exists, including an explicit inherit setting.

    • optIn (string) --

      Stored preference at the addressed scope. A missing enrollment returns inherit without updatedAt.

    • updatedAt (datetime) --

      Last change to the stored enrollment. Present whenever a row exists, including an explicitly stored inherit setting.

GetFoundationModel (updated) Link ¶
Changes (request)
{'projectIdentifier': 'string'}

Get details about a Amazon Bedrock foundation model.

See also: AWS API Documentation

Request Syntax

client.get_foundation_model(
    modelIdentifier='string',
    projectIdentifier='string'
)
type modelIdentifier:

string

param modelIdentifier:

[REQUIRED]

The model identifier.

type projectIdentifier:

string

param projectIdentifier:

The ID or Amazon Resource Name (ARN) of a project. Amazon Bedrock uses the project's trusted access program participation when determining whether to return the model. The project must belong to your account in the same AWS Region and partition as the request.

If you omit this parameter or specify default, Amazon Bedrock uses your account's participation, including organization inheritance.

A project that doesn't exist or is archived causes a ValidationException. A model outside the project's available model catalog causes a ResourceNotFoundException.

rtype:

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'|'DISTILLATION',
        ],
        'inferenceTypesSupported': [
            'ON_DEMAND'|'PROVISIONED',
        ],
        'modelLifecycle': {
            'status': 'ACTIVE'|'LEGACY',
            'startOfLifeTime': datetime(2015, 1, 1),
            'endOfLifeTime': datetime(2015, 1, 1),
            'legacyTime': datetime(2015, 1, 1),
            'publicExtendedAccessTime': datetime(2015, 1, 1)
        }
    }
}

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.

        • startOfLifeTime (datetime) --

          Launch time when the model first becomes available

        • endOfLifeTime (datetime) --

          Time when the model is no longer available for use

        • legacyTime (datetime) --

          Time when the model enters legacy state. Models in legacy state can still be used, but users should plan to transition to an Active model before the end of life time

        • publicExtendedAccessTime (datetime) --

          Public extended access portion of the legacy period, when users should expect higher pricing

GetInferenceProfile (updated) Link ¶
Changes (request)
{'projectIdentifier': 'string'}

Gets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

See also: AWS API Documentation

Request Syntax

client.get_inference_profile(
    inferenceProfileIdentifier='string',
    projectIdentifier='string'
)
type inferenceProfileIdentifier:

string

param inferenceProfileIdentifier:

[REQUIRED]

The ID or Amazon Resource Name (ARN) of the inference profile.

type projectIdentifier:

string

param projectIdentifier:

The ID or Amazon Resource Name (ARN) of a project. Amazon Bedrock uses the project's trusted access program participation when determining whether to return a system-defined inference profile. The project must belong to your account in the same AWS Region and partition as the request.

If you omit this parameter or specify default, Amazon Bedrock uses your account's participation, including organization inheritance.

A project that doesn't exist or is archived causes a ValidationException. Specifying a project other than default for an application inference profile also causes a ValidationException.

rtype:

dict

returns:

Response Syntax

{
    'inferenceProfileName': 'string',
    'description': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'inferenceProfileArn': 'string',
    'models': [
        {
            'modelArn': 'string'
        },
    ],
    'inferenceProfileId': 'string',
    'status': 'ACTIVE',
    'type': 'SYSTEM_DEFINED'|'APPLICATION'
}

Response Structure

  • (dict) --

    • inferenceProfileName (string) --

      The name of the inference profile.

    • description (string) --

      The description of the inference profile.

    • createdAt (datetime) --

      The time at which the inference profile was created.

    • updatedAt (datetime) --

      The time at which the inference profile was last updated.

    • inferenceProfileArn (string) --

      The Amazon Resource Name (ARN) of the inference profile.

    • models (list) --

      A list of information about each model in the inference profile.

      • (dict) --

        Contains information about a model.

        • modelArn (string) --

          The Amazon Resource Name (ARN) of the model.

    • inferenceProfileId (string) --

      The unique identifier of the inference profile.

    • status (string) --

      The status of the inference profile. ACTIVE means that the inference profile is ready to be used.

    • type (string) --

      The type of the inference profile. The following types are possible:

      • SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.

      • APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.

ListFoundationModels (updated) Link ¶
Changes (request)
{'projectIdentifier': 'string'}

Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.

See also: AWS API Documentation

Request Syntax

client.list_foundation_models(
    byProvider='string',
    byCustomizationType='FINE_TUNING'|'CONTINUED_PRE_TRAINING'|'DISTILLATION',
    byOutputModality='TEXT'|'IMAGE'|'EMBEDDING',
    byInferenceType='ON_DEMAND'|'PROVISIONED',
    projectIdentifier='string'
)
type byProvider:

string

param byProvider:

Return models belonging to the model provider that you specify.

type byCustomizationType:

string

param byCustomizationType:

Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.

type byOutputModality:

string

param byOutputModality:

Return models that support the output modality that you specify.

type byInferenceType:

string

param byInferenceType:

Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

type projectIdentifier:

string

param projectIdentifier:

The ID or Amazon Resource Name (ARN) of a project. Amazon Bedrock uses the project's trusted access program participation when determining which models to return. The project must belong to your account in the same AWS Region and partition as the request.

If you omit this parameter or specify default, Amazon Bedrock uses your account's participation, including organization inheritance. A project that doesn't exist or is archived causes a ValidationException.

rtype:

dict

returns:

Response Syntax

{
    'modelSummaries': [
        {
            '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'|'DISTILLATION',
            ],
            'inferenceTypesSupported': [
                'ON_DEMAND'|'PROVISIONED',
            ],
            'modelLifecycle': {
                'status': 'ACTIVE'|'LEGACY',
                'startOfLifeTime': datetime(2015, 1, 1),
                'endOfLifeTime': datetime(2015, 1, 1),
                'legacyTime': datetime(2015, 1, 1),
                'publicExtendedAccessTime': datetime(2015, 1, 1)
            }
        },
    ]
}

Response Structure

  • (dict) --

    • modelSummaries (list) --

      A list of Amazon Bedrock foundation models.

      • (dict) --

        Summary information for a foundation model.

        • modelArn (string) --

          The Amazon Resource Name (ARN) of the foundation model.

        • modelId (string) --

          The model ID of the foundation model.

        • modelName (string) --

          The name of the model.

        • 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) --

          Whether the model supports fine-tuning or continual pre-training.

          • (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.

          • startOfLifeTime (datetime) --

            Launch time when the model first becomes available

          • endOfLifeTime (datetime) --

            Time when the model is no longer available for use

          • legacyTime (datetime) --

            Time when the model enters legacy state. Models in legacy state can still be used, but users should plan to transition to an Active model before the end of life time

          • publicExtendedAccessTime (datetime) --

            Public extended access portion of the legacy period, when users should expect higher pricing

ListInferenceProfiles (updated) Link ¶
Changes (request)
{'projectIdentifier': 'string'}

Returns a list of inference profiles that you can use. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

See also: AWS API Documentation

Request Syntax

client.list_inference_profiles(
    maxResults=123,
    nextToken='string',
    typeEquals='SYSTEM_DEFINED'|'APPLICATION',
    projectIdentifier='string'
)
type maxResults:

integer

param maxResults:

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

type nextToken:

string

param nextToken:

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

type typeEquals:

string

param typeEquals:

Filters for inference profiles that match the type you specify.

  • SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.

  • APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.

type projectIdentifier:

string

param projectIdentifier:

The ID or Amazon Resource Name (ARN) of a project. Amazon Bedrock uses the project's trusted access program participation when determining which system-defined inference profiles to return. The project must belong to your account in the same AWS Region and partition as the request.

If you omit this parameter or specify default, Amazon Bedrock uses your account's participation, including organization inheritance.

A project that doesn't exist or is archived causes a ValidationException. Specifying a project other than default with typeEquals set to APPLICATION also causes a ValidationException. Omit typeEquals or set it to SYSTEM_DEFINED to list system-defined inference profiles for the project.

rtype:

dict

returns:

Response Syntax

{
    'inferenceProfileSummaries': [
        {
            'inferenceProfileName': 'string',
            'description': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'inferenceProfileArn': 'string',
            'models': [
                {
                    'modelArn': 'string'
                },
            ],
            'inferenceProfileId': 'string',
            'status': 'ACTIVE',
            'type': 'SYSTEM_DEFINED'|'APPLICATION'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • inferenceProfileSummaries (list) --

      A list of information about each inference profile that you can use.

      • (dict) --

        Contains information about an inference profile.

        • inferenceProfileName (string) --

          The name of the inference profile.

        • description (string) --

          The description of the inference profile.

        • createdAt (datetime) --

          The time at which the inference profile was created.

        • updatedAt (datetime) --

          The time at which the inference profile was last updated.

        • inferenceProfileArn (string) --

          The Amazon Resource Name (ARN) of the inference profile.

        • models (list) --

          A list of information about each model in the inference profile.

          • (dict) --

            Contains information about a model.

            • modelArn (string) --

              The Amazon Resource Name (ARN) of the model.

        • inferenceProfileId (string) --

          The unique identifier of the inference profile.

        • status (string) --

          The status of the inference profile. ACTIVE means that the inference profile is ready to be used.

        • type (string) --

          The type of the inference profile. The following types are possible:

          • SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.

          • APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.

    • nextToken (string) --

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.