bedrock

package module
v1.6.1 Latest Latest
Warning

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

 Go to latest Published: Feb 20, 2024 License: Apache-2.0 Imports: 41 Imported by: 18

Documentation

Overview

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

Describes the API operations for creating and managing 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 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) 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. Training data contains input and output text for each record in a JSONL format. Optionally, you can specify validation data in the same format as the training data. Amazon Bedrock returns validation loss metrics and output generations after the job completes. 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the Bedrock User Guide.

func (*Client) CreateProvisionedModelThroughput added in v1.1.0 

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

Creates a provisioned throughput with dedicated capacity for a foundation model or a fine-tuned model. For more information, see Provisioned throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the Bedrock User Guide.

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. For more information, see Provisioned throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the Bedrock User Guide.

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 models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the Bedrock User Guide.

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) 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 models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the Bedrock User Guide.

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) GetProvisionedModelThroughput added in v1.1.0 

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

Get details for a provisioned throughput. For more information, see Provisioned throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the Bedrock User Guide.

func (*Client) ListFoundationModels 

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

List of Amazon Bedrock foundation models that you can use. For more information, see Foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/foundation-models.html) in the 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the Bedrock User Guide.

func (*Client) ListProvisionedModelThroughputs added in v1.1.0 

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

List the provisioned capacities. For more information, see Provisioned throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the 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) 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the Bedrock User Guide.

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 (https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the Bedrock User Guide.

func (*Client) UpdateProvisionedModelThroughput added in v1.1.0 

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

Update a provisioned throughput. For more information, see Provisioned throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the Bedrock User Guide.

type CreateModelCustomizationJobInput 

type CreateModelCustomizationJobInput struct {

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

	// Enter a name for the custom model.
	//
	// This member is required.
	CustomModelName *string

	// Parameters related to tuning the model.
	//
	// This member is required.
	HyperParameters map[string]string

	// Enter a unique 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 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

	// Unique token value that you can provide. The GetModelCustomizationJob response
	// includes the same token value.
	ClientRequestToken *string

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

	// Assign tags to the custom model.
	CustomModelTags []types.Tag

	// The customization type.
	CustomizationType types.CustomizationType

	// Assign tags to the job.
	JobTags []types.Tag

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

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

type CreateModelCustomizationJobOutput 

type CreateModelCustomizationJobOutput struct {

	// 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 CreateProvisionedModelThroughputInput added in v1.1.0 

type CreateProvisionedModelThroughputInput struct {

	// Name or ARN of the model to associate with this provisioned throughput.
	//
	// This member is required.
	ModelId *string

	// Number of model units to allocate.
	//
	// This member is required.
	ModelUnits *int32

	// Unique name for this provisioned throughput.
	//
	// This member is required.
	ProvisionedModelName *string

	// Unique token value that you can provide. If this token matches a previous
	// request, Amazon Bedrock ignores the request, but does not return an error.
	ClientRequestToken *string

	// Commitment duration requested for the provisioned throughput.
	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 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 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 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 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 ARN of the custom model.
	//
	// This member is required.
	ModelIdentifier *string
	// contains filtered or unexported fields
}

type GetCustomModelOutput 

type GetCustomModelOutput struct {

	// ARN of the base model.
	//
	// This member is required.
	BaseModelArn *string

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

	// Job ARN associated with this model.
	//
	// This member is required.
	JobArn *string

	// 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

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

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

	// Hyperparameter values associated with this model.
	HyperParameters map[string]string

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

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

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

	// Array of up to 10 validators.
	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 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 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 {

	// 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 hyperparameter values for the job. For information about hyperparameters
	// for specific models, see Guidelines for model customization (https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-guidelines.html)
	// .
	//
	// This member is required.
	HyperParameters map[string]string

	// The 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 ARN of the IAM role.
	//
	// This member is required.
	RoleArn *string

	// S3 Location of the training data.
	//
	// This member is required.
	TrainingDataConfig *types.TrainingDataConfig

	// Array of up to 10 validators.
	//
	// This member is required.
	ValidationDataConfig *types.ValidationDataConfig

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

	// 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

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

	// The 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

	// Metrics associated with the custom job.
	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 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 GetProvisionedModelThroughputInput added in v1.1.0 

type GetProvisionedModelThroughputInput struct {

	// The 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 ARN of the new model to asssociate with this provisioned throughput.
	//
	// This member is required.
	DesiredModelArn *string

	// The desired number of model units that was requested to be available for this
	// provisioned throughput.
	//
	// This member is required.
	DesiredModelUnits *int32

	// ARN of the foundation model.
	//
	// This member is required.
	FoundationModelArn *string

	// The timestamp of the last modified time of this provisioned throughput.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The ARN or name of the model associated with this provisioned throughput.
	//
	// This member is required.
	ModelArn *string

	// The current number of model units requested to be available for this
	// provisioned throughput.
	//
	// This member is required.
	ModelUnits *int32

	// The ARN of the provisioned throughput.
	//
	// This member is required.
	ProvisionedModelArn *string

	// The name of the provisioned throughput.
	//
	// This member is required.
	ProvisionedModelName *string

	// Status of the provisioned throughput.
	//
	// This member is required.
	Status types.ProvisionedModelStatus

	// Commitment duration of the provisioned throughput.
	CommitmentDuration types.CommitmentDuration

	// Commitment expiration time for the provisioned throughput.
	CommitmentExpirationTime *time.Time

	// Failure message for any issues that the create operation encounters.
	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 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 ARN matches this parameter.
	FoundationModelArnEquals *string

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

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

	// Continuation token from the previous response, for Amazon Bedrock to list the
	// next set 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

	// Continuation token for the next request 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 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 {
	// 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
}

ListCustomModelsPaginatorOptions is the paginator options for ListCustomModels

type ListFoundationModelsInput 

type ListFoundationModelsInput struct {

	// List by customization type.
	ByCustomizationType types.ModelCustomization

	// List by inference type.
	ByInferenceType types.InferenceType

	// List by output modality type.
	ByOutputModality types.ModelModality

	// A Amazon Bedrock model provider.
	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 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

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

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

	// Continuation token from the previous response, for Amazon Bedrock to list the
	// next set 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

	// Page continuation token to use in the next request.
	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 {
	// 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
}

ListModelCustomizationJobsPaginatorOptions is the paginator options for ListModelCustomizationJobs

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 {

	// Return provisioned capacities created after the specified time.
	CreationTimeAfter *time.Time

	// Return provisioned capacities created before the specified time.
	CreationTimeBefore *time.Time

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

	// Return the list of provisioned capacities where their model ARN is equal to
	// this parameter.
	ModelArnEquals *string

	// Return the list of provisioned capacities if their name contains these
	// characters.
	NameContains *string

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

	// The field to sort by in the returned list of provisioned capacities.
	SortBy types.SortByProvisionedModels

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

	// Return the list of provisioned capacities that match the specified status.
	StatusEquals types.ProvisionedModelStatus
	// contains filtered or unexported fields
}

type ListProvisionedModelThroughputsOutput added in v1.1.0 

type ListProvisionedModelThroughputsOutput struct {

	// Continuation token for the next request to list the next set of results.
	NextToken *string

	// 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.
	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 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 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 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 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 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 TagResourceInput 

type TagResourceInput struct {

	// The 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 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 UpdateProvisionedModelThroughputInput added in v1.1.0 

type UpdateProvisionedModelThroughputInput struct {

	// The ARN or name of the provisioned throughput to update.
	//
	// This member is required.
	ProvisionedModelId *string

	// The ARN of the new model to associate with this provisioned throughput.
	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
internal
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.