bedrock

package module
v1.25.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 9, 2025 License: Apache-2.0 Imports: 48 Imported by: 18

Documentation

Overview

Package bedrock provides the API client, operations, and parameter types for Amazon Bedrock.

Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.

Index

Constants

View Source 
const ServiceAPIVersion = "2023-04-20"
View Source 
const ServiceID = "Bedrock"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.3.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.3.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.3.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.3.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchDeleteEvaluationJobInput added in v1.15.0 

type BatchDeleteEvaluationJobInput struct {

	// A list of one or more evaluation job Amazon Resource Names (ARNs) you want to
	// delete.
	//
	// This member is required.
	JobIdentifiers []string
	// contains filtered or unexported fields
}

type BatchDeleteEvaluationJobOutput added in v1.15.0 

type BatchDeleteEvaluationJobOutput struct {

	// A JSON object containing the HTTP status codes and the ARNs of evaluation jobs
	// that failed to be deleted.
	//
	// This member is required.
	Errors []types.BatchDeleteEvaluationJobError

	// The list of evaluation jobs for deletion.
	//
	// This member is required.
	EvaluationJobs []types.BatchDeleteEvaluationJobItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Bedrock.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchDeleteEvaluationJob added in v1.15.0 

func (c *Client) BatchDeleteEvaluationJob(ctx context.Context, params *BatchDeleteEvaluationJobInput, optFns ...func(*Options)) (*BatchDeleteEvaluationJobOutput, error)

Deletes a batch of evaluation jobs. An evaluation job can only be deleted if it has following status FAILED , COMPLETED , and STOPPED . You can request up to 25 model evaluation jobs be deleted in a single request.

func (*Client) CreateEvaluationJob added in v1.8.0 

func (c *Client) CreateEvaluationJob(ctx context.Context, params *CreateEvaluationJobInput, optFns ...func(*Options)) (*CreateEvaluationJobOutput, error)

Creates an evaluation job.

func (*Client) CreateGuardrail added in v1.8.0 

func (c *Client) CreateGuardrail(ctx context.Context, params *CreateGuardrailInput, optFns ...func(*Options)) (*CreateGuardrailOutput, error)

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.

  • Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.

  • Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.

  • Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.

  • Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.

In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.

For more information, see Amazon Bedrock Guardrails in the Amazon Bedrock User Guide.

func (*Client) CreateGuardrailVersion added in v1.8.0 

func (c *Client) CreateGuardrailVersion(ctx context.Context, params *CreateGuardrailVersionInput, optFns ...func(*Options)) (*CreateGuardrailVersionOutput, error)

Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.

func (*Client) CreateInferenceProfile added in v1.22.0 

func (c *Client) CreateInferenceProfile(ctx context.Context, params *CreateInferenceProfileInput, optFns ...func(*Options)) (*CreateInferenceProfileOutput, error)

Creates an application inference profile to track metrics and costs when invoking a model. To create an application inference profile for a foundation model in one region, specify the ARN of the model in that region. To create an application inference profile for a foundation model across multiple regions, specify the ARN of the system-defined inference profile that contains the regions that you want to route requests to. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

func (*Client) CreateMarketplaceModelEndpoint added in v1.25.0 

func (c *Client) CreateMarketplaceModelEndpoint(ctx context.Context, params *CreateMarketplaceModelEndpointInput, optFns ...func(*Options)) (*CreateMarketplaceModelEndpointOutput, error)

Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.

func (*Client) CreateModelCopyJob added in v1.13.0 

func (c *Client) CreateModelCopyJob(ctx context.Context, params *CreateModelCopyJobInput, optFns ...func(*Options)) (*CreateModelCopyJobOutput, error)

Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regionsin the Amazon Bedrock User Guide.

func (*Client) CreateModelCustomizationJob 

func (c *Client) CreateModelCustomizationJob(ctx context.Context, params *CreateModelCustomizationJobInput, optFns ...func(*Options)) (*CreateModelCustomizationJobOutput, error)

Creates a fine-tuning job to customize a base model.

You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.

For information on the format of training and validation data, see Prepare the datasets.

Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

For more information, see Custom models in the Amazon Bedrock User Guide.

func (*Client) CreateModelImportJob added in v1.15.0 

func (c *Client) CreateModelImportJob(ctx context.Context, params *CreateModelImportJobInput, optFns ...func(*Options)) (*CreateModelImportJobOutput, error)

Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker. For more information, see Import a customized model

func (*Client) CreateModelInvocationJob added in v1.14.0 

func (c *Client) CreateModelInvocationJob(ctx context.Context, params *CreateModelInvocationJobInput, optFns ...func(*Options)) (*CreateModelInvocationJobOutput, error)

Creates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference dataand upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference.

The response returns a jobArn that you can use to stop or get details about the job.

func (*Client) CreateProvisionedModelThroughput added in v1.1.0 

func (c *Client) CreateProvisionedModelThroughput(ctx context.Context, params *CreateProvisionedModelThroughputInput, optFns ...func(*Options)) (*CreateProvisionedModelThroughputOutput, error)

Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughputin the Amazon Bedrock User Guide.

func (*Client) DeleteCustomModel 

func (c *Client) DeleteCustomModel(ctx context.Context, params *DeleteCustomModelInput, optFns ...func(*Options)) (*DeleteCustomModelOutput, error)

Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.

func (*Client) DeleteGuardrail added in v1.8.0 

func (c *Client) DeleteGuardrail(ctx context.Context, params *DeleteGuardrailInput, optFns ...func(*Options)) (*DeleteGuardrailOutput, error)

Deletes a guardrail.

  • To delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier field. If you delete a guardrail, all of its versions will be deleted.

  • To delete a version of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field and the version in the guardrailVersion field.

func (*Client) DeleteImportedModel added in v1.15.0 

func (c *Client) DeleteImportedModel(ctx context.Context, params *DeleteImportedModelInput, optFns ...func(*Options)) (*DeleteImportedModelOutput, error)

Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.

func (*Client) DeleteInferenceProfile added in v1.22.0 

func (c *Client) DeleteInferenceProfile(ctx context.Context, params *DeleteInferenceProfileInput, optFns ...func(*Options)) (*DeleteInferenceProfileOutput, error)

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

func (*Client) DeleteMarketplaceModelEndpoint added in v1.25.0 

func (c *Client) DeleteMarketplaceModelEndpoint(ctx context.Context, params *DeleteMarketplaceModelEndpointInput, optFns ...func(*Options)) (*DeleteMarketplaceModelEndpointOutput, error)

Deletes an endpoint for a model from Amazon Bedrock Marketplace.

func (*Client) DeleteModelInvocationLoggingConfiguration 

func (c *Client) DeleteModelInvocationLoggingConfiguration(ctx context.Context, params *DeleteModelInvocationLoggingConfigurationInput, optFns ...func(*Options)) (*DeleteModelInvocationLoggingConfigurationOutput, error)

Delete the invocation logging.

func (*Client) DeleteProvisionedModelThroughput added in v1.1.0 

func (c *Client) DeleteProvisionedModelThroughput(ctx context.Context, params *DeleteProvisionedModelThroughputInput, optFns ...func(*Options)) (*DeleteProvisionedModelThroughputOutput, error)

Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughputin the Amazon Bedrock User Guide.

func (*Client) DeregisterMarketplaceModelEndpoint added in v1.25.0 

func (c *Client) DeregisterMarketplaceModelEndpoint(ctx context.Context, params *DeregisterMarketplaceModelEndpointInput, optFns ...func(*Options)) (*DeregisterMarketplaceModelEndpointOutput, error)

Deregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint.

func (*Client) GetCustomModel 

func (c *Client) GetCustomModel(ctx context.Context, params *GetCustomModelInput, optFns ...func(*Options)) (*GetCustomModelOutput, error)

Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom modelsin the Amazon Bedrock User Guide.

func (*Client) GetEvaluationJob added in v1.8.0 

func (c *Client) GetEvaluationJob(ctx context.Context, params *GetEvaluationJobInput, optFns ...func(*Options)) (*GetEvaluationJobOutput, error)

Gets information about an evaluation job, such as the status of the job.

func (*Client) GetFoundationModel 

func (c *Client) GetFoundationModel(ctx context.Context, params *GetFoundationModelInput, optFns ...func(*Options)) (*GetFoundationModelOutput, error)

Get details about a Amazon Bedrock foundation model.

func (*Client) GetGuardrail added in v1.8.0 

func (c *Client) GetGuardrail(ctx context.Context, params *GetGuardrailInput, optFns ...func(*Options)) (*GetGuardrailOutput, error)

Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.

func (*Client) GetImportedModel added in v1.15.0 

func (c *Client) GetImportedModel(ctx context.Context, params *GetImportedModelInput, optFns ...func(*Options)) (*GetImportedModelOutput, error)

Gets properties associated with a customized model you imported.

func (*Client) GetInferenceProfile added in v1.16.0 

func (c *Client) GetInferenceProfile(ctx context.Context, params *GetInferenceProfileInput, optFns ...func(*Options)) (*GetInferenceProfileOutput, error)

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.

func (*Client) GetMarketplaceModelEndpoint added in v1.25.0 

func (c *Client) GetMarketplaceModelEndpoint(ctx context.Context, params *GetMarketplaceModelEndpointInput, optFns ...func(*Options)) (*GetMarketplaceModelEndpointOutput, error)

Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.

func (*Client) GetModelCopyJob added in v1.13.0 

func (c *Client) GetModelCopyJob(ctx context.Context, params *GetModelCopyJobInput, optFns ...func(*Options)) (*GetModelCopyJobOutput, error)

Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide .

func (*Client) GetModelCustomizationJob 

func (c *Client) GetModelCustomizationJob(ctx context.Context, params *GetModelCustomizationJobInput, optFns ...func(*Options)) (*GetModelCustomizationJobOutput, error)

Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom modelsin the Amazon Bedrock User Guide.

func (*Client) GetModelImportJob added in v1.15.0 

func (c *Client) GetModelImportJob(ctx context.Context, params *GetModelImportJobInput, optFns ...func(*Options)) (*GetModelImportJobOutput, error)

Retrieves the properties associated with import model job, including the status of the job. For more information, see Import a customized modelin the Amazon Bedrock User Guide.

func (*Client) GetModelInvocationJob added in v1.14.0 

func (c *Client) GetModelInvocationJob(ctx context.Context, params *GetModelInvocationJobInput, optFns ...func(*Options)) (*GetModelInvocationJobOutput, error)

Gets details about a batch inference job. For more information, see Monitor batch inference jobs

func (*Client) GetModelInvocationLoggingConfiguration 

func (c *Client) GetModelInvocationLoggingConfiguration(ctx context.Context, params *GetModelInvocationLoggingConfigurationInput, optFns ...func(*Options)) (*GetModelInvocationLoggingConfigurationOutput, error)

Get the current configuration values for model invocation logging.

func (*Client) GetPromptRouter added in v1.25.0 

func (c *Client) GetPromptRouter(ctx context.Context, params *GetPromptRouterInput, optFns ...func(*Options)) (*GetPromptRouterOutput, error)

Retrieves details about a prompt router.

func (*Client) GetProvisionedModelThroughput added in v1.1.0 

func (c *Client) GetProvisionedModelThroughput(ctx context.Context, params *GetProvisionedModelThroughputInput, optFns ...func(*Options)) (*GetProvisionedModelThroughputOutput, error)

Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide .

func (*Client) ListCustomModels 

func (c *Client) ListCustomModels(ctx context.Context, params *ListCustomModelsInput, optFns ...func(*Options)) (*ListCustomModelsOutput, error)

Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.

For more information, see Custom models in the Amazon Bedrock User Guide.

func (*Client) ListEvaluationJobs added in v1.8.0 

func (c *Client) ListEvaluationJobs(ctx context.Context, params *ListEvaluationJobsInput, optFns ...func(*Options)) (*ListEvaluationJobsOutput, error)

Lists all existing evaluation jobs.

func (*Client) ListFoundationModels 

func (c *Client) ListFoundationModels(ctx context.Context, params *ListFoundationModelsInput, optFns ...func(*Options)) (*ListFoundationModelsOutput, error)

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

func (*Client) ListGuardrails added in v1.8.0 

func (c *Client) ListGuardrails(ctx context.Context, params *ListGuardrailsInput, optFns ...func(*Options)) (*ListGuardrailsOutput, error)

Lists details about all the guardrails in an account. To list the DRAFT version of all your guardrails, don't specify the guardrailIdentifier field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field.

You can set the maximum number of results to return in a response in the maxResults field. If there are more results than the number you set, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.

func (*Client) ListImportedModels added in v1.15.0 

func (c *Client) ListImportedModels(ctx context.Context, params *ListImportedModelsInput, optFns ...func(*Options)) (*ListImportedModelsOutput, error)

Returns a list of models you've imported. You can filter the results to return based on one or more criteria. For more information, see Import a customized modelin the Amazon Bedrock User Guide.

func (*Client) ListInferenceProfiles added in v1.16.0 

func (c *Client) ListInferenceProfiles(ctx context.Context, params *ListInferenceProfilesInput, optFns ...func(*Options)) (*ListInferenceProfilesOutput, error)

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.

func (*Client) ListMarketplaceModelEndpoints added in v1.25.0 

func (c *Client) ListMarketplaceModelEndpoints(ctx context.Context, params *ListMarketplaceModelEndpointsInput, optFns ...func(*Options)) (*ListMarketplaceModelEndpointsOutput, error)

Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.

func (*Client) ListModelCopyJobs added in v1.13.0 

func (c *Client) ListModelCopyJobs(ctx context.Context, params *ListModelCopyJobsInput, optFns ...func(*Options)) (*ListModelCopyJobsOutput, error)

Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Copy models to be used in other regionsin the Amazon Bedrock User Guide.

func (*Client) ListModelCustomizationJobs 

func (c *Client) ListModelCustomizationJobs(ctx context.Context, params *ListModelCustomizationJobsInput, optFns ...func(*Options)) (*ListModelCustomizationJobsOutput, error)

Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.

For more information, see Custom models in the Amazon Bedrock User Guide.

func (*Client) ListModelImportJobs added in v1.15.0 

func (c *Client) ListModelImportJobs(ctx context.Context, params *ListModelImportJobsInput, optFns ...func(*Options)) (*ListModelImportJobsOutput, error)

Returns a list of import jobs you've submitted. You can filter the results to return based on one or more criteria. For more information, see Import a customized modelin the Amazon Bedrock User Guide.

func (*Client) ListModelInvocationJobs added in v1.14.0 

func (c *Client) ListModelInvocationJobs(ctx context.Context, params *ListModelInvocationJobsInput, optFns ...func(*Options)) (*ListModelInvocationJobsOutput, error)

Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.

func (*Client) ListPromptRouters added in v1.25.0 

func (c *Client) ListPromptRouters(ctx context.Context, params *ListPromptRoutersInput, optFns ...func(*Options)) (*ListPromptRoutersOutput, error)

Retrieves a list of prompt routers.

func (*Client) ListProvisionedModelThroughputs added in v1.1.0 

func (c *Client) ListProvisionedModelThroughputs(ctx context.Context, params *ListProvisionedModelThroughputsInput, optFns ...func(*Options)) (*ListProvisionedModelThroughputsOutput, error)

Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

List the tags associated with the specified resource.

For more information, see Tagging resources in the Amazon Bedrock User Guide.

func (*Client) Options added in v1.5.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutModelInvocationLoggingConfiguration 

func (c *Client) PutModelInvocationLoggingConfiguration(ctx context.Context, params *PutModelInvocationLoggingConfigurationInput, optFns ...func(*Options)) (*PutModelInvocationLoggingConfigurationOutput, error)

Set the configuration values for model invocation logging.

func (*Client) RegisterMarketplaceModelEndpoint added in v1.25.0 

func (c *Client) RegisterMarketplaceModelEndpoint(ctx context.Context, params *RegisterMarketplaceModelEndpointInput, optFns ...func(*Options)) (*RegisterMarketplaceModelEndpointOutput, error)

Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.

func (*Client) StopEvaluationJob added in v1.8.0 

func (c *Client) StopEvaluationJob(ctx context.Context, params *StopEvaluationJobInput, optFns ...func(*Options)) (*StopEvaluationJobOutput, error)

Stops an evaluation job that is current being created or running.

func (*Client) StopModelCustomizationJob 

func (c *Client) StopModelCustomizationJob(ctx context.Context, params *StopModelCustomizationJobInput, optFns ...func(*Options)) (*StopModelCustomizationJobOutput, error)

Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.

func (*Client) StopModelInvocationJob added in v1.14.0 

func (c *Client) StopModelInvocationJob(ctx context.Context, params *StopModelInvocationJobInput, optFns ...func(*Options)) (*StopModelInvocationJobOutput, error)

Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

func (*Client) UpdateGuardrail added in v1.8.0 

func (c *Client) UpdateGuardrail(ctx context.Context, params *UpdateGuardrailInput, optFns ...func(*Options)) (*UpdateGuardrailOutput, error)

Updates a guardrail with the values you specify.

  • Specify a name and optional description .

  • Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields.

  • Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfigobject in the topicsConfig list pertains to one topic.

  • Give a name and description so that the guardrail can properly identify the topic.

  • Specify DENY in the type field.

  • (Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list.

  • Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfigobject in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.

  • Specify the category in the type field.

  • Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig.

  • (Optional) For security, include the ARN of a KMS key in the kmsKeyId field.

func (*Client) UpdateMarketplaceModelEndpoint added in v1.25.0 

func (c *Client) UpdateMarketplaceModelEndpoint(ctx context.Context, params *UpdateMarketplaceModelEndpointInput, optFns ...func(*Options)) (*UpdateMarketplaceModelEndpointOutput, error)

Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.

func (*Client) UpdateProvisionedModelThroughput added in v1.1.0 

func (c *Client) UpdateProvisionedModelThroughput(ctx context.Context, params *UpdateProvisionedModelThroughputInput, optFns ...func(*Options)) (*UpdateProvisionedModelThroughputOutput, error)

Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughputin the Amazon Bedrock User Guide.

type CreateEvaluationJobInput added in v1.8.0 

type CreateEvaluationJobInput struct {

	// Contains the configuration details of either an automated or human-based
	// evaluation job.
	//
	// This member is required.
	EvaluationConfig types.EvaluationConfig

	// Contains the configuration details of the inference model for the evaluation
	// job.
	//
	// For model evaluation jobs, automated jobs support a single model or [inference profile], and jobs
	// that use human workers support two models or inference profiles.
	//
	// [inference profile]: https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html
	//
	// This member is required.
	InferenceConfig types.EvaluationInferenceConfig

	// A name for the evaluation job. Names must unique with your Amazon Web Services
	// account, and your account's Amazon Web Services region.
	//
	// This member is required.
	JobName *string

	// Contains the configuration details of the Amazon S3 bucket for storing the
	// results of the evaluation job.
	//
	// This member is required.
	OutputDataConfig *types.EvaluationOutputDataConfig

	// The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can
	// assume to perform tasks on your behalf. To learn more about the required
	// permissions, see [Required permissions for model evaluations].
	//
	// [Required permissions for model evaluations]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html
	//
	// This member is required.
	RoleArn *string

	// Specifies whether the evaluation job is for evaluating a model or evaluating a
	// knowledge base (retrieval and response generation).
	ApplicationType types.ApplicationType

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than one time. If this token matches a previous request, Amazon Bedrock
	// ignores the request, but does not return an error. For more information, see [Ensuring idempotency].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientRequestToken *string

	// Specify your customer managed encryption key Amazon Resource Name (ARN) that
	// will be used to encrypt your evaluation job.
	CustomerEncryptionKeyId *string

	// A description of the evaluation job.
	JobDescription *string

	// Tags to attach to the model evaluation job.
	JobTags []types.Tag
	// contains filtered or unexported fields
}

type CreateEvaluationJobOutput added in v1.8.0 

type CreateEvaluationJobOutput struct {

	// The Amazon Resource Name (ARN) of the evaluation job.
	//
	// This member is required.
	JobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateGuardrailInput added in v1.8.0 

type CreateGuardrailInput struct {

	// The message to return when the guardrail blocks a prompt.
	//
	// This member is required.
	BlockedInputMessaging *string

	// The message to return when the guardrail blocks a model response.
	//
	// This member is required.
	BlockedOutputsMessaging *string

	// The name to give the guardrail.
	//
	// This member is required.
	Name *string

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than once. If this token matches a previous request, Amazon Bedrock ignores
	// the request, but does not return an error. For more information, see [Ensuring idempotency]in the
	// Amazon S3 User Guide.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientRequestToken *string

	// The content filter policies to configure for the guardrail.
	ContentPolicyConfig *types.GuardrailContentPolicyConfig

	// The contextual grounding policy configuration used to create a guardrail.
	ContextualGroundingPolicyConfig *types.GuardrailContextualGroundingPolicyConfig

	// A description of the guardrail.
	Description *string

	// The ARN of the KMS key that you use to encrypt the guardrail.
	KmsKeyId *string

	// The sensitive information policy to configure for the guardrail.
	SensitiveInformationPolicyConfig *types.GuardrailSensitiveInformationPolicyConfig

	// The tags that you want to attach to the guardrail.
	Tags []types.Tag

	// The topic policies to configure for the guardrail.
	TopicPolicyConfig *types.GuardrailTopicPolicyConfig

	// The word policy you configure for the guardrail.
	WordPolicyConfig *types.GuardrailWordPolicyConfig
	// contains filtered or unexported fields
}

type CreateGuardrailOutput added in v1.8.0 

type CreateGuardrailOutput struct {

	// The time at which the guardrail was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The ARN of the guardrail.
	//
	// This member is required.
	GuardrailArn *string

	// The unique identifier of the guardrail that was created.
	//
	// This member is required.
	GuardrailId *string

	// The version of the guardrail that was created. This value will always be DRAFT .
	//
	// This member is required.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateGuardrailVersionInput added in v1.8.0 

type CreateGuardrailVersionInput struct {

	// The unique identifier of the guardrail. This can be an ID or the ARN.
	//
	// This member is required.
	GuardrailIdentifier *string

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than once. If this token matches a previous request, Amazon Bedrock ignores
	// the request, but does not return an error. For more information, see [Ensuring idempotency]in the
	// Amazon S3 User Guide.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientRequestToken *string

	// A description of the guardrail version.
	Description *string
	// contains filtered or unexported fields
}

type CreateGuardrailVersionOutput added in v1.8.0 

type CreateGuardrailVersionOutput struct {

	// The unique identifier of the guardrail.
	//
	// This member is required.
	GuardrailId *string

	// The number of the version of the guardrail.
	//
	// This member is required.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateInferenceProfileInput added in v1.22.0 

type CreateInferenceProfileInput struct {

	// A name for the inference profile.
	//
	// This member is required.
	InferenceProfileName *string

	// The foundation model or system-defined inference profile that the inference
	// profile will track metrics and costs for.
	//
	// This member is required.
	ModelSource types.InferenceProfileModelSource

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than one time. If this token matches a previous request, Amazon Bedrock
	// ignores the request, but does not return an error. For more information, see [Ensuring idempotency].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientRequestToken *string

	// A description for the inference profile.
	Description *string

	// An array of objects, each of which contains a tag and its value. For more
	// information, see [Tagging resources]in the [Amazon Bedrock User Guide].
	//
	// [Amazon Bedrock User Guide]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
	// [Tagging resources]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateInferenceProfileOutput added in v1.22.0 

type CreateInferenceProfileOutput struct {

	// The ARN of the inference profile that you created.
	//
	// This member is required.
	InferenceProfileArn *string

	// The status of the inference profile. ACTIVE means that the inference profile is
	// ready to be used.
	Status types.InferenceProfileStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMarketplaceModelEndpointInput added in v1.25.0 

type CreateMarketplaceModelEndpointInput struct {

	// The configuration for the endpoint, including the number and type of instances
	// to use.
	//
	// This member is required.
	EndpointConfig types.EndpointConfig

	// The name of the endpoint. This name must be unique within your Amazon Web
	// Services account and region.
	//
	// This member is required.
	EndpointName *string

	// The ARN of the model from Amazon Bedrock Marketplace that you want to deploy to
	// the endpoint.
	//
	// This member is required.
	ModelSourceIdentifier *string

	// Indicates whether you accept the end-user license agreement (EULA) for the
	// model. Set to true to accept the EULA.
	AcceptEula bool

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. This token is listed as not required because Amazon Web Services
	// SDKs automatically generate it for you and set this parameter. If you're not
	// using the Amazon Web Services SDK or the CLI, you must provide this token or the
	// action will fail.
	ClientRequestToken *string

	// An array of key-value pairs to apply to the underlying Amazon SageMaker
	// endpoint. You can use these tags to organize and identify your Amazon Web
	// Services resources.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMarketplaceModelEndpointOutput added in v1.25.0 

type CreateMarketplaceModelEndpointOutput struct {

	// Details about the created endpoint.
	//
	// This member is required.
	MarketplaceModelEndpoint *types.MarketplaceModelEndpoint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateModelCopyJobInput added in v1.13.0 

type CreateModelCopyJobInput struct {

	// The Amazon Resource Name (ARN) of the model to be copied.
	//
	// This member is required.
	SourceModelArn *string

	// A name for the copied model.
	//
	// This member is required.
	TargetModelName *string

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than one time. If this token matches a previous request, Amazon Bedrock
	// ignores the request, but does not return an error. For more information, see [Ensuring idempotency].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientRequestToken *string

	// The ARN of the KMS key that you use to encrypt the model copy.
	ModelKmsKeyId *string

	// Tags to associate with the target model. For more information, see [Tag resources] in the [Amazon Bedrock User Guide].
	//
	// [Tag resources]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html
	// [Amazon Bedrock User Guide]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
	TargetModelTags []types.Tag
	// contains filtered or unexported fields
}

type CreateModelCopyJobOutput added in v1.13.0 

type CreateModelCopyJobOutput struct {

	// The Amazon Resource Name (ARN) of the model copy job.
	//
	// This member is required.
	JobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateModelCustomizationJobInput 

type CreateModelCustomizationJobInput struct {

	// Name of the base model.
	//
	// This member is required.
	BaseModelIdentifier *string

	// A name for the resulting custom model.
	//
	// This member is required.
	CustomModelName *string

	// A name for the fine-tuning job.
	//
	// This member is required.
	JobName *string

	// S3 location for the output data.
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can
	// assume to perform tasks on your behalf. For example, during model training,
	// Amazon Bedrock needs your permission to read input data from an S3 bucket, write
	// model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller
	// of this API must have the iam:PassRole permission.
	//
	// This member is required.
	RoleArn *string

	// Information about the training dataset.
	//
	// This member is required.
	TrainingDataConfig *types.TrainingDataConfig

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than one time. If this token matches a previous request, Amazon Bedrock
	// ignores the request, but does not return an error. For more information, see [Ensuring idempotency].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientRequestToken *string

	// The custom model is encrypted at rest using this key.
	CustomModelKmsKeyId *string

	// Tags to attach to the resulting custom model.
	CustomModelTags []types.Tag

	// The customization configuration for the model customization job.
	CustomizationConfig types.CustomizationConfig

	// The customization type.
	CustomizationType types.CustomizationType

	// Parameters related to tuning the model. For details on the format for different
	// models, see [Custom model hyperparameters].
	//
	// [Custom model hyperparameters]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html
	HyperParameters map[string]string

	// Tags to attach to the job.
	JobTags []types.Tag

	// Information about the validation dataset.
	ValidationDataConfig *types.ValidationDataConfig

	// The configuration of the Virtual Private Cloud (VPC) that contains the
	// resources that you're using for this job. For more information, see [Protect your model customization jobs using a VPC].
	//
	// [Protect your model customization jobs using a VPC]: https://docs.aws.amazon.com/bedrock/latest/userguide/vpc-model-customization.html
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type CreateModelCustomizationJobOutput 

type CreateModelCustomizationJobOutput struct {

	// Amazon Resource Name (ARN) of the fine tuning job
	//
	// This member is required.
	JobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateModelImportJobInput added in v1.15.0 

type CreateModelImportJobInput struct {

	// The name of the imported model.
	//
	// This member is required.
	ImportedModelName *string

	// The name of the import job.
	//
	// This member is required.
	JobName *string

	// The data source for the imported model.
	//
	// This member is required.
	ModelDataSource types.ModelDataSource

	// The Amazon Resource Name (ARN) of the model import job.
	//
	// This member is required.
	RoleArn *string

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than one time. If this token matches a previous request, Amazon Bedrock
	// ignores the request, but does not return an error. For more information, see [Ensuring idempotency].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientRequestToken *string

	// The imported model is encrypted at rest using this key.
	ImportedModelKmsKeyId *string

	// Tags to attach to the imported model.
	ImportedModelTags []types.Tag

	// Tags to attach to this import job.
	JobTags []types.Tag

	// VPC configuration parameters for the private Virtual Private Cloud (VPC) that
	// contains the resources you are using for the import job.
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type CreateModelImportJobOutput added in v1.15.0 

type CreateModelImportJobOutput struct {

	// The Amazon Resource Name (ARN) of the model import job.
	//
	// This member is required.
	JobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateModelInvocationJobInput added in v1.14.0 

type CreateModelInvocationJobInput struct {

	// Details about the location of the input to the batch inference job.
	//
	// This member is required.
	InputDataConfig types.ModelInvocationJobInputDataConfig

	// A name to give the batch inference job.
	//
	// This member is required.
	JobName *string

	// The unique identifier of the foundation model to use for the batch inference
	// job.
	//
	// This member is required.
	ModelId *string

	// Details about the location of the output of the batch inference job.
	//
	// This member is required.
	OutputDataConfig types.ModelInvocationJobOutputDataConfig

	// The Amazon Resource Name (ARN) of the service role with permissions to carry
	// out and manage batch inference. You can use the console to create a default
	// service role or follow the steps at [Create a service role for batch inference].
	//
	// [Create a service role for batch inference]: https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html
	//
	// This member is required.
	RoleArn *string

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than one time. If this token matches a previous request, Amazon Bedrock
	// ignores the request, but does not return an error. For more information, see [Ensuring idempotency].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientRequestToken *string

	// Any tags to associate with the batch inference job. For more information, see [Tagging Amazon Bedrock resources].
	//
	// [Tagging Amazon Bedrock resources]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html
	Tags []types.Tag

	// The number of hours after which to force the batch inference job to time out.
	TimeoutDurationInHours *int32

	// The configuration of the Virtual Private Cloud (VPC) for the data in the batch
	// inference job. For more information, see [Protect batch inference jobs using a VPC].
	//
	// [Protect batch inference jobs using a VPC]: https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type CreateModelInvocationJobOutput added in v1.14.0 

type CreateModelInvocationJobOutput struct {

	// The Amazon Resource Name (ARN) of the batch inference job.
	//
	// This member is required.
	JobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateProvisionedModelThroughputInput added in v1.1.0 

type CreateProvisionedModelThroughputInput struct {

	// The Amazon Resource Name (ARN) or name of the model to associate with this
	// Provisioned Throughput. For a list of models for which you can purchase
	// Provisioned Throughput, see [Amazon Bedrock model IDs for purchasing Provisioned Throughput]in the [Amazon Bedrock User Guide].
	//
	// [Amazon Bedrock model IDs for purchasing Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#prov-throughput-models
	// [Amazon Bedrock User Guide]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
	//
	// This member is required.
	ModelId *string

	// Number of model units to allocate. A model unit delivers a specific throughput
	// level for the specified model. The throughput level of a model unit specifies
	// the total number of input and output tokens that it can process and generate
	// within a span of one minute. By default, your account has no model units for
	// purchasing Provisioned Throughputs with commitment. You must first visit the [Amazon Web Services support center]to
	// request MUs.
	//
	// For model unit quotas, see [Provisioned Throughput quotas] in the [Amazon Bedrock User Guide].
	//
	// For more information about what an MU specifies, contact your Amazon Web
	// Services account manager.
	//
	// [Amazon Web Services support center]: https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase
	// [Provisioned Throughput quotas]: https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html#prov-thru-quotas
	// [Amazon Bedrock User Guide]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
	//
	// This member is required.
	ModelUnits *int32

	// The name for this Provisioned Throughput.
	//
	// This member is required.
	ProvisionedModelName *string

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than one time. If this token matches a previous request, Amazon Bedrock
	// ignores the request, but does not return an error. For more information, see [Ensuring idempotency]in
	// the Amazon S3 User Guide.
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientRequestToken *string

	// The commitment duration requested for the Provisioned Throughput. Billing
	// occurs hourly and is discounted for longer commitment terms. To request a
	// no-commit Provisioned Throughput, omit this field.
	//
	// Custom models support all levels of commitment. To see which base models
	// support no commitment, see [Supported regions and models for Provisioned Throughput]in the [Amazon Bedrock User Guide]
	//
	// [Amazon Bedrock User Guide]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
	// [Supported regions and models for Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/pt-supported.html
	CommitmentDuration types.CommitmentDuration

	// Tags to associate with this Provisioned Throughput.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateProvisionedModelThroughputOutput added in v1.1.0 

type CreateProvisionedModelThroughputOutput struct {

	// The Amazon Resource Name (ARN) for this Provisioned Throughput.
	//
	// This member is required.
	ProvisionedModelArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCustomModelInput 

type DeleteCustomModelInput struct {

	// Name of the model to delete.
	//
	// This member is required.
	ModelIdentifier *string
	// contains filtered or unexported fields
}

type DeleteCustomModelOutput 

type DeleteCustomModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGuardrailInput added in v1.8.0 

type DeleteGuardrailInput struct {

	// The unique identifier of the guardrail. This can be an ID or the ARN.
	//
	// This member is required.
	GuardrailIdentifier *string

	// The version of the guardrail.
	GuardrailVersion *string
	// contains filtered or unexported fields
}

type DeleteGuardrailOutput added in v1.8.0 

type DeleteGuardrailOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteImportedModelInput added in v1.15.0 

type DeleteImportedModelInput struct {

	// Name of the imported model to delete.
	//
	// This member is required.
	ModelIdentifier *string
	// contains filtered or unexported fields
}

type DeleteImportedModelOutput added in v1.15.0 

type DeleteImportedModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteInferenceProfileInput added in v1.22.0 

type DeleteInferenceProfileInput struct {

	// The Amazon Resource Name (ARN) or ID of the application inference profile to
	// delete.
	//
	// This member is required.
	InferenceProfileIdentifier *string
	// contains filtered or unexported fields
}

type DeleteInferenceProfileOutput added in v1.22.0 

type DeleteInferenceProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMarketplaceModelEndpointInput added in v1.25.0 

type DeleteMarketplaceModelEndpointInput struct {

	// The Amazon Resource Name (ARN) of the endpoint you want to delete.
	//
	// This member is required.
	EndpointArn *string
	// contains filtered or unexported fields
}

type DeleteMarketplaceModelEndpointOutput added in v1.25.0 

type DeleteMarketplaceModelEndpointOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteModelInvocationLoggingConfigurationInput 

type DeleteModelInvocationLoggingConfigurationInput struct {
	// contains filtered or unexported fields
}

type DeleteModelInvocationLoggingConfigurationOutput 

type DeleteModelInvocationLoggingConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteProvisionedModelThroughputInput added in v1.1.0 

type DeleteProvisionedModelThroughputInput struct {

	// The Amazon Resource Name (ARN) or name of the Provisioned Throughput.
	//
	// This member is required.
	ProvisionedModelId *string
	// contains filtered or unexported fields
}

type DeleteProvisionedModelThroughputOutput added in v1.1.0 

type DeleteProvisionedModelThroughputOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeregisterMarketplaceModelEndpointInput added in v1.25.0 

type DeregisterMarketplaceModelEndpointInput struct {

	// The Amazon Resource Name (ARN) of the endpoint you want to deregister.
	//
	// This member is required.
	EndpointArn *string
	// contains filtered or unexported fields
}

type DeregisterMarketplaceModelEndpointOutput added in v1.25.0 

type DeregisterMarketplaceModelEndpointOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetCustomModelInput 

type GetCustomModelInput struct {

	// Name or Amazon Resource Name (ARN) of the custom model.
	//
	// This member is required.
	ModelIdentifier *string
	// contains filtered or unexported fields
}

type GetCustomModelOutput 

type GetCustomModelOutput struct {

	// Amazon Resource Name (ARN) of the base model.
	//
	// This member is required.
	BaseModelArn *string

	// Creation time of the model.
	//
	// This member is required.
	CreationTime *time.Time

	// Job Amazon Resource Name (ARN) associated with this model.
	//
	// This member is required.
	JobArn *string

	// Amazon Resource Name (ARN) associated with this model.
	//
	// This member is required.
	ModelArn *string

	// Model name associated with this model.
	//
	// This member is required.
	ModelName *string

	// Output data configuration associated with this custom model.
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// Contains information about the training dataset.
	//
	// This member is required.
	TrainingDataConfig *types.TrainingDataConfig

	// The customization configuration for the custom model.
	CustomizationConfig types.CustomizationConfig

	// The type of model customization.
	CustomizationType types.CustomizationType

	// Hyperparameter values associated with this model. For details on the format for
	// different models, see [Custom model hyperparameters].
	//
	// [Custom model hyperparameters]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html
	HyperParameters map[string]string

	// Job name associated with this model.
	JobName *string

	// The custom model is encrypted at rest using this key.
	ModelKmsKeyArn *string

	// Contains training metrics from the job creation.
	TrainingMetrics *types.TrainingMetrics

	// Contains information about the validation dataset.
	ValidationDataConfig *types.ValidationDataConfig

	// The validation metrics from the job creation.
	ValidationMetrics []types.ValidatorMetric

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetEvaluationJobInput added in v1.8.0 

type GetEvaluationJobInput struct {

	// The Amazon Resource Name (ARN) of the evaluation job you want get information
	// on.
	//
	// This member is required.
	JobIdentifier *string
	// contains filtered or unexported fields
}

type GetEvaluationJobOutput added in v1.8.0 

type GetEvaluationJobOutput struct {

	// The time the evaluation job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// Contains the configuration details of either an automated or human-based
	// evaluation job.
	//
	// This member is required.
	EvaluationConfig types.EvaluationConfig

	// Contains the configuration details of the inference model used for the
	// evaluation job.
	//
	// This member is required.
	InferenceConfig types.EvaluationInferenceConfig

	// The Amazon Resource Name (ARN) of the evaluation job.
	//
	// This member is required.
	JobArn *string

	// The name for the evaluation job.
	//
	// This member is required.
	JobName *string

	// Specifies whether the evaluation job is automated or human-based.
	//
	// This member is required.
	JobType types.EvaluationJobType

	// Contains the configuration details of the Amazon S3 bucket for storing the
	// results of the evaluation job.
	//
	// This member is required.
	OutputDataConfig *types.EvaluationOutputDataConfig

	// The Amazon Resource Name (ARN) of the IAM service role used in the evaluation
	// job.
	//
	// This member is required.
	RoleArn *string

	// The current status of the evaluation job.
	//
	// This member is required.
	Status types.EvaluationJobStatus

	// Specifies whether the evaluation job is for evaluating a model or evaluating a
	// knowledge base (retrieval and response generation).
	ApplicationType types.ApplicationType

	// The Amazon Resource Name (ARN) of the customer managed encryption key specified
	// when the evaluation job was created.
	CustomerEncryptionKeyId *string

	// A list of strings that specify why the evaluation job failed to create.
	FailureMessages []string

	// The description of the evaluation job.
	JobDescription *string

	// The time the evaluation job was last modified.
	LastModifiedTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFoundationModelInput 

type GetFoundationModelInput struct {

	// The model identifier.
	//
	// This member is required.
	ModelIdentifier *string
	// contains filtered or unexported fields
}

type GetFoundationModelOutput 

type GetFoundationModelOutput struct {

	// Information about the foundation model.
	ModelDetails *types.FoundationModelDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGuardrailInput added in v1.8.0 

type GetGuardrailInput struct {

	// The unique identifier of the guardrail for which to get details. This can be an
	// ID or the ARN.
	//
	// This member is required.
	GuardrailIdentifier *string

	// The version of the guardrail for which to get details. If you don't specify a
	// version, the response returns details for the DRAFT version.
	GuardrailVersion *string
	// contains filtered or unexported fields
}

type GetGuardrailOutput added in v1.8.0 

type GetGuardrailOutput struct {

	// The message that the guardrail returns when it blocks a prompt.
	//
	// This member is required.
	BlockedInputMessaging *string

	// The message that the guardrail returns when it blocks a model response.
	//
	// This member is required.
	BlockedOutputsMessaging *string

	// The date and time at which the guardrail was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The ARN of the guardrail.
	//
	// This member is required.
	GuardrailArn *string

	// The unique identifier of the guardrail.
	//
	// This member is required.
	GuardrailId *string

	// The name of the guardrail.
	//
	// This member is required.
	Name *string

	// The status of the guardrail.
	//
	// This member is required.
	Status types.GuardrailStatus

	// The date and time at which the guardrail was updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The version of the guardrail.
	//
	// This member is required.
	Version *string

	// The content policy that was configured for the guardrail.
	ContentPolicy *types.GuardrailContentPolicy

	// The contextual grounding policy used in the guardrail.
	ContextualGroundingPolicy *types.GuardrailContextualGroundingPolicy

	// The description of the guardrail.
	Description *string

	// Appears if the status of the guardrail is FAILED . A list of recommendations to
	// carry out before retrying the request.
	FailureRecommendations []string

	// The ARN of the KMS key that encrypts the guardrail.
	KmsKeyArn *string

	// The sensitive information policy that was configured for the guardrail.
	SensitiveInformationPolicy *types.GuardrailSensitiveInformationPolicy

	// Appears if the status is FAILED . A list of reasons for why the guardrail failed
	// to be created, updated, versioned, or deleted.
	StatusReasons []string

	// The topic policy that was configured for the guardrail.
	TopicPolicy *types.GuardrailTopicPolicy

	// The word policy that was configured for the guardrail.
	WordPolicy *types.GuardrailWordPolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetImportedModelInput added in v1.15.0 

type GetImportedModelInput struct {

	// Name or Amazon Resource Name (ARN) of the imported model.
	//
	// This member is required.
	ModelIdentifier *string
	// contains filtered or unexported fields
}

type GetImportedModelOutput added in v1.15.0 

type GetImportedModelOutput struct {

	// Creation time of the imported model.
	CreationTime *time.Time

	// Specifies if the imported model supports converse.
	InstructSupported *bool

	// Job Amazon Resource Name (ARN) associated with the imported model.
	JobArn *string

	// Job name associated with the imported model.
	JobName *string

	// The architecture of the imported model.
	ModelArchitecture *string

	// The Amazon Resource Name (ARN) associated with this imported model.
	ModelArn *string

	// The data source for this imported model.
	ModelDataSource types.ModelDataSource

	// The imported model is encrypted at rest using this key.
	ModelKmsKeyArn *string

	// The name of the imported model.
	ModelName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetInferenceProfileInput added in v1.16.0 

type GetInferenceProfileInput struct {

	// The ID or Amazon Resource Name (ARN) of the inference profile.
	//
	// This member is required.
	InferenceProfileIdentifier *string
	// contains filtered or unexported fields
}

type GetInferenceProfileOutput added in v1.16.0 

type GetInferenceProfileOutput struct {

	// The Amazon Resource Name (ARN) of the inference profile.
	//
	// This member is required.
	InferenceProfileArn *string

	// The unique identifier of the inference profile.
	//
	// This member is required.
	InferenceProfileId *string

	// The name of the inference profile.
	//
	// This member is required.
	InferenceProfileName *string

	// A list of information about each model in the inference profile.
	//
	// This member is required.
	Models []types.InferenceProfileModel

	// The status of the inference profile. ACTIVE means that the inference profile is
	// ready to be used.
	//
	// This member is required.
	Status types.InferenceProfileStatus

	// 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.
	//
	// This member is required.
	Type types.InferenceProfileType

	// The time at which the inference profile was created.
	CreatedAt *time.Time

	// The description of the inference profile.
	Description *string

	// The time at which the inference profile was last updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMarketplaceModelEndpointInput added in v1.25.0 

type GetMarketplaceModelEndpointInput struct {

	// The Amazon Resource Name (ARN) of the endpoint you want to get information
	// about.
	//
	// This member is required.
	EndpointArn *string
	// contains filtered or unexported fields
}

type GetMarketplaceModelEndpointOutput added in v1.25.0 

type GetMarketplaceModelEndpointOutput struct {

	// Details about the requested endpoint.
	MarketplaceModelEndpoint *types.MarketplaceModelEndpoint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetModelCopyJobInput added in v1.13.0 

type GetModelCopyJobInput struct {

	// The Amazon Resource Name (ARN) of the model copy job.
	//
	// This member is required.
	JobArn *string
	// contains filtered or unexported fields
}

type GetModelCopyJobOutput added in v1.13.0 

type GetModelCopyJobOutput struct {

	// The time at which the model copy job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the model copy job.
	//
	// This member is required.
	JobArn *string

	// The unique identifier of the account that the model being copied originated
	// from.
	//
	// This member is required.
	SourceAccountId *string

	// The Amazon Resource Name (ARN) of the original model being copied.
	//
	// This member is required.
	SourceModelArn *string

	// The status of the model copy job.
	//
	// This member is required.
	Status types.ModelCopyJobStatus

	// The Amazon Resource Name (ARN) of the copied model.
	//
	// This member is required.
	TargetModelArn *string

	// An error message for why the model copy job failed.
	FailureMessage *string

	// The name of the original model being copied.
	SourceModelName *string

	// The Amazon Resource Name (ARN) of the KMS key encrypting the copied model.
	TargetModelKmsKeyArn *string

	// The name of the copied model.
	TargetModelName *string

	// The tags associated with the copied model.
	TargetModelTags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetModelCustomizationJobInput 

type GetModelCustomizationJobInput struct {

	// Identifier for the customization job.
	//
	// This member is required.
	JobIdentifier *string
	// contains filtered or unexported fields
}

type GetModelCustomizationJobOutput 

type GetModelCustomizationJobOutput struct {

	// Amazon Resource Name (ARN) of the base model.
	//
	// This member is required.
	BaseModelArn *string

	// Time that the resource was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the customization job.
	//
	// This member is required.
	JobArn *string

	// The name of the customization job.
	//
	// This member is required.
	JobName *string

	// Output data configuration
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// The name of the output model.
	//
	// This member is required.
	OutputModelName *string

	// The Amazon Resource Name (ARN) of the IAM role.
	//
	// This member is required.
	RoleArn *string

	// Contains information about the training dataset.
	//
	// This member is required.
	TrainingDataConfig *types.TrainingDataConfig

	// Contains information about the validation dataset.
	//
	// This member is required.
	ValidationDataConfig *types.ValidationDataConfig

	// The token that you specified in the CreateCustomizationJob request.
	ClientRequestToken *string

	// The customization configuration for the model customization job.
	CustomizationConfig types.CustomizationConfig

	// The type of model customization.
	CustomizationType types.CustomizationType

	// Time that the resource transitioned to terminal state.
	EndTime *time.Time

	// Information about why the job failed.
	FailureMessage *string

	// The hyperparameter values for the job. For details on the format for different
	// models, see [Custom model hyperparameters].
	//
	// [Custom model hyperparameters]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html
	HyperParameters map[string]string

	// Time that the resource was last modified.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the output model.
	OutputModelArn *string

	// The custom model is encrypted at rest using this key.
	OutputModelKmsKeyArn *string

	// The status of the job. A successful job transitions from in-progress to
	// completed when the output model is ready to use. If the job failed, the failure
	// message contains information about why the job failed.
	Status types.ModelCustomizationJobStatus

	// Contains training metrics from the job creation.
	TrainingMetrics *types.TrainingMetrics

	// The loss metric for each validator that you provided in the createjob request.
	ValidationMetrics []types.ValidatorMetric

	// VPC configuration for the custom model job.
	VpcConfig *types.VpcConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetModelImportJobInput added in v1.15.0 

type GetModelImportJobInput struct {

	// The identifier of the import job.
	//
	// This member is required.
	JobIdentifier *string
	// contains filtered or unexported fields
}

type GetModelImportJobOutput added in v1.15.0 

type GetModelImportJobOutput struct {

	// The time the resource was created.
	CreationTime *time.Time

	// Time that the resource transitioned to terminal state.
	EndTime *time.Time

	// Information about why the import job failed.
	FailureMessage *string

	// The Amazon Resource Name (ARN) of the imported model.
	ImportedModelArn *string

	// The imported model is encrypted at rest using this key.
	ImportedModelKmsKeyArn *string

	// The name of the imported model.
	ImportedModelName *string

	// The Amazon Resource Name (ARN) of the import job.
	JobArn *string

	// The name of the import job.
	JobName *string

	// Time the resource was last modified.
	LastModifiedTime *time.Time

	// The data source for the imported model.
	ModelDataSource types.ModelDataSource

	// The Amazon Resource Name (ARN) of the IAM role associated with this job.
	RoleArn *string

	// The status of the job. A successful job transitions from in-progress to
	// completed when the imported model is ready to use. If the job failed, the
	// failure message contains information about why the job failed.
	Status types.ModelImportJobStatus

	// The Virtual Private Cloud (VPC) configuration of the import model job.
	VpcConfig *types.VpcConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetModelInvocationJobInput added in v1.14.0 

type GetModelInvocationJobInput struct {

	// The Amazon Resource Name (ARN) of the batch inference job.
	//
	// This member is required.
	JobIdentifier *string
	// contains filtered or unexported fields
}

type GetModelInvocationJobOutput added in v1.14.0 

type GetModelInvocationJobOutput struct {

	// Details about the location of the input to the batch inference job.
	//
	// This member is required.
	InputDataConfig types.ModelInvocationJobInputDataConfig

	// The Amazon Resource Name (ARN) of the batch inference job.
	//
	// This member is required.
	JobArn *string

	// The unique identifier of the foundation model used for model inference.
	//
	// This member is required.
	ModelId *string

	// Details about the location of the output of the batch inference job.
	//
	// This member is required.
	OutputDataConfig types.ModelInvocationJobOutputDataConfig

	// The Amazon Resource Name (ARN) of the service role with permissions to carry
	// out and manage batch inference. You can use the console to create a default
	// service role or follow the steps at [Create a service role for batch inference].
	//
	// [Create a service role for batch inference]: https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html
	//
	// This member is required.
	RoleArn *string

	// The time at which the batch inference job was submitted.
	//
	// This member is required.
	SubmitTime *time.Time

	// A unique, case-sensitive identifier to ensure that the API request completes no
	// more than one time. If this token matches a previous request, Amazon Bedrock
	// ignores the request, but does not return an error. For more information, see [Ensuring idempotency].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientRequestToken *string

	// The time at which the batch inference job ended.
	EndTime *time.Time

	// The time at which the batch inference job times or timed out.
	JobExpirationTime *time.Time

	// The name of the batch inference job.
	JobName *string

	// The time at which the batch inference job was last modified.
	LastModifiedTime *time.Time

	// If the batch inference job failed, this field contains a message describing why
	// the job failed.
	Message *string

	// The status of the batch inference job.
	//
	// The following statuses are possible:
	//
	//   - Submitted – This job has been submitted to a queue for validation.
	//
	//   - Validating – This job is being validated for the requirements described in [Format and upload your batch inference data]
	//   . The criteria include the following:
	//
	//   - Your IAM service role has access to the Amazon S3 buckets containing your
	//   files.
	//
	//   - Your files are .jsonl files and each individual record is a JSON object in
	//   the correct format. Note that validation doesn't check if the modelInput value
	//   matches the request body for the model.
	//
	//   - Your files fulfill the requirements for file size and number of records.
	//   For more information, see [Quotas for Amazon Bedrock].
	//
	//   - Scheduled – This job has been validated and is now in a queue. The job will
	//   automatically start when it reaches its turn.
	//
	//   - Expired – This job timed out because it was scheduled but didn't begin
	//   before the set timeout duration. Submit a new job request.
	//
	//   - InProgress – This job has begun. You can start viewing the results in the
	//   output S3 location.
	//
	//   - Completed – This job has successfully completed. View the output files in
	//   the output S3 location.
	//
	//   - PartiallyCompleted – This job has partially completed. Not all of your
	//   records could be processed in time. View the output files in the output S3
	//   location.
	//
	//   - Failed – This job has failed. Check the failure message for any further
	//   details. For further assistance, reach out to the [Amazon Web Services Support Center].
	//
	//   - Stopped – This job was stopped by a user.
	//
	//   - Stopping – This job is being stopped by a user.
	//
	// [Format and upload your batch inference data]: https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html
	// [Quotas for Amazon Bedrock]: https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html
	// [Amazon Web Services Support Center]: https://console.aws.amazon.com/support/home/
	Status types.ModelInvocationJobStatus

	// The number of hours after which batch inference job was set to time out.
	TimeoutDurationInHours *int32

	// The configuration of the Virtual Private Cloud (VPC) for the data in the batch
	// inference job. For more information, see [Protect batch inference jobs using a VPC].
	//
	// [Protect batch inference jobs using a VPC]: https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc
	VpcConfig *types.VpcConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetModelInvocationLoggingConfigurationInput 

type GetModelInvocationLoggingConfigurationInput struct {
	// contains filtered or unexported fields
}

type GetModelInvocationLoggingConfigurationOutput 

type GetModelInvocationLoggingConfigurationOutput struct {

	// The current configuration values.
	LoggingConfig *types.LoggingConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPromptRouterInput added in v1.25.0 

type GetPromptRouterInput struct {

	// The prompt router's ARN
	//
	// This member is required.
	PromptRouterArn *string
	// contains filtered or unexported fields
}

type GetPromptRouterOutput added in v1.25.0 

type GetPromptRouterOutput struct {

	// The router's fallback model.
	//
	// This member is required.
	FallbackModel *types.PromptRouterTargetModel

	// The router's models.
	//
	// This member is required.
	Models []types.PromptRouterTargetModel

	// The prompt router's ARN
	//
	// This member is required.
	PromptRouterArn *string

	// The router's name.
	//
	// This member is required.
	PromptRouterName *string

	// The router's routing criteria.
	//
	// This member is required.
	RoutingCriteria *types.RoutingCriteria

	// The router's status.
	//
	// This member is required.
	Status types.PromptRouterStatus

	// The router's type.
	//
	// This member is required.
	Type types.PromptRouterType

	// When the router was created.
	CreatedAt *time.Time

	// The router's description.
	Description *string

	// When the router was updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetProvisionedModelThroughputInput added in v1.1.0 

type GetProvisionedModelThroughputInput struct {

	// The Amazon Resource Name (ARN) or name of the Provisioned Throughput.
	//
	// This member is required.
	ProvisionedModelId *string
	// contains filtered or unexported fields
}

type GetProvisionedModelThroughputOutput added in v1.1.0 

type GetProvisionedModelThroughputOutput struct {

	// The timestamp of the creation time for this Provisioned Throughput.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the model requested to be associated to this
	// Provisioned Throughput. This value differs from the modelArn if updating hasn't
	// completed.
	//
	// This member is required.
	DesiredModelArn *string

	// The number of model units that was requested for this Provisioned Throughput.
	//
	// This member is required.
	DesiredModelUnits *int32

	// The Amazon Resource Name (ARN) of the base model for which the Provisioned
	// Throughput was created, or of the base model that the custom model for which the
	// Provisioned Throughput was created was customized.
	//
	// This member is required.
	FoundationModelArn *string

	// The timestamp of the last time that this Provisioned Throughput was modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the model associated with this Provisioned
	// Throughput.
	//
	// This member is required.
	ModelArn *string

	// The number of model units allocated to this Provisioned Throughput.
	//
	// This member is required.
	ModelUnits *int32

	// The Amazon Resource Name (ARN) of the Provisioned Throughput.
	//
	// This member is required.
	ProvisionedModelArn *string

	// The name of the Provisioned Throughput.
	//
	// This member is required.
	ProvisionedModelName *string

	// The status of the Provisioned Throughput.
	//
	// This member is required.
	Status types.ProvisionedModelStatus

	// Commitment duration of the Provisioned Throughput.
	CommitmentDuration types.CommitmentDuration

	// The timestamp for when the commitment term for the Provisioned Throughput
	// expires.
	CommitmentExpirationTime *time.Time

	// A failure message for any issues that occurred during creation, updating, or
	// deletion of the Provisioned Throughput.
	FailureMessage *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListCustomModelsAPIClient 

type ListCustomModelsAPIClient interface {
	ListCustomModels(context.Context, *ListCustomModelsInput, ...func(*Options)) (*ListCustomModelsOutput, error)
}

ListCustomModelsAPIClient is a client that implements the ListCustomModels operation.

type ListCustomModelsInput 

type ListCustomModelsInput struct {

	// Return custom models only if the base model Amazon Resource Name (ARN) matches
	// this parameter.
	BaseModelArnEquals *string

	// Return custom models created after the specified time.
	CreationTimeAfter *time.Time

	// Return custom models created before the specified time.
	CreationTimeBefore *time.Time

	// Return custom models only if the foundation model Amazon Resource Name (ARN)
	// matches this parameter.
	FoundationModelArnEquals *string

	// Return custom models depending on if the current account owns them ( true ) or
	// if they were shared with the current account ( false ).
	IsOwned *bool

	// 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.
	MaxResults *int32

	// Return custom models only if the job name contains these characters.
	NameContains *string

	// 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.
	NextToken *string

	// The field to sort by in the returned list of models.
	SortBy types.SortModelsBy

	// The sort order of the results.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListCustomModelsOutput 

type ListCustomModelsOutput struct {

	// Model summaries.
	ModelSummaries []types.CustomModelSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCustomModelsPaginator 

type ListCustomModelsPaginator struct {
	// contains filtered or unexported fields
}

ListCustomModelsPaginator is a paginator for ListCustomModels

func NewListCustomModelsPaginator 

func NewListCustomModelsPaginator(client ListCustomModelsAPIClient, params *ListCustomModelsInput, optFns ...func(*ListCustomModelsPaginatorOptions)) *ListCustomModelsPaginator

NewListCustomModelsPaginator returns a new ListCustomModelsPaginator

func (*ListCustomModelsPaginator) HasMorePages 

func (p *ListCustomModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomModelsPaginator) NextPage 

func (p *ListCustomModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomModelsOutput, error)

NextPage retrieves the next ListCustomModels page.

type ListCustomModelsPaginatorOptions 

type ListCustomModelsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCustomModelsPaginatorOptions is the paginator options for ListCustomModels

type ListEvaluationJobsAPIClient added in v1.8.0 

type ListEvaluationJobsAPIClient interface {
	ListEvaluationJobs(context.Context, *ListEvaluationJobsInput, ...func(*Options)) (*ListEvaluationJobsOutput, error)
}

ListEvaluationJobsAPIClient is a client that implements the ListEvaluationJobs operation.

type ListEvaluationJobsInput added in v1.8.0 

type ListEvaluationJobsInput struct {

	// A filter to only list evaluation jobs that are either model evaluations or
	// knowledge base evaluations.
	ApplicationTypeEquals types.ApplicationType

	// A filter to only list evaluation jobs created after a specified time.
	CreationTimeAfter *time.Time

	// A filter to only list evaluation jobs created before a specified time.
	CreationTimeBefore *time.Time

	// The maximum number of results to return.
	MaxResults *int32

	// A filter to only list evaluation jobs that contain a specified string in the
	// job name.
	NameContains *string

	// Continuation token from the previous response, for Amazon Bedrock to list the
	// next set of results.
	NextToken *string

	// Specifies a creation time to sort the list of evaluation jobs by when they were
	// created.
	SortBy types.SortJobsBy

	// Specifies whether to sort the list of evaluation jobs by either ascending or
	// descending order.
	SortOrder types.SortOrder

	// A filter to only list evaluation jobs that are of a certain status.
	StatusEquals types.EvaluationJobStatus
	// contains filtered or unexported fields
}

type ListEvaluationJobsOutput added in v1.8.0 

type ListEvaluationJobsOutput struct {

	// A list of summaries of the evaluation jobs.
	JobSummaries []types.EvaluationSummary

	// Continuation token from the previous response, for Amazon Bedrock to list the
	// next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEvaluationJobsPaginator added in v1.8.0 

type ListEvaluationJobsPaginator struct {
	// contains filtered or unexported fields
}

ListEvaluationJobsPaginator is a paginator for ListEvaluationJobs

func NewListEvaluationJobsPaginator added in v1.8.0 

func NewListEvaluationJobsPaginator(client ListEvaluationJobsAPIClient, params *ListEvaluationJobsInput, optFns ...func(*ListEvaluationJobsPaginatorOptions)) *ListEvaluationJobsPaginator

NewListEvaluationJobsPaginator returns a new ListEvaluationJobsPaginator

func (*ListEvaluationJobsPaginator) HasMorePages added in v1.8.0 

func (p *ListEvaluationJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEvaluationJobsPaginator) NextPage added in v1.8.0 

func (p *ListEvaluationJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEvaluationJobsOutput, error)

NextPage retrieves the next ListEvaluationJobs page.

type ListEvaluationJobsPaginatorOptions added in v1.8.0 

type ListEvaluationJobsPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEvaluationJobsPaginatorOptions is the paginator options for ListEvaluationJobs

type ListFoundationModelsInput 

type ListFoundationModelsInput struct {

	// Return models that support the customization type that you specify. For more
	// information, see [Custom models]in the [Amazon Bedrock User Guide].
	//
	// [Custom models]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html
	// [Amazon Bedrock User Guide]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
	ByCustomizationType types.ModelCustomization

	// Return models that support the inference type that you specify. For more
	// information, see [Provisioned Throughput]in the [Amazon Bedrock User Guide].
	//
	// [Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html
	// [Amazon Bedrock User Guide]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
	ByInferenceType types.InferenceType

	// Return models that support the output modality that you specify.
	ByOutputModality types.ModelModality

	// Return models belonging to the model provider that you specify.
	ByProvider *string
	// contains filtered or unexported fields
}

type ListFoundationModelsOutput 

type ListFoundationModelsOutput struct {

	// A list of Amazon Bedrock foundation models.
	ModelSummaries []types.FoundationModelSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGuardrailsAPIClient added in v1.8.0 

type ListGuardrailsAPIClient interface {
	ListGuardrails(context.Context, *ListGuardrailsInput, ...func(*Options)) (*ListGuardrailsOutput, error)
}

ListGuardrailsAPIClient is a client that implements the ListGuardrails operation.

type ListGuardrailsInput added in v1.8.0 

type ListGuardrailsInput struct {

	// The unique identifier of the guardrail. This can be an ID or the ARN.
	GuardrailIdentifier *string

	// The maximum number of results to return in the response.
	MaxResults *int32

	// If there are more results than were returned in the response, the response
	// returns a nextToken that you can send in another ListGuardrails request to see
	// the next batch of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGuardrailsOutput added in v1.8.0 

type ListGuardrailsOutput struct {

	// A list of objects, each of which contains details about a guardrail.
	//
	// This member is required.
	Guardrails []types.GuardrailSummary

	// If there are more results than were returned in the response, the response
	// returns a nextToken that you can send in another ListGuardrails request to see
	// the next batch of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGuardrailsPaginator added in v1.8.0 

type ListGuardrailsPaginator struct {
	// contains filtered or unexported fields
}

ListGuardrailsPaginator is a paginator for ListGuardrails

func NewListGuardrailsPaginator added in v1.8.0 

func NewListGuardrailsPaginator(client ListGuardrailsAPIClient, params *ListGuardrailsInput, optFns ...func(*ListGuardrailsPaginatorOptions)) *ListGuardrailsPaginator

NewListGuardrailsPaginator returns a new ListGuardrailsPaginator

func (*ListGuardrailsPaginator) HasMorePages added in v1.8.0 

func (p *ListGuardrailsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGuardrailsPaginator) NextPage added in v1.8.0 

func (p *ListGuardrailsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGuardrailsOutput, error)

NextPage retrieves the next ListGuardrails page.

type ListGuardrailsPaginatorOptions added in v1.8.0 

type ListGuardrailsPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGuardrailsPaginatorOptions is the paginator options for ListGuardrails

type ListImportedModelsAPIClient added in v1.15.0 

type ListImportedModelsAPIClient interface {
	ListImportedModels(context.Context, *ListImportedModelsInput, ...func(*Options)) (*ListImportedModelsOutput, error)
}

ListImportedModelsAPIClient is a client that implements the ListImportedModels operation.

type ListImportedModelsInput added in v1.15.0 

type ListImportedModelsInput struct {

	// Return imported models that were created after the specified time.
	CreationTimeAfter *time.Time

	// Return imported models that created before the specified time.
	CreationTimeBefore *time.Time

	// 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.
	MaxResults *int32

	// Return imported models only if the model name contains these characters.
	NameContains *string

	// 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.
	NextToken *string

	// The field to sort by in the returned list of imported models.
	SortBy types.SortModelsBy

	// Specifies whetehr to sort the results in ascending or descending order.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListImportedModelsOutput added in v1.15.0 

type ListImportedModelsOutput struct {

	// Model summaries.
	ModelSummaries []types.ImportedModelSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImportedModelsPaginator added in v1.15.0 

type ListImportedModelsPaginator struct {
	// contains filtered or unexported fields
}

ListImportedModelsPaginator is a paginator for ListImportedModels

func NewListImportedModelsPaginator added in v1.15.0 

func NewListImportedModelsPaginator(client ListImportedModelsAPIClient, params *ListImportedModelsInput, optFns ...func(*ListImportedModelsPaginatorOptions)) *ListImportedModelsPaginator

NewListImportedModelsPaginator returns a new ListImportedModelsPaginator

func (*ListImportedModelsPaginator) HasMorePages added in v1.15.0 

func (p *ListImportedModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImportedModelsPaginator) NextPage added in v1.15.0 

func (p *ListImportedModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImportedModelsOutput, error)

NextPage retrieves the next ListImportedModels page.

type ListImportedModelsPaginatorOptions added in v1.15.0 

type ListImportedModelsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImportedModelsPaginatorOptions is the paginator options for ListImportedModels

type ListInferenceProfilesAPIClient added in v1.16.0 

type ListInferenceProfilesAPIClient interface {
	ListInferenceProfiles(context.Context, *ListInferenceProfilesInput, ...func(*Options)) (*ListInferenceProfilesOutput, error)
}

ListInferenceProfilesAPIClient is a client that implements the ListInferenceProfiles operation.

type ListInferenceProfilesInput added in v1.16.0 

type ListInferenceProfilesInput struct {

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string

	// 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.
	TypeEquals types.InferenceProfileType
	// contains filtered or unexported fields
}

type ListInferenceProfilesOutput added in v1.16.0 

type ListInferenceProfilesOutput struct {

	// A list of information about each inference profile that you can use.
	InferenceProfileSummaries []types.InferenceProfileSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListInferenceProfilesPaginator added in v1.16.0 

type ListInferenceProfilesPaginator struct {
	// contains filtered or unexported fields
}

ListInferenceProfilesPaginator is a paginator for ListInferenceProfiles

func NewListInferenceProfilesPaginator added in v1.16.0 

func NewListInferenceProfilesPaginator(client ListInferenceProfilesAPIClient, params *ListInferenceProfilesInput, optFns ...func(*ListInferenceProfilesPaginatorOptions)) *ListInferenceProfilesPaginator

NewListInferenceProfilesPaginator returns a new ListInferenceProfilesPaginator

func (*ListInferenceProfilesPaginator) HasMorePages added in v1.16.0 

func (p *ListInferenceProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInferenceProfilesPaginator) NextPage added in v1.16.0 

func (p *ListInferenceProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInferenceProfilesOutput, error)

NextPage retrieves the next ListInferenceProfiles page.

type ListInferenceProfilesPaginatorOptions added in v1.16.0 

type ListInferenceProfilesPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListInferenceProfilesPaginatorOptions is the paginator options for ListInferenceProfiles

type ListMarketplaceModelEndpointsAPIClient added in v1.25.0 

type ListMarketplaceModelEndpointsAPIClient interface {
	ListMarketplaceModelEndpoints(context.Context, *ListMarketplaceModelEndpointsInput, ...func(*Options)) (*ListMarketplaceModelEndpointsOutput, error)
}

ListMarketplaceModelEndpointsAPIClient is a client that implements the ListMarketplaceModelEndpoints operation.

type ListMarketplaceModelEndpointsInput added in v1.25.0 

type ListMarketplaceModelEndpointsInput struct {

	// The maximum number of results to return in a single call. If more results are
	// available, the operation returns a NextToken value.
	MaxResults *int32

	// If specified, only endpoints for the given model source identifier are returned.
	ModelSourceEquals *string

	// The token for the next set of results. You receive this token from a previous
	// ListMarketplaceModelEndpoints call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMarketplaceModelEndpointsOutput added in v1.25.0 

type ListMarketplaceModelEndpointsOutput struct {

	// An array of endpoint summaries.
	MarketplaceModelEndpoints []types.MarketplaceModelEndpointSummary

	// The token for the next set of results. Use this token to get the next set of
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMarketplaceModelEndpointsPaginator added in v1.25.0 

type ListMarketplaceModelEndpointsPaginator struct {
	// contains filtered or unexported fields
}

ListMarketplaceModelEndpointsPaginator is a paginator for ListMarketplaceModelEndpoints

func NewListMarketplaceModelEndpointsPaginator added in v1.25.0 

func NewListMarketplaceModelEndpointsPaginator(client ListMarketplaceModelEndpointsAPIClient, params *ListMarketplaceModelEndpointsInput, optFns ...func(*ListMarketplaceModelEndpointsPaginatorOptions)) *ListMarketplaceModelEndpointsPaginator

NewListMarketplaceModelEndpointsPaginator returns a new ListMarketplaceModelEndpointsPaginator

func (*ListMarketplaceModelEndpointsPaginator) HasMorePages added in v1.25.0 

func (p *ListMarketplaceModelEndpointsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMarketplaceModelEndpointsPaginator) NextPage added in v1.25.0 

func (p *ListMarketplaceModelEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMarketplaceModelEndpointsOutput, error)

NextPage retrieves the next ListMarketplaceModelEndpoints page.

type ListMarketplaceModelEndpointsPaginatorOptions added in v1.25.0 

type ListMarketplaceModelEndpointsPaginatorOptions struct {
	// The maximum number of results to return in a single call. If more results are
	// available, the operation returns a NextToken value.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMarketplaceModelEndpointsPaginatorOptions is the paginator options for ListMarketplaceModelEndpoints

type ListModelCopyJobsAPIClient added in v1.13.0 

type ListModelCopyJobsAPIClient interface {
	ListModelCopyJobs(context.Context, *ListModelCopyJobsInput, ...func(*Options)) (*ListModelCopyJobsOutput, error)
}

ListModelCopyJobsAPIClient is a client that implements the ListModelCopyJobs operation.

type ListModelCopyJobsInput added in v1.13.0 

type ListModelCopyJobsInput struct {

	// Filters for model copy jobs created after the specified time.
	CreationTimeAfter *time.Time

	// Filters for model copy jobs created before the specified time.
	CreationTimeBefore *time.Time

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string

	// The field to sort by in the returned list of model copy jobs.
	SortBy types.SortJobsBy

	// Specifies whether to sort the results in ascending or descending order.
	SortOrder types.SortOrder

	// Filters for model copy jobs in which the account that the source model belongs
	// to is equal to the value that you specify.
	SourceAccountEquals *string

	// Filters for model copy jobs in which the Amazon Resource Name (ARN) of the
	// source model to is equal to the value that you specify.
	SourceModelArnEquals *string

	// Filters for model copy jobs whose status matches the value that you specify.
	StatusEquals types.ModelCopyJobStatus

	// Filters for model copy jobs in which the name of the copied model contains the
	// string that you specify.
	TargetModelNameContains *string
	// contains filtered or unexported fields
}

type ListModelCopyJobsOutput added in v1.13.0 

type ListModelCopyJobsOutput struct {

	// A list of information about each model copy job.
	ModelCopyJobSummaries []types.ModelCopyJobSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListModelCopyJobsPaginator added in v1.13.0 

type ListModelCopyJobsPaginator struct {
	// contains filtered or unexported fields
}

ListModelCopyJobsPaginator is a paginator for ListModelCopyJobs

func NewListModelCopyJobsPaginator added in v1.13.0 

func NewListModelCopyJobsPaginator(client ListModelCopyJobsAPIClient, params *ListModelCopyJobsInput, optFns ...func(*ListModelCopyJobsPaginatorOptions)) *ListModelCopyJobsPaginator

NewListModelCopyJobsPaginator returns a new ListModelCopyJobsPaginator

func (*ListModelCopyJobsPaginator) HasMorePages added in v1.13.0 

func (p *ListModelCopyJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelCopyJobsPaginator) NextPage added in v1.13.0 

func (p *ListModelCopyJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelCopyJobsOutput, error)

NextPage retrieves the next ListModelCopyJobs page.

type ListModelCopyJobsPaginatorOptions added in v1.13.0 

type ListModelCopyJobsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListModelCopyJobsPaginatorOptions is the paginator options for ListModelCopyJobs

type ListModelCustomizationJobsAPIClient 

type ListModelCustomizationJobsAPIClient interface {
	ListModelCustomizationJobs(context.Context, *ListModelCustomizationJobsInput, ...func(*Options)) (*ListModelCustomizationJobsOutput, error)
}

ListModelCustomizationJobsAPIClient is a client that implements the ListModelCustomizationJobs operation.

type ListModelCustomizationJobsInput 

type ListModelCustomizationJobsInput struct {

	// Return customization jobs created after the specified time.
	CreationTimeAfter *time.Time

	// Return customization jobs created before the specified time.
	CreationTimeBefore *time.Time

	// 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.
	MaxResults *int32

	// Return customization jobs only if the job name contains these characters.
	NameContains *string

	// 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.
	NextToken *string

	// The field to sort by in the returned list of jobs.
	SortBy types.SortJobsBy

	// The sort order of the results.
	SortOrder types.SortOrder

	// Return customization jobs with the specified status.
	StatusEquals types.FineTuningJobStatus
	// contains filtered or unexported fields
}

type ListModelCustomizationJobsOutput 

type ListModelCustomizationJobsOutput struct {

	// Job summaries.
	ModelCustomizationJobSummaries []types.ModelCustomizationJobSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListModelCustomizationJobsPaginator 

type ListModelCustomizationJobsPaginator struct {
	// contains filtered or unexported fields
}

ListModelCustomizationJobsPaginator is a paginator for ListModelCustomizationJobs

func NewListModelCustomizationJobsPaginator 

func NewListModelCustomizationJobsPaginator(client ListModelCustomizationJobsAPIClient, params *ListModelCustomizationJobsInput, optFns ...func(*ListModelCustomizationJobsPaginatorOptions)) *ListModelCustomizationJobsPaginator

NewListModelCustomizationJobsPaginator returns a new ListModelCustomizationJobsPaginator

func (*ListModelCustomizationJobsPaginator) HasMorePages 

func (p *ListModelCustomizationJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelCustomizationJobsPaginator) NextPage 

func (p *ListModelCustomizationJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelCustomizationJobsOutput, error)

NextPage retrieves the next ListModelCustomizationJobs page.

type ListModelCustomizationJobsPaginatorOptions 

type ListModelCustomizationJobsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListModelCustomizationJobsPaginatorOptions is the paginator options for ListModelCustomizationJobs

type ListModelImportJobsAPIClient added in v1.15.0 

type ListModelImportJobsAPIClient interface {
	ListModelImportJobs(context.Context, *ListModelImportJobsInput, ...func(*Options)) (*ListModelImportJobsOutput, error)
}

ListModelImportJobsAPIClient is a client that implements the ListModelImportJobs operation.

type ListModelImportJobsInput added in v1.15.0 

type ListModelImportJobsInput struct {

	// Return import jobs that were created after the specified time.
	CreationTimeAfter *time.Time

	// Return import jobs that were created before the specified time.
	CreationTimeBefore *time.Time

	// 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.
	MaxResults *int32

	// Return imported jobs only if the job name contains these characters.
	NameContains *string

	// 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.
	NextToken *string

	// The field to sort by in the returned list of imported jobs.
	SortBy types.SortJobsBy

	// Specifies whether to sort the results in ascending or descending order.
	SortOrder types.SortOrder

	// Return imported jobs with the specified status.
	StatusEquals types.ModelImportJobStatus
	// contains filtered or unexported fields
}

type ListModelImportJobsOutput added in v1.15.0 

type ListModelImportJobsOutput struct {

	// Import job summaries.
	ModelImportJobSummaries []types.ModelImportJobSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListModelImportJobsPaginator added in v1.15.0 

type ListModelImportJobsPaginator struct {
	// contains filtered or unexported fields
}

ListModelImportJobsPaginator is a paginator for ListModelImportJobs

func NewListModelImportJobsPaginator added in v1.15.0 

func NewListModelImportJobsPaginator(client ListModelImportJobsAPIClient, params *ListModelImportJobsInput, optFns ...func(*ListModelImportJobsPaginatorOptions)) *ListModelImportJobsPaginator

NewListModelImportJobsPaginator returns a new ListModelImportJobsPaginator

func (*ListModelImportJobsPaginator) HasMorePages added in v1.15.0 

func (p *ListModelImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelImportJobsPaginator) NextPage added in v1.15.0 

func (p *ListModelImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelImportJobsOutput, error)

NextPage retrieves the next ListModelImportJobs page.

type ListModelImportJobsPaginatorOptions added in v1.15.0 

type ListModelImportJobsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListModelImportJobsPaginatorOptions is the paginator options for ListModelImportJobs

type ListModelInvocationJobsAPIClient added in v1.14.0 

type ListModelInvocationJobsAPIClient interface {
	ListModelInvocationJobs(context.Context, *ListModelInvocationJobsInput, ...func(*Options)) (*ListModelInvocationJobsOutput, error)
}

ListModelInvocationJobsAPIClient is a client that implements the ListModelInvocationJobs operation.

type ListModelInvocationJobsInput added in v1.14.0 

type ListModelInvocationJobsInput struct {

	// The maximum number of results to return. If there are more results than the
	// number that you specify, a nextToken value is returned. Use the nextToken in a
	// request to return the next batch of results.
	MaxResults *int32

	// Specify a string to filter for batch inference jobs whose names contain the
	// string.
	NameContains *string

	// If there were more results than the value you specified in the maxResults field
	// in a previous ListModelInvocationJobs request, the response would have returned
	// a nextToken value. To see the next batch of results, send the nextToken value
	// in another request.
	NextToken *string

	// An attribute by which to sort the results.
	SortBy types.SortJobsBy

	// Specifies whether to sort the results by ascending or descending order.
	SortOrder types.SortOrder

	// Specify a status to filter for batch inference jobs whose statuses match the
	// string you specify.
	//
	// The following statuses are possible:
	//
	//   - Submitted – This job has been submitted to a queue for validation.
	//
	//   - Validating – This job is being validated for the requirements described in [Format and upload your batch inference data]
	//   . The criteria include the following:
	//
	//   - Your IAM service role has access to the Amazon S3 buckets containing your
	//   files.
	//
	//   - Your files are .jsonl files and each individual record is a JSON object in
	//   the correct format. Note that validation doesn't check if the modelInput value
	//   matches the request body for the model.
	//
	//   - Your files fulfill the requirements for file size and number of records.
	//   For more information, see [Quotas for Amazon Bedrock].
	//
	//   - Scheduled – This job has been validated and is now in a queue. The job will
	//   automatically start when it reaches its turn.
	//
	//   - Expired – This job timed out because it was scheduled but didn't begin
	//   before the set timeout duration. Submit a new job request.
	//
	//   - InProgress – This job has begun. You can start viewing the results in the
	//   output S3 location.
	//
	//   - Completed – This job has successfully completed. View the output files in
	//   the output S3 location.
	//
	//   - PartiallyCompleted – This job has partially completed. Not all of your
	//   records could be processed in time. View the output files in the output S3
	//   location.
	//
	//   - Failed – This job has failed. Check the failure message for any further
	//   details. For further assistance, reach out to the [Amazon Web Services Support Center].
	//
	//   - Stopped – This job was stopped by a user.
	//
	//   - Stopping – This job is being stopped by a user.
	//
	// [Format and upload your batch inference data]: https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html
	// [Quotas for Amazon Bedrock]: https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html
	// [Amazon Web Services Support Center]: https://console.aws.amazon.com/support/home/
	StatusEquals types.ModelInvocationJobStatus

	// Specify a time to filter for batch inference jobs that were submitted after the
	// time you specify.
	SubmitTimeAfter *time.Time

	// Specify a time to filter for batch inference jobs that were submitted before
	// the time you specify.
	SubmitTimeBefore *time.Time
	// contains filtered or unexported fields
}

type ListModelInvocationJobsOutput added in v1.14.0 

type ListModelInvocationJobsOutput struct {

	// A list of items, each of which contains a summary about a batch inference job.
	InvocationJobSummaries []types.ModelInvocationJobSummary

	// If there are more results than can fit in the response, a nextToken is
	// returned. Use the nextToken in a request to return the next batch of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListModelInvocationJobsPaginator added in v1.14.0 

type ListModelInvocationJobsPaginator struct {
	// contains filtered or unexported fields
}

ListModelInvocationJobsPaginator is a paginator for ListModelInvocationJobs

func NewListModelInvocationJobsPaginator added in v1.14.0 

func NewListModelInvocationJobsPaginator(client ListModelInvocationJobsAPIClient, params *ListModelInvocationJobsInput, optFns ...func(*ListModelInvocationJobsPaginatorOptions)) *ListModelInvocationJobsPaginator

NewListModelInvocationJobsPaginator returns a new ListModelInvocationJobsPaginator

func (*ListModelInvocationJobsPaginator) HasMorePages added in v1.14.0 

func (p *ListModelInvocationJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelInvocationJobsPaginator) NextPage added in v1.14.0 

func (p *ListModelInvocationJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelInvocationJobsOutput, error)

NextPage retrieves the next ListModelInvocationJobs page.

type ListModelInvocationJobsPaginatorOptions added in v1.14.0 

type ListModelInvocationJobsPaginatorOptions struct {
	// The maximum number of results to return. If there are more results than the
	// number that you specify, a nextToken value is returned. Use the nextToken in a
	// request to return the next batch of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListModelInvocationJobsPaginatorOptions is the paginator options for ListModelInvocationJobs

type ListPromptRoutersAPIClient added in v1.25.0 

type ListPromptRoutersAPIClient interface {
	ListPromptRouters(context.Context, *ListPromptRoutersInput, ...func(*Options)) (*ListPromptRoutersOutput, error)
}

ListPromptRoutersAPIClient is a client that implements the ListPromptRouters operation.

type ListPromptRoutersInput added in v1.25.0 

type ListPromptRoutersInput struct {

	// The maximum number of prompt routers to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPromptRoutersOutput added in v1.25.0 

type ListPromptRoutersOutput struct {

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string

	// A list of prompt router summaries.
	PromptRouterSummaries []types.PromptRouterSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPromptRoutersPaginator added in v1.25.0 

type ListPromptRoutersPaginator struct {
	// contains filtered or unexported fields
}

ListPromptRoutersPaginator is a paginator for ListPromptRouters

func NewListPromptRoutersPaginator added in v1.25.0 

func NewListPromptRoutersPaginator(client ListPromptRoutersAPIClient, params *ListPromptRoutersInput, optFns ...func(*ListPromptRoutersPaginatorOptions)) *ListPromptRoutersPaginator

NewListPromptRoutersPaginator returns a new ListPromptRoutersPaginator

func (*ListPromptRoutersPaginator) HasMorePages added in v1.25.0 

func (p *ListPromptRoutersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPromptRoutersPaginator) NextPage added in v1.25.0 

func (p *ListPromptRoutersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPromptRoutersOutput, error)

NextPage retrieves the next ListPromptRouters page.

type ListPromptRoutersPaginatorOptions added in v1.25.0 

type ListPromptRoutersPaginatorOptions struct {
	// The maximum number of prompt routers to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPromptRoutersPaginatorOptions is the paginator options for ListPromptRouters

type ListProvisionedModelThroughputsAPIClient added in v1.1.0 

type ListProvisionedModelThroughputsAPIClient interface {
	ListProvisionedModelThroughputs(context.Context, *ListProvisionedModelThroughputsInput, ...func(*Options)) (*ListProvisionedModelThroughputsOutput, error)
}

ListProvisionedModelThroughputsAPIClient is a client that implements the ListProvisionedModelThroughputs operation.

type ListProvisionedModelThroughputsInput added in v1.1.0 

type ListProvisionedModelThroughputsInput struct {

	// A filter that returns Provisioned Throughputs created after the specified time.
	CreationTimeAfter *time.Time

	// A filter that returns Provisioned Throughputs created before the specified
	// time.
	CreationTimeBefore *time.Time

	// THe maximum number of results to return in the response. If there are more
	// results than the number you specified, the response returns a nextToken value.
	// To see the next batch of results, send the nextToken value in another list
	// request.
	MaxResults *int32

	// A filter that returns Provisioned Throughputs whose model Amazon Resource Name
	// (ARN) is equal to the value that you specify.
	ModelArnEquals *string

	// A filter that returns Provisioned Throughputs if their name contains the
	// expression that you specify.
	NameContains *string

	// If there are more results than the number you specified in the maxResults
	// field, the response returns a nextToken value. To see the next batch of
	// results, specify the nextToken value in this field.
	NextToken *string

	// The field by which to sort the returned list of Provisioned Throughputs.
	SortBy types.SortByProvisionedModels

	// The sort order of the results.
	SortOrder types.SortOrder

	// A filter that returns Provisioned Throughputs if their statuses matches the
	// value that you specify.
	StatusEquals types.ProvisionedModelStatus
	// contains filtered or unexported fields
}

type ListProvisionedModelThroughputsOutput added in v1.1.0 

type ListProvisionedModelThroughputsOutput struct {

	// If there are more results than the number you specified in the maxResults
	// field, this value is returned. To see the next batch of results, include this
	// value in the nextToken field in another list request.
	NextToken *string

	// A list of summaries, one for each Provisioned Throughput in the response.
	ProvisionedModelSummaries []types.ProvisionedModelSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListProvisionedModelThroughputsPaginator added in v1.1.0 

type ListProvisionedModelThroughputsPaginator struct {
	// contains filtered or unexported fields
}

ListProvisionedModelThroughputsPaginator is a paginator for ListProvisionedModelThroughputs

func NewListProvisionedModelThroughputsPaginator added in v1.1.0 

func NewListProvisionedModelThroughputsPaginator(client ListProvisionedModelThroughputsAPIClient, params *ListProvisionedModelThroughputsInput, optFns ...func(*ListProvisionedModelThroughputsPaginatorOptions)) *ListProvisionedModelThroughputsPaginator

NewListProvisionedModelThroughputsPaginator returns a new ListProvisionedModelThroughputsPaginator

func (*ListProvisionedModelThroughputsPaginator) HasMorePages added in v1.1.0 

func (p *ListProvisionedModelThroughputsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProvisionedModelThroughputsPaginator) NextPage added in v1.1.0 

func (p *ListProvisionedModelThroughputsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProvisionedModelThroughputsOutput, error)

NextPage retrieves the next ListProvisionedModelThroughputs page.

type ListProvisionedModelThroughputsPaginatorOptions added in v1.1.0 

type ListProvisionedModelThroughputsPaginatorOptions struct {
	// THe maximum number of results to return in the response. If there are more
	// results than the number you specified, the response returns a nextToken value.
	// To see the next batch of results, send the nextToken value in another list
	// request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProvisionedModelThroughputsPaginatorOptions is the paginator options for ListProvisionedModelThroughputs

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceARN *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// An array of the tags associated with this resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.3.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutModelInvocationLoggingConfigurationInput 

type PutModelInvocationLoggingConfigurationInput struct {

	// The logging configuration values to set.
	//
	// This member is required.
	LoggingConfig *types.LoggingConfig
	// contains filtered or unexported fields
}

type PutModelInvocationLoggingConfigurationOutput 

type PutModelInvocationLoggingConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RegisterMarketplaceModelEndpointInput added in v1.25.0 

type RegisterMarketplaceModelEndpointInput struct {

	// The ARN of the Amazon SageMaker endpoint you want to register with Amazon
	// Bedrock Marketplace.
	//
	// This member is required.
	EndpointIdentifier *string

	// The ARN of the model from Amazon Bedrock Marketplace that is deployed on the
	// endpoint.
	//
	// This member is required.
	ModelSourceIdentifier *string
	// contains filtered or unexported fields
}

type RegisterMarketplaceModelEndpointOutput added in v1.25.0 

type RegisterMarketplaceModelEndpointOutput struct {

	// Details about the registered endpoint.
	//
	// This member is required.
	MarketplaceModelEndpoint *types.MarketplaceModelEndpoint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StopEvaluationJobInput added in v1.8.0 

type StopEvaluationJobInput struct {

	// The Amazon Resource Name (ARN) of the evaluation job you want to stop.
	//
	// This member is required.
	JobIdentifier *string
	// contains filtered or unexported fields
}

type StopEvaluationJobOutput added in v1.8.0 

type StopEvaluationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopModelCustomizationJobInput 

type StopModelCustomizationJobInput struct {

	// Job identifier of the job to stop.
	//
	// This member is required.
	JobIdentifier *string
	// contains filtered or unexported fields
}

type StopModelCustomizationJobOutput 

type StopModelCustomizationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopModelInvocationJobInput added in v1.14.0 

type StopModelInvocationJobInput struct {

	// The Amazon Resource Name (ARN) of the batch inference job to stop.
	//
	// This member is required.
	JobIdentifier *string
	// contains filtered or unexported fields
}

type StopModelInvocationJobOutput added in v1.14.0 

type StopModelInvocationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to tag.
	//
	// This member is required.
	ResourceARN *string

	// Tags to associate with the resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to untag.
	//
	// This member is required.
	ResourceARN *string

	// Tag keys of the tags to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateGuardrailInput added in v1.8.0 

type UpdateGuardrailInput struct {

	// The message to return when the guardrail blocks a prompt.
	//
	// This member is required.
	BlockedInputMessaging *string

	// The message to return when the guardrail blocks a model response.
	//
	// This member is required.
	BlockedOutputsMessaging *string

	// The unique identifier of the guardrail. This can be an ID or the ARN.
	//
	// This member is required.
	GuardrailIdentifier *string

	// A name for the guardrail.
	//
	// This member is required.
	Name *string

	// The content policy to configure for the guardrail.
	ContentPolicyConfig *types.GuardrailContentPolicyConfig

	// The contextual grounding policy configuration used to update a guardrail.
	ContextualGroundingPolicyConfig *types.GuardrailContextualGroundingPolicyConfig

	// A description of the guardrail.
	Description *string

	// The ARN of the KMS key with which to encrypt the guardrail.
	KmsKeyId *string

	// The sensitive information policy to configure for the guardrail.
	SensitiveInformationPolicyConfig *types.GuardrailSensitiveInformationPolicyConfig

	// The topic policy to configure for the guardrail.
	TopicPolicyConfig *types.GuardrailTopicPolicyConfig

	// The word policy to configure for the guardrail.
	WordPolicyConfig *types.GuardrailWordPolicyConfig
	// contains filtered or unexported fields
}

type UpdateGuardrailOutput added in v1.8.0 

type UpdateGuardrailOutput struct {

	// The ARN of the guardrail.
	//
	// This member is required.
	GuardrailArn *string

	// The unique identifier of the guardrail
	//
	// This member is required.
	GuardrailId *string

	// The date and time at which the guardrail was updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The version of the guardrail.
	//
	// This member is required.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMarketplaceModelEndpointInput added in v1.25.0 

type UpdateMarketplaceModelEndpointInput struct {

	// The Amazon Resource Name (ARN) of the endpoint you want to update.
	//
	// This member is required.
	EndpointArn *string

	// The new configuration for the endpoint, including the number and type of
	// instances to use.
	//
	// This member is required.
	EndpointConfig types.EndpointConfig

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. This token is listed as not required because Amazon Web Services
	// SDKs automatically generate it for you and set this parameter. If you're not
	// using the Amazon Web Services SDK or the CLI, you must provide this token or the
	// action will fail.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type UpdateMarketplaceModelEndpointOutput added in v1.25.0 

type UpdateMarketplaceModelEndpointOutput struct {

	// Details about the updated endpoint.
	//
	// This member is required.
	MarketplaceModelEndpoint *types.MarketplaceModelEndpoint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateProvisionedModelThroughputInput added in v1.1.0 

type UpdateProvisionedModelThroughputInput struct {

	// The Amazon Resource Name (ARN) or name of the Provisioned Throughput to update.
	//
	// This member is required.
	ProvisionedModelId *string

	// The Amazon Resource Name (ARN) of the new model to associate with this
	// Provisioned Throughput. You can't specify this field if this Provisioned
	// Throughput is associated with a base model.
	//
	// If this Provisioned Throughput is associated with a custom model, you can
	// specify one of the following options:
	//
	//   - The base model from which the custom model was customized.
	//
	//   - Another custom model that was customized from the same base model as the
	//   custom model.
	DesiredModelId *string

	// The new name for this Provisioned Throughput.
	DesiredProvisionedModelName *string
	// contains filtered or unexported fields
}

type UpdateProvisionedModelThroughputOutput added in v1.1.0 

type UpdateProvisionedModelThroughputOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
Package document implements encoding and decoding of open-content that has a JSON-like data model.
 Package document implements encoding and decoding of open-content that has a JSON-like data model.
internal
document
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.