Documentation
¶
Overview ¶
Package bedrockagentcore provides the API client, operations, and parameter types for Amazon Bedrock AgentCore.
Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.
Index ¶
- Constants
- Variables
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AuthResolverParameters
- type AuthSchemeResolver
- type BatchCreateMemoryRecordsInput
- type BatchCreateMemoryRecordsOutput
- type BatchDeleteMemoryRecordsInput
- type BatchDeleteMemoryRecordsOutput
- type BatchUpdateMemoryRecordsInput
- type BatchUpdateMemoryRecordsOutput
- type Client
- func (c *Client) BatchCreateMemoryRecords(ctx context.Context, params *BatchCreateMemoryRecordsInput, ...) (*BatchCreateMemoryRecordsOutput, error)
- func (c *Client) BatchDeleteMemoryRecords(ctx context.Context, params *BatchDeleteMemoryRecordsInput, ...) (*BatchDeleteMemoryRecordsOutput, error)
- func (c *Client) BatchUpdateMemoryRecords(ctx context.Context, params *BatchUpdateMemoryRecordsInput, ...) (*BatchUpdateMemoryRecordsOutput, error)
- func (c *Client) CompleteResourceTokenAuth(ctx context.Context, params *CompleteResourceTokenAuthInput, ...) (*CompleteResourceTokenAuthOutput, error)
- func (c *Client) CreateABTest(ctx context.Context, params *CreateABTestInput, optFns ...func(*Options)) (*CreateABTestOutput, error)
- func (c *Client) CreateEvent(ctx context.Context, params *CreateEventInput, optFns ...func(*Options)) (*CreateEventOutput, error)
- func (c *Client) CreatePaymentInstrument(ctx context.Context, params *CreatePaymentInstrumentInput, ...) (*CreatePaymentInstrumentOutput, error)
- func (c *Client) CreatePaymentSession(ctx context.Context, params *CreatePaymentSessionInput, ...) (*CreatePaymentSessionOutput, error)
- func (c *Client) DeleteABTest(ctx context.Context, params *DeleteABTestInput, optFns ...func(*Options)) (*DeleteABTestOutput, error)
- func (c *Client) DeleteBatchEvaluation(ctx context.Context, params *DeleteBatchEvaluationInput, ...) (*DeleteBatchEvaluationOutput, error)
- func (c *Client) DeleteCapacityProviderSession(ctx context.Context, params *DeleteCapacityProviderSessionInput, ...) (*DeleteCapacityProviderSessionOutput, error)
- func (c *Client) DeleteDatasetGeneration(ctx context.Context, params *DeleteDatasetGenerationInput, ...) (*DeleteDatasetGenerationOutput, error)
- func (c *Client) DeleteEvent(ctx context.Context, params *DeleteEventInput, optFns ...func(*Options)) (*DeleteEventOutput, error)
- func (c *Client) DeleteMemoryRecord(ctx context.Context, params *DeleteMemoryRecordInput, optFns ...func(*Options)) (*DeleteMemoryRecordOutput, error)
- func (c *Client) DeletePaymentInstrument(ctx context.Context, params *DeletePaymentInstrumentInput, ...) (*DeletePaymentInstrumentOutput, error)
- func (c *Client) DeletePaymentSession(ctx context.Context, params *DeletePaymentSessionInput, ...) (*DeletePaymentSessionOutput, error)
- func (c *Client) DeleteRecommendation(ctx context.Context, params *DeleteRecommendationInput, ...) (*DeleteRecommendationOutput, error)
- func (c *Client) Evaluate(ctx context.Context, params *EvaluateInput, optFns ...func(*Options)) (*EvaluateOutput, error)
- func (c *Client) GetABTest(ctx context.Context, params *GetABTestInput, optFns ...func(*Options)) (*GetABTestOutput, error)
- func (c *Client) GetAgentCard(ctx context.Context, params *GetAgentCardInput, optFns ...func(*Options)) (*GetAgentCardOutput, error)
- func (c *Client) GetAgentInsight(ctx context.Context, params *GetAgentInsightInput, optFns ...func(*Options)) (*GetAgentInsightOutput, error)
- func (c *Client) GetBatchEvaluation(ctx context.Context, params *GetBatchEvaluationInput, optFns ...func(*Options)) (*GetBatchEvaluationOutput, error)
- func (c *Client) GetBrowserSession(ctx context.Context, params *GetBrowserSessionInput, optFns ...func(*Options)) (*GetBrowserSessionOutput, error)
- func (c *Client) GetCodeInterpreterSession(ctx context.Context, params *GetCodeInterpreterSessionInput, ...) (*GetCodeInterpreterSessionOutput, error)
- func (c *Client) GetDatasetGeneration(ctx context.Context, params *GetDatasetGenerationInput, ...) (*GetDatasetGenerationOutput, error)
- func (c *Client) GetEvent(ctx context.Context, params *GetEventInput, optFns ...func(*Options)) (*GetEventOutput, error)
- func (c *Client) GetMemoryRecord(ctx context.Context, params *GetMemoryRecordInput, optFns ...func(*Options)) (*GetMemoryRecordOutput, error)
- func (c *Client) GetPaymentInstrument(ctx context.Context, params *GetPaymentInstrumentInput, ...) (*GetPaymentInstrumentOutput, error)
- func (c *Client) GetPaymentInstrumentBalance(ctx context.Context, params *GetPaymentInstrumentBalanceInput, ...) (*GetPaymentInstrumentBalanceOutput, error)
- func (c *Client) GetPaymentSession(ctx context.Context, params *GetPaymentSessionInput, optFns ...func(*Options)) (*GetPaymentSessionOutput, error)
- func (c *Client) GetRecommendation(ctx context.Context, params *GetRecommendationInput, optFns ...func(*Options)) (*GetRecommendationOutput, error)
- func (c *Client) GetResourceApiKey(ctx context.Context, params *GetResourceApiKeyInput, optFns ...func(*Options)) (*GetResourceApiKeyOutput, error)
- func (c *Client) GetResourceOauth2Token(ctx context.Context, params *GetResourceOauth2TokenInput, ...) (*GetResourceOauth2TokenOutput, error)
- func (c *Client) GetResourcePaymentToken(ctx context.Context, params *GetResourcePaymentTokenInput, ...) (*GetResourcePaymentTokenOutput, error)
- func (c *Client) GetWorkloadAccessToken(ctx context.Context, params *GetWorkloadAccessTokenInput, ...) (*GetWorkloadAccessTokenOutput, error)
- func (c *Client) GetWorkloadAccessTokenForJWT(ctx context.Context, params *GetWorkloadAccessTokenForJWTInput, ...) (*GetWorkloadAccessTokenForJWTOutput, error)
- func (c *Client) GetWorkloadAccessTokenForUserId(ctx context.Context, params *GetWorkloadAccessTokenForUserIdInput, ...) (*GetWorkloadAccessTokenForUserIdOutput, error)
- func (c *Client) IngestData(ctx context.Context, params *IngestDataInput, optFns ...func(*Options)) (*IngestDataOutput, error)
- func (c *Client) InvokeAgentRuntime(ctx context.Context, params *InvokeAgentRuntimeInput, optFns ...func(*Options)) (*InvokeAgentRuntimeOutput, error)
- func (c *Client) InvokeAgentRuntimeCommand(ctx context.Context, params *InvokeAgentRuntimeCommandInput, ...) (*InvokeAgentRuntimeCommandOutput, error)
- func (c *Client) InvokeBrowser(ctx context.Context, params *InvokeBrowserInput, optFns ...func(*Options)) (*InvokeBrowserOutput, error)
- func (c *Client) InvokeCodeInterpreter(ctx context.Context, params *InvokeCodeInterpreterInput, ...) (*InvokeCodeInterpreterOutput, error)
- func (c *Client) InvokeHarness(ctx context.Context, params *InvokeHarnessInput, optFns ...func(*Options)) (*InvokeHarnessOutput, error)
- func (c *Client) InvokeWebSearch(ctx context.Context, params *InvokeWebSearchInput, optFns ...func(*Options)) (*InvokeWebSearchOutput, error)
- func (c *Client) ListABTests(ctx context.Context, params *ListABTestsInput, optFns ...func(*Options)) (*ListABTestsOutput, error)
- func (c *Client) ListActors(ctx context.Context, params *ListActorsInput, optFns ...func(*Options)) (*ListActorsOutput, error)
- func (c *Client) ListAgentInsights(ctx context.Context, params *ListAgentInsightsInput, optFns ...func(*Options)) (*ListAgentInsightsOutput, error)
- func (c *Client) ListBatchEvaluations(ctx context.Context, params *ListBatchEvaluationsInput, ...) (*ListBatchEvaluationsOutput, error)
- func (c *Client) ListBrowserSessions(ctx context.Context, params *ListBrowserSessionsInput, ...) (*ListBrowserSessionsOutput, error)
- func (c *Client) ListCodeInterpreterSessions(ctx context.Context, params *ListCodeInterpreterSessionsInput, ...) (*ListCodeInterpreterSessionsOutput, error)
- func (c *Client) ListDatasetGenerations(ctx context.Context, params *ListDatasetGenerationsInput, ...) (*ListDatasetGenerationsOutput, error)
- func (c *Client) ListEvents(ctx context.Context, params *ListEventsInput, optFns ...func(*Options)) (*ListEventsOutput, error)
- func (c *Client) ListMemoryExtractionJobs(ctx context.Context, params *ListMemoryExtractionJobsInput, ...) (*ListMemoryExtractionJobsOutput, error)
- func (c *Client) ListMemoryRecords(ctx context.Context, params *ListMemoryRecordsInput, optFns ...func(*Options)) (*ListMemoryRecordsOutput, error)
- func (c *Client) ListPaymentInstruments(ctx context.Context, params *ListPaymentInstrumentsInput, ...) (*ListPaymentInstrumentsOutput, error)
- func (c *Client) ListPaymentSessions(ctx context.Context, params *ListPaymentSessionsInput, ...) (*ListPaymentSessionsOutput, error)
- func (c *Client) ListRecommendations(ctx context.Context, params *ListRecommendationsInput, ...) (*ListRecommendationsOutput, error)
- func (c *Client) ListSessions(ctx context.Context, params *ListSessionsInput, optFns ...func(*Options)) (*ListSessionsOutput, error)
- func (c *Client) Options() Options
- func (c *Client) ProcessPayment(ctx context.Context, params *ProcessPaymentInput, optFns ...func(*Options)) (*ProcessPaymentOutput, error)
- func (c *Client) RetrieveMemoryRecords(ctx context.Context, params *RetrieveMemoryRecordsInput, ...) (*RetrieveMemoryRecordsOutput, error)
- func (c *Client) SaveBrowserSessionProfile(ctx context.Context, params *SaveBrowserSessionProfileInput, ...) (*SaveBrowserSessionProfileOutput, error)
- func (c *Client) SearchRegistryRecords(ctx context.Context, params *SearchRegistryRecordsInput, ...) (*SearchRegistryRecordsOutput, error)
- func (c *Client) StartBatchEvaluation(ctx context.Context, params *StartBatchEvaluationInput, ...) (*StartBatchEvaluationOutput, error)
- func (c *Client) StartBrowserSession(ctx context.Context, params *StartBrowserSessionInput, ...) (*StartBrowserSessionOutput, error)
- func (c *Client) StartCodeInterpreterSession(ctx context.Context, params *StartCodeInterpreterSessionInput, ...) (*StartCodeInterpreterSessionOutput, error)
- func (c *Client) StartDatasetGeneration(ctx context.Context, params *StartDatasetGenerationInput, ...) (*StartDatasetGenerationOutput, error)
- func (c *Client) StartMemoryExtractionJob(ctx context.Context, params *StartMemoryExtractionJobInput, ...) (*StartMemoryExtractionJobOutput, error)
- func (c *Client) StartRecommendation(ctx context.Context, params *StartRecommendationInput, ...) (*StartRecommendationOutput, error)
- func (c *Client) StopBatchEvaluation(ctx context.Context, params *StopBatchEvaluationInput, ...) (*StopBatchEvaluationOutput, error)
- func (c *Client) StopBrowserSession(ctx context.Context, params *StopBrowserSessionInput, optFns ...func(*Options)) (*StopBrowserSessionOutput, error)
- func (c *Client) StopCodeInterpreterSession(ctx context.Context, params *StopCodeInterpreterSessionInput, ...) (*StopCodeInterpreterSessionOutput, error)
- func (c *Client) StopRuntimeSession(ctx context.Context, params *StopRuntimeSessionInput, optFns ...func(*Options)) (*StopRuntimeSessionOutput, error)
- func (c *Client) UpdateABTest(ctx context.Context, params *UpdateABTestInput, optFns ...func(*Options)) (*UpdateABTestOutput, error)
- func (c *Client) UpdateAgentInsight(ctx context.Context, params *UpdateAgentInsightInput, optFns ...func(*Options)) (*UpdateAgentInsightOutput, error)
- func (c *Client) UpdateBrowserStream(ctx context.Context, params *UpdateBrowserStreamInput, ...) (*UpdateBrowserStreamOutput, error)
- type CodeInterpreterStreamOutputReader
- type CompleteResourceTokenAuthInput
- type CompleteResourceTokenAuthOutput
- type CreateABTestInput
- type CreateABTestOutput
- type CreateEventInput
- type CreateEventOutput
- type CreatePaymentInstrumentInput
- type CreatePaymentInstrumentOutput
- type CreatePaymentSessionInput
- type CreatePaymentSessionOutput
- type DeleteABTestInput
- type DeleteABTestOutput
- type DeleteBatchEvaluationInput
- type DeleteBatchEvaluationOutput
- type DeleteCapacityProviderSessionInput
- type DeleteCapacityProviderSessionOutput
- type DeleteDatasetGenerationInput
- type DeleteDatasetGenerationOutput
- type DeleteEventInput
- type DeleteEventOutput
- type DeleteMemoryRecordInput
- type DeleteMemoryRecordOutput
- type DeletePaymentInstrumentInput
- type DeletePaymentInstrumentOutput
- type DeletePaymentSessionInput
- type DeletePaymentSessionOutput
- type DeleteRecommendationInput
- type DeleteRecommendationOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type EvaluateInput
- type EvaluateOutput
- type GetABTestInput
- type GetABTestOutput
- type GetAgentCardInput
- type GetAgentCardOutput
- type GetAgentInsightInput
- type GetAgentInsightOutput
- type GetBatchEvaluationInput
- type GetBatchEvaluationOutput
- type GetBrowserSessionInput
- type GetBrowserSessionOutput
- type GetCodeInterpreterSessionInput
- type GetCodeInterpreterSessionOutput
- type GetDatasetGenerationInput
- type GetDatasetGenerationOutput
- type GetEventInput
- type GetEventOutput
- type GetMemoryRecordInput
- type GetMemoryRecordOutput
- type GetPaymentInstrumentBalanceInput
- type GetPaymentInstrumentBalanceOutput
- type GetPaymentInstrumentInput
- type GetPaymentInstrumentOutput
- type GetPaymentSessionInput
- type GetPaymentSessionOutput
- type GetRecommendationInput
- type GetRecommendationOutput
- type GetResourceApiKeyInput
- type GetResourceApiKeyOutput
- type GetResourceOauth2TokenInput
- type GetResourceOauth2TokenOutput
- type GetResourcePaymentTokenInput
- type GetResourcePaymentTokenOutput
- type GetWorkloadAccessTokenForJWTInput
- type GetWorkloadAccessTokenForJWTOutput
- type GetWorkloadAccessTokenForUserIdInput
- type GetWorkloadAccessTokenForUserIdOutput
- type GetWorkloadAccessTokenInput
- type GetWorkloadAccessTokenOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type IngestDataInput
- type IngestDataOutput
- type InvokeAgentRuntimeCommandEventStream
- type InvokeAgentRuntimeCommandInitialReply
- type InvokeAgentRuntimeCommandInput
- type InvokeAgentRuntimeCommandOutput
- func (v *InvokeAgentRuntimeCommandOutput) Deserialize(d smithy.ShapeDeserializer) error
- func (o *InvokeAgentRuntimeCommandOutput) GetInitialReply() <-chan InvokeAgentRuntimeCommandInitialReply
- func (o *InvokeAgentRuntimeCommandOutput) GetStream() *InvokeAgentRuntimeCommandEventStream
- func (v *InvokeAgentRuntimeCommandOutput) Serialize(s smithy.ShapeSerializer)
- func (v *InvokeAgentRuntimeCommandOutput) SerializeMembers(s smithy.ShapeSerializer)
- type InvokeAgentRuntimeCommandStreamOutputReader
- type InvokeAgentRuntimeInput
- type InvokeAgentRuntimeOutput
- func (v *InvokeAgentRuntimeOutput) Deserialize(d smithy.ShapeDeserializer) error
- func (v *InvokeAgentRuntimeOutput) GetPayloadStream() io.Reader
- func (v *InvokeAgentRuntimeOutput) Serialize(s smithy.ShapeSerializer)
- func (v *InvokeAgentRuntimeOutput) SerializeMembers(s smithy.ShapeSerializer)
- func (v *InvokeAgentRuntimeOutput) SetPayloadStream(r io.ReadCloser)
- type InvokeBrowserInput
- type InvokeBrowserOutput
- type InvokeCodeInterpreterEventStream
- type InvokeCodeInterpreterInput
- type InvokeCodeInterpreterOutput
- func (v *InvokeCodeInterpreterOutput) Deserialize(d smithy.ShapeDeserializer) error
- func (o *InvokeCodeInterpreterOutput) GetStream() *InvokeCodeInterpreterEventStream
- func (v *InvokeCodeInterpreterOutput) Serialize(s smithy.ShapeSerializer)
- func (v *InvokeCodeInterpreterOutput) SerializeMembers(s smithy.ShapeSerializer)
- type InvokeHarnessEventStream
- type InvokeHarnessInitialReply
- type InvokeHarnessInput
- type InvokeHarnessOutput
- func (v *InvokeHarnessOutput) Deserialize(d smithy.ShapeDeserializer) error
- func (o *InvokeHarnessOutput) GetInitialReply() <-chan InvokeHarnessInitialReply
- func (o *InvokeHarnessOutput) GetStream() *InvokeHarnessEventStream
- func (v *InvokeHarnessOutput) Serialize(s smithy.ShapeSerializer)
- func (v *InvokeHarnessOutput) SerializeMembers(s smithy.ShapeSerializer)
- type InvokeHarnessStreamOutputReader
- type InvokeWebSearchInput
- type InvokeWebSearchOutput
- type ListABTestsAPIClient
- type ListABTestsInput
- type ListABTestsOutput
- type ListABTestsPaginator
- type ListABTestsPaginatorOptions
- type ListActorsAPIClient
- type ListActorsInput
- type ListActorsOutput
- type ListActorsPaginator
- type ListActorsPaginatorOptions
- type ListAgentInsightsAPIClient
- type ListAgentInsightsInput
- type ListAgentInsightsOutput
- type ListAgentInsightsPaginator
- type ListAgentInsightsPaginatorOptions
- type ListBatchEvaluationsAPIClient
- type ListBatchEvaluationsInput
- type ListBatchEvaluationsOutput
- type ListBatchEvaluationsPaginator
- type ListBatchEvaluationsPaginatorOptions
- type ListBrowserSessionsInput
- type ListBrowserSessionsOutput
- type ListCodeInterpreterSessionsInput
- type ListCodeInterpreterSessionsOutput
- type ListDatasetGenerationsAPIClient
- type ListDatasetGenerationsInput
- type ListDatasetGenerationsOutput
- type ListDatasetGenerationsPaginator
- type ListDatasetGenerationsPaginatorOptions
- type ListEventsAPIClient
- type ListEventsInput
- type ListEventsOutput
- type ListEventsPaginator
- type ListEventsPaginatorOptions
- type ListMemoryExtractionJobsAPIClient
- type ListMemoryExtractionJobsInput
- type ListMemoryExtractionJobsOutput
- type ListMemoryExtractionJobsPaginator
- type ListMemoryExtractionJobsPaginatorOptions
- type ListMemoryRecordsAPIClient
- type ListMemoryRecordsInput
- type ListMemoryRecordsOutput
- type ListMemoryRecordsPaginator
- type ListMemoryRecordsPaginatorOptions
- type ListPaymentInstrumentsAPIClient
- type ListPaymentInstrumentsInput
- type ListPaymentInstrumentsOutput
- type ListPaymentInstrumentsPaginator
- type ListPaymentInstrumentsPaginatorOptions
- type ListPaymentSessionsAPIClient
- type ListPaymentSessionsInput
- type ListPaymentSessionsOutput
- type ListPaymentSessionsPaginator
- type ListPaymentSessionsPaginatorOptions
- type ListRecommendationsAPIClient
- type ListRecommendationsInput
- type ListRecommendationsOutput
- type ListRecommendationsPaginator
- type ListRecommendationsPaginatorOptions
- type ListSessionsAPIClient
- type ListSessionsInput
- type ListSessionsOutput
- type ListSessionsPaginator
- type ListSessionsPaginatorOptions
- type Options
- type PartialResult
- type ProcessPaymentInput
- type ProcessPaymentOutput
- type ResolveEndpoint
- type RetrieveMemoryRecordsAPIClient
- type RetrieveMemoryRecordsInput
- type RetrieveMemoryRecordsOutput
- type RetrieveMemoryRecordsPaginator
- type RetrieveMemoryRecordsPaginatorOptions
- type SaveBrowserSessionProfileInput
- type SaveBrowserSessionProfileOutput
- type SearchRegistryRecordsInput
- type SearchRegistryRecordsOutput
- type StartBatchEvaluationInput
- type StartBatchEvaluationOutput
- type StartBrowserSessionInput
- type StartBrowserSessionOutput
- type StartCodeInterpreterSessionInput
- type StartCodeInterpreterSessionOutput
- type StartDatasetGenerationInput
- type StartDatasetGenerationOutput
- type StartMemoryExtractionJobInput
- type StartMemoryExtractionJobOutput
- type StartRecommendationInput
- type StartRecommendationOutput
- type StopBatchEvaluationInput
- type StopBatchEvaluationOutput
- type StopBrowserSessionInput
- type StopBrowserSessionOutput
- type StopCodeInterpreterSessionInput
- type StopCodeInterpreterSessionOutput
- type StopRuntimeSessionInput
- type StopRuntimeSessionOutput
- type UnknownEventMessageError
- type UpdateABTestInput
- type UpdateABTestOutput
- type UpdateAgentInsightInput
- type UpdateAgentInsightOutput
- type UpdateBrowserStreamInput
- type UpdateBrowserStreamOutput
Constants ¶
const ServiceAPIVersion = "2024-02-28"
const ServiceID = "Bedrock AgentCore"
Variables ¶
var TypeRegistry = &smithy.TypeRegistry{ Entries: map[string]*smithy.TypeRegistryEntry{ "com.amazonaws.bedrockagentcore#AccessDeniedException": { Schema: schemas.AccessDeniedException, New: func() any { return &types.AccessDeniedException{} }, }, "com.amazonaws.bedrockagentcore#CodeInterpreterResult": { Schema: schemas.CodeInterpreterResult, New: func() any { return &types.CodeInterpreterResult{} }, }, "com.amazonaws.bedrockagentcore#ConflictException": { Schema: schemas.ConflictException, New: func() any { return &types.ConflictException{} }, }, "com.amazonaws.bedrockagentcore#DuplicateIdException": { Schema: schemas.DuplicateIdException, New: func() any { return &types.DuplicateIdException{} }, }, "com.amazonaws.bedrockagentcore#HarnessContentBlockDeltaEvent": { Schema: schemas.HarnessContentBlockDeltaEvent, New: func() any { return &types.HarnessContentBlockDeltaEvent{} }, }, "com.amazonaws.bedrockagentcore#HarnessContentBlockStartEvent": { Schema: schemas.HarnessContentBlockStartEvent, New: func() any { return &types.HarnessContentBlockStartEvent{} }, }, "com.amazonaws.bedrockagentcore#HarnessContentBlockStopEvent": { Schema: schemas.HarnessContentBlockStopEvent, New: func() any { return &types.HarnessContentBlockStopEvent{} }, }, "com.amazonaws.bedrockagentcore#HarnessHookEvent": { Schema: schemas.HarnessHookEvent, New: func() any { return &types.HarnessHookEvent{} }, }, "com.amazonaws.bedrockagentcore#HarnessMessageStartEvent": { Schema: schemas.HarnessMessageStartEvent, New: func() any { return &types.HarnessMessageStartEvent{} }, }, "com.amazonaws.bedrockagentcore#HarnessMessageStopEvent": { Schema: schemas.HarnessMessageStopEvent, New: func() any { return &types.HarnessMessageStopEvent{} }, }, "com.amazonaws.bedrockagentcore#HarnessMetadataEvent": { Schema: schemas.HarnessMetadataEvent, New: func() any { return &types.HarnessMetadataEvent{} }, }, "com.amazonaws.bedrockagentcore#InternalServerException": { Schema: schemas.InternalServerException, New: func() any { return &types.InternalServerException{} }, }, "com.amazonaws.bedrockagentcore#InvalidInputException": { Schema: schemas.InvalidInputException, New: func() any { return &types.InvalidInputException{} }, }, "com.amazonaws.bedrockagentcore#ResourceNotFoundException": { Schema: schemas.ResourceNotFoundException, New: func() any { return &types.ResourceNotFoundException{} }, }, "com.amazonaws.bedrockagentcore#ResponseChunk": { Schema: schemas.ResponseChunk, New: func() any { return &types.ResponseChunk{} }, }, "com.amazonaws.bedrockagentcore#RetryableConflictException": { Schema: schemas.RetryableConflictException, New: func() any { return &types.RetryableConflictException{} }, }, "com.amazonaws.bedrockagentcore#RuntimeClientError": { Schema: schemas.RuntimeClientError, New: func() any { return &types.RuntimeClientError{} }, }, "com.amazonaws.bedrockagentcore#ServiceException": { Schema: schemas.ServiceException, New: func() any { return &types.ServiceException{} }, }, "com.amazonaws.bedrockagentcore#ServiceQuotaExceededException": { Schema: schemas.ServiceQuotaExceededException, New: func() any { return &types.ServiceQuotaExceededException{} }, }, "com.amazonaws.bedrockagentcore#ServiceUnavailableException": { Schema: schemas.ServiceUnavailableException, New: func() any { return &types.ServiceUnavailableException{} }, }, "com.amazonaws.bedrockagentcore#SubscriptionRequiredException": { Schema: schemas.SubscriptionRequiredException, New: func() any { return &types.SubscriptionRequiredException{} }, }, "com.amazonaws.bedrockagentcore#ThrottledException": { Schema: schemas.ThrottledException, New: func() any { return &types.ThrottledException{} }, }, "com.amazonaws.bedrockagentcore#ThrottlingException": { Schema: schemas.ThrottlingException, New: func() any { return &types.ThrottlingException{} }, }, "com.amazonaws.bedrockagentcore#UnauthorizedException": { Schema: schemas.UnauthorizedException, New: func() any { return &types.UnauthorizedException{} }, }, "com.amazonaws.bedrockagentcore#ValidationException": { Schema: schemas.ValidationException, New: func() any { return &types.ValidationException{} }, }, }, }
TypeRegistry is the type registry for this service.
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 ¶
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 ¶
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 ¶
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 ¶
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type BatchCreateMemoryRecordsInput ¶ added in v1.5.0
type BatchCreateMemoryRecordsInput struct {
// The unique ID of the memory resource where records will be created.
//
// This member is required.
MemoryId *string
// A list of memory record creation inputs to be processed in the batch operation.
//
// This member is required.
Records []types.MemoryRecordCreateInput
// A unique, case-sensitive identifier to ensure idempotent processing of the
// batch request.
ClientToken *string
// The record expiry (long-term memory time-to-live) applied to every record
// created by this request. Set recordExpiryDurationDays to the number of days
// after which the records expire. Only the expiry provided here is applied; the
// records' strategy association has no effect on their expiry. If you do not
// provide this value, the records do not expire. The REMOVE action does not apply
// when creating records.
RecordExpirySpecification types.RecordExpirySpecification
// contains filtered or unexported fields
}
func (*BatchCreateMemoryRecordsInput) Serialize ¶ added in v1.28.3
func (v *BatchCreateMemoryRecordsInput) Serialize(s smithy.ShapeSerializer)
func (*BatchCreateMemoryRecordsInput) SerializeMembers ¶ added in v1.28.3
func (v *BatchCreateMemoryRecordsInput) SerializeMembers(s smithy.ShapeSerializer)
type BatchCreateMemoryRecordsOutput ¶ added in v1.5.0
type BatchCreateMemoryRecordsOutput struct {
// A list of memory records that failed to be created, including error details for
// each failure.
//
// This member is required.
FailedRecords []types.MemoryRecordOutput
// A list of memory records that were successfully created during the batch
// operation.
//
// This member is required.
SuccessfulRecords []types.MemoryRecordOutput
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*BatchCreateMemoryRecordsOutput) Deserialize ¶ added in v1.28.3
func (v *BatchCreateMemoryRecordsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*BatchCreateMemoryRecordsOutput) Serialize ¶ added in v1.53.0
func (v *BatchCreateMemoryRecordsOutput) Serialize(s smithy.ShapeSerializer)
func (*BatchCreateMemoryRecordsOutput) SerializeMembers ¶ added in v1.53.0
func (v *BatchCreateMemoryRecordsOutput) SerializeMembers(s smithy.ShapeSerializer)
type BatchDeleteMemoryRecordsInput ¶ added in v1.5.0
type BatchDeleteMemoryRecordsInput struct {
// The unique ID of the memory resource where records will be deleted.
//
// This member is required.
MemoryId *string
// A list of memory record deletion inputs to be processed in the batch operation.
//
// This member is required.
Records []types.MemoryRecordDeleteInput
// contains filtered or unexported fields
}
func (*BatchDeleteMemoryRecordsInput) Serialize ¶ added in v1.28.3
func (v *BatchDeleteMemoryRecordsInput) Serialize(s smithy.ShapeSerializer)
func (*BatchDeleteMemoryRecordsInput) SerializeMembers ¶ added in v1.28.3
func (v *BatchDeleteMemoryRecordsInput) SerializeMembers(s smithy.ShapeSerializer)
type BatchDeleteMemoryRecordsOutput ¶ added in v1.5.0
type BatchDeleteMemoryRecordsOutput struct {
// A list of memory records that failed to be deleted, including error details for
// each failure.
//
// This member is required.
FailedRecords []types.MemoryRecordOutput
// A list of memory records that were successfully deleted during the batch
// operation.
//
// This member is required.
SuccessfulRecords []types.MemoryRecordOutput
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*BatchDeleteMemoryRecordsOutput) Deserialize ¶ added in v1.28.3
func (v *BatchDeleteMemoryRecordsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*BatchDeleteMemoryRecordsOutput) Serialize ¶ added in v1.53.0
func (v *BatchDeleteMemoryRecordsOutput) Serialize(s smithy.ShapeSerializer)
func (*BatchDeleteMemoryRecordsOutput) SerializeMembers ¶ added in v1.53.0
func (v *BatchDeleteMemoryRecordsOutput) SerializeMembers(s smithy.ShapeSerializer)
type BatchUpdateMemoryRecordsInput ¶ added in v1.5.0
type BatchUpdateMemoryRecordsInput struct {
// The unique ID of the memory resource where records will be updated.
//
// This member is required.
MemoryId *string
// A list of memory record update inputs to be processed in the batch operation.
//
// This member is required.
Records []types.MemoryRecordUpdateInput
// The record expiry (long-term memory time-to-live) applied to every record
// updated by this request. Set recordExpiryDurationDays to configure or overwrite
// the number of days after which the records expire, or set action to REMOVE to
// clear a previously configured expiry so that the records no longer expire.
//
// When you do not provide this value, the service determines each record's expiry
// from its current state:
//
// - If the record already has an expiry configured, the service resets and
// reapplies the expiry based on the last applied recordExpiryDurationDays .
//
// - If the record does not have an expiry configured, no expiry is applied and
// the record remains non-expiring. This is the outcome regardless of whether the
// record's strategy configures an expiry.
//
// Providing an explicit recordExpiryDurationDays always takes precedence: it
// overwrites an existing expiry, or sets one on a record that previously had none.
RecordExpirySpecification types.RecordExpirySpecification
// contains filtered or unexported fields
}
func (*BatchUpdateMemoryRecordsInput) Serialize ¶ added in v1.28.3
func (v *BatchUpdateMemoryRecordsInput) Serialize(s smithy.ShapeSerializer)
func (*BatchUpdateMemoryRecordsInput) SerializeMembers ¶ added in v1.28.3
func (v *BatchUpdateMemoryRecordsInput) SerializeMembers(s smithy.ShapeSerializer)
type BatchUpdateMemoryRecordsOutput ¶ added in v1.5.0
type BatchUpdateMemoryRecordsOutput struct {
// A list of memory records that failed to be updated, including error details for
// each failure.
//
// This member is required.
FailedRecords []types.MemoryRecordOutput
// A list of memory records that were successfully updated during the batch
// operation.
//
// This member is required.
SuccessfulRecords []types.MemoryRecordOutput
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*BatchUpdateMemoryRecordsOutput) Deserialize ¶ added in v1.28.3
func (v *BatchUpdateMemoryRecordsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*BatchUpdateMemoryRecordsOutput) Serialize ¶ added in v1.53.0
func (v *BatchUpdateMemoryRecordsOutput) Serialize(s smithy.ShapeSerializer)
func (*BatchUpdateMemoryRecordsOutput) SerializeMembers ¶ added in v1.53.0
func (v *BatchUpdateMemoryRecordsOutput) SerializeMembers(s smithy.ShapeSerializer)
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon Bedrock AgentCore.
func New ¶
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 ¶
NewFromConfig returns a new client from the provided config.
func (*Client) BatchCreateMemoryRecords ¶ added in v1.5.0
func (c *Client) BatchCreateMemoryRecords(ctx context.Context, params *BatchCreateMemoryRecordsInput, optFns ...func(*Options)) (*BatchCreateMemoryRecordsOutput, error)
Creates multiple memory records in a single batch operation for the specified memory with custom content.
func (*Client) BatchDeleteMemoryRecords ¶ added in v1.5.0
func (c *Client) BatchDeleteMemoryRecords(ctx context.Context, params *BatchDeleteMemoryRecordsInput, optFns ...func(*Options)) (*BatchDeleteMemoryRecordsOutput, error)
Deletes multiple memory records in a single batch operation from the specified memory.
func (*Client) BatchUpdateMemoryRecords ¶ added in v1.5.0
func (c *Client) BatchUpdateMemoryRecords(ctx context.Context, params *BatchUpdateMemoryRecordsInput, optFns ...func(*Options)) (*BatchUpdateMemoryRecordsOutput, error)
Updates multiple memory records with custom content in a single batch operation within the specified memory.
func (*Client) CompleteResourceTokenAuth ¶ added in v1.7.0
func (c *Client) CompleteResourceTokenAuth(ctx context.Context, params *CompleteResourceTokenAuthInput, optFns ...func(*Options)) (*CompleteResourceTokenAuthOutput, error)
Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.
func (*Client) CreateABTest ¶ added in v1.23.0
func (c *Client) CreateABTest(ctx context.Context, params *CreateABTestInput, optFns ...func(*Options)) (*CreateABTestOutput, error)
Creates an A/B test for comparing agent configurations. A/B tests split traffic between a control variant and a treatment variant through a gateway, then evaluate performance using online evaluation configurations to determine which variant performs better.
func (*Client) CreateEvent ¶
func (c *Client) CreateEvent(ctx context.Context, params *CreateEventInput, optFns ...func(*Options)) (*CreateEventOutput, error)
Creates an event in an AgentCore Memory resource. Events represent interactions or activities that occur within a session and are associated with specific actors.
To use this operation, you must have the bedrock-agentcore:CreateEvent permission.
This operation is subject to request rate limiting.
func (*Client) CreatePaymentInstrument ¶ added in v1.25.0
func (c *Client) CreatePaymentInstrument(ctx context.Context, params *CreatePaymentInstrumentInput, optFns ...func(*Options)) (*CreatePaymentInstrumentOutput, error)
Create a new payment instrument for a connector.
func (*Client) CreatePaymentSession ¶ added in v1.25.0
func (c *Client) CreatePaymentSession(ctx context.Context, params *CreatePaymentSessionInput, optFns ...func(*Options)) (*CreatePaymentSessionOutput, error)
Create a new payment session.
func (*Client) DeleteABTest ¶ added in v1.23.0
func (c *Client) DeleteABTest(ctx context.Context, params *DeleteABTestInput, optFns ...func(*Options)) (*DeleteABTestOutput, error)
Deletes an A/B test and its associated gateway rules.
func (*Client) DeleteBatchEvaluation ¶ added in v1.23.0
func (c *Client) DeleteBatchEvaluation(ctx context.Context, params *DeleteBatchEvaluationInput, optFns ...func(*Options)) (*DeleteBatchEvaluationOutput, error)
Deletes a batch evaluation and its associated results.
func (*Client) DeleteCapacityProviderSession ¶ added in v1.37.0
func (c *Client) DeleteCapacityProviderSession(ctx context.Context, params *DeleteCapacityProviderSessionInput, optFns ...func(*Options)) (*DeleteCapacityProviderSessionOutput, error)
Deletes a session associated with a capacity provider in Amazon Bedrock AgentCore and makes the session unavailable for further use. To delete a capacity provider session, specify both the capacity provider identifier and the session ID. After you delete a session, you cannot restart it.
func (*Client) DeleteDatasetGeneration ¶ added in v1.59.0
func (c *Client) DeleteDatasetGeneration(ctx context.Context, params *DeleteDatasetGenerationInput, optFns ...func(*Options)) (*DeleteDatasetGenerationOutput, error)
Deletes the record of a dataset generation. The examples the generation added stay in the dataset's draft. To remove them, find them with the generationIds filter of ListDatasetExamples , then call DeleteDatasetExamples .
func (*Client) DeleteEvent ¶
func (c *Client) DeleteEvent(ctx context.Context, params *DeleteEventInput, optFns ...func(*Options)) (*DeleteEventOutput, error)
Deletes an event from an AgentCore Memory resource. When you delete an event, it is permanently removed.
To use this operation, you must have the bedrock-agentcore:DeleteEvent permission.
func (*Client) DeleteMemoryRecord ¶
func (c *Client) DeleteMemoryRecord(ctx context.Context, params *DeleteMemoryRecordInput, optFns ...func(*Options)) (*DeleteMemoryRecordOutput, error)
Deletes a memory record from an AgentCore Memory resource. When you delete a memory record, it is permanently removed.
To use this operation, you must have the bedrock-agentcore:DeleteMemoryRecord permission.
func (*Client) DeletePaymentInstrument ¶ added in v1.25.0
func (c *Client) DeletePaymentInstrument(ctx context.Context, params *DeletePaymentInstrumentInput, optFns ...func(*Options)) (*DeletePaymentInstrumentOutput, error)
Deletes a payment instrument. This is a soft delete operation that preserves the record for audit and compliance purposes.
func (*Client) DeletePaymentSession ¶ added in v1.25.0
func (c *Client) DeletePaymentSession(ctx context.Context, params *DeletePaymentSessionInput, optFns ...func(*Options)) (*DeletePaymentSessionOutput, error)
Deletes a payment session. This permanently removes the payment session record.
func (*Client) DeleteRecommendation ¶ added in v1.23.0
func (c *Client) DeleteRecommendation(ctx context.Context, params *DeleteRecommendationInput, optFns ...func(*Options)) (*DeleteRecommendationOutput, error)
Deletes a recommendation and its associated results.
func (*Client) Evaluate ¶ added in v1.10.0
func (c *Client) Evaluate(ctx context.Context, params *EvaluateInput, optFns ...func(*Options)) (*EvaluateOutput, error)
Performs on-demand evaluation of agent traces using a specified evaluator.
This synchronous API accepts traces in OpenTelemetry format and returns immediate scoring results with detailed explanations.
func (*Client) GetABTest ¶ added in v1.23.0
func (c *Client) GetABTest(ctx context.Context, params *GetABTestInput, optFns ...func(*Options)) (*GetABTestOutput, error)
Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.
func (*Client) GetAgentCard ¶ added in v1.5.0
func (c *Client) GetAgentCard(ctx context.Context, params *GetAgentCardInput, optFns ...func(*Options)) (*GetAgentCardOutput, error)
Retrieves the A2A agent card associated with an AgentCore Runtime agent.
func (*Client) GetAgentInsight ¶ added in v1.59.0
func (c *Client) GetAgentInsight(ctx context.Context, params *GetAgentInsightInput, optFns ...func(*Options)) (*GetAgentInsightOutput, error)
Amazon Bedrock AgentCore Agent Insights identifies patterns detected across your agent sessions. Use Agent Insights to identify recurring issues and prioritize fixes.
Retrieves detailed information about an Amazon Bedrock AgentCore Agent Insight, including its archive status, affected sessions, and, when applicable, the batch evaluation that produced it.
func (*Client) GetBatchEvaluation ¶ added in v1.23.0
func (c *Client) GetBatchEvaluation(ctx context.Context, params *GetBatchEvaluationInput, optFns ...func(*Options)) (*GetBatchEvaluationOutput, error)
Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.
func (*Client) GetBrowserSession ¶
func (c *Client) GetBrowserSession(ctx context.Context, params *GetBrowserSessionInput, optFns ...func(*Options)) (*GetBrowserSessionOutput, error)
Retrieves detailed information about a specific browser session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, associated streams, and metadata.
To get a browser session, you must specify both the browser identifier and the session ID. The response includes information about the session's viewport configuration, timeout settings, and stream endpoints.
The following operations are related to GetBrowserSession :
func (*Client) GetCodeInterpreterSession ¶
func (c *Client) GetCodeInterpreterSession(ctx context.Context, params *GetCodeInterpreterSessionInput, optFns ...func(*Options)) (*GetCodeInterpreterSessionOutput, error)
Retrieves detailed information about a specific code interpreter session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, and metadata.
To get a code interpreter session, you must specify both the code interpreter identifier and the session ID. The response includes information about the session's timeout settings and current status.
The following operations are related to GetCodeInterpreterSession :
func (*Client) GetDatasetGeneration ¶ added in v1.59.0
func (c *Client) GetDatasetGeneration(ctx context.Context, params *GetDatasetGenerationInput, optFns ...func(*Options)) (*GetDatasetGenerationOutput, error)
Gets a dataset generation, including its status, the request it was started with, its progress counts, its redaction summary and its errors. Call this operation to track a generation that you started with StartDatasetGeneration .
func (*Client) GetEvent ¶
func (c *Client) GetEvent(ctx context.Context, params *GetEventInput, optFns ...func(*Options)) (*GetEventOutput, error)
Retrieves information about a specific event in an AgentCore Memory resource.
To use this operation, you must have the bedrock-agentcore:GetEvent permission.
func (*Client) GetMemoryRecord ¶
func (c *Client) GetMemoryRecord(ctx context.Context, params *GetMemoryRecordInput, optFns ...func(*Options)) (*GetMemoryRecordOutput, error)
Retrieves a specific memory record from an AgentCore Memory resource.
To use this operation, you must have the bedrock-agentcore:GetMemoryRecord permission.
func (*Client) GetPaymentInstrument ¶ added in v1.25.0
func (c *Client) GetPaymentInstrument(ctx context.Context, params *GetPaymentInstrumentInput, optFns ...func(*Options)) (*GetPaymentInstrumentOutput, error)
Get a payment instrument by ID.
func (*Client) GetPaymentInstrumentBalance ¶ added in v1.25.0
func (c *Client) GetPaymentInstrumentBalance(ctx context.Context, params *GetPaymentInstrumentBalanceInput, optFns ...func(*Options)) (*GetPaymentInstrumentBalanceOutput, error)
Get the balance of a payment instrument.
func (*Client) GetPaymentSession ¶ added in v1.25.0
func (c *Client) GetPaymentSession(ctx context.Context, params *GetPaymentSessionInput, optFns ...func(*Options)) (*GetPaymentSessionOutput, error)
Get a payment session.
func (*Client) GetRecommendation ¶ added in v1.23.0
func (c *Client) GetRecommendation(ctx context.Context, params *GetRecommendationInput, optFns ...func(*Options)) (*GetRecommendationOutput, error)
Retrieves detailed information about a recommendation, including its configuration, status, and results.
func (*Client) GetResourceApiKey ¶
func (c *Client) GetResourceApiKey(ctx context.Context, params *GetResourceApiKeyInput, optFns ...func(*Options)) (*GetResourceApiKeyOutput, error)
Retrieves the API key associated with an API key credential provider.
func (*Client) GetResourceOauth2Token ¶
func (c *Client) GetResourceOauth2Token(ctx context.Context, params *GetResourceOauth2TokenInput, optFns ...func(*Options)) (*GetResourceOauth2TokenOutput, error)
Returns the OAuth 2.0 token of the provided resource.
func (*Client) GetResourcePaymentToken ¶ added in v1.25.0
func (c *Client) GetResourcePaymentToken(ctx context.Context, params *GetResourcePaymentTokenInput, optFns ...func(*Options)) (*GetResourcePaymentTokenOutput, error)
Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.
func (*Client) GetWorkloadAccessToken ¶
func (c *Client) GetWorkloadAccessToken(ctx context.Context, params *GetWorkloadAccessTokenInput, optFns ...func(*Options)) (*GetWorkloadAccessTokenOutput, error)
Obtains a workload access token for agentic workloads not acting on behalf of a user.
func (*Client) GetWorkloadAccessTokenForJWT ¶
func (c *Client) GetWorkloadAccessTokenForJWT(ctx context.Context, params *GetWorkloadAccessTokenForJWTInput, optFns ...func(*Options)) (*GetWorkloadAccessTokenForJWTOutput, error)
Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.
func (*Client) GetWorkloadAccessTokenForUserId ¶
func (c *Client) GetWorkloadAccessTokenForUserId(ctx context.Context, params *GetWorkloadAccessTokenForUserIdInput, optFns ...func(*Options)) (*GetWorkloadAccessTokenForUserIdOutput, error)
Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.
func (*Client) IngestData ¶ added in v1.43.0
func (c *Client) IngestData(ctx context.Context, params *IngestDataInput, optFns ...func(*Options)) (*IngestDataOutput, error)
Submits content directly for ingestion to generate long-term memory records in a AgentCore Memory resource.
To use this operation, you must have the bedrock-agentcore:IngestData permission.
func (*Client) InvokeAgentRuntime ¶
func (c *Client) InvokeAgentRuntime(ctx context.Context, params *InvokeAgentRuntimeInput, optFns ...func(*Options)) (*InvokeAgentRuntimeOutput, error)
Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
To invoke an agent, you can specify either the AgentCore Runtime ARN or the agent ID with an account ID, and provide a payload containing your request. When you use the agent ID instead of the full ARN, you don't need to URL-encode the identifier. You can optionally specify a qualifier to target a specific endpoint of the agent.
This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.
For example code, see Invoke an AgentCore Runtime agent.
If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime . Instead, make a HTTPS request to InvokeAgentRuntime . For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.
To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission. If you are making a call to InvokeAgentRuntime on behalf of a user ID with the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header, You require permissions to both actions ( bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser ).
func (*Client) InvokeAgentRuntimeCommand ¶ added in v1.14.0
func (c *Client) InvokeAgentRuntimeCommand(ctx context.Context, params *InvokeAgentRuntimeCommandInput, optFns ...func(*Options)) (*InvokeAgentRuntimeCommandOutput, error)
Executes a command in a runtime session container and streams the output back to the caller. This operation allows you to run shell commands within the agent runtime environment and receive real-time streaming responses including standard output and standard error.
To invoke a command, you must specify the agent runtime ARN and a runtime session ID. The command execution supports streaming responses, allowing you to receive output as it becomes available through contentStart , contentDelta , and contentStop events.
To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntimeCommand permission.
func (*Client) InvokeBrowser ¶ added in v1.19.0
func (c *Client) InvokeBrowser(ctx context.Context, params *InvokeBrowserInput, optFns ...func(*Options)) (*InvokeBrowserOutput, error)
Invokes an operating system-level action on a browser session in Amazon Bedrock AgentCore. This operation provides direct OS-level control over browser sessions, enabling mouse actions, keyboard input, and screenshots that the WebSocket-based Chrome DevTools Protocol (CDP) cannot handle — such as interacting with print dialogs, context menus, and JavaScript alerts.
You send a request with exactly one action in the BrowserAction union, and receive a corresponding result in the BrowserActionResult union.
The following operations are related to InvokeBrowser :
func (*Client) InvokeCodeInterpreter ¶
func (c *Client) InvokeCodeInterpreter(ctx context.Context, params *InvokeCodeInterpreterInput, optFns ...func(*Options)) (*InvokeCodeInterpreterOutput, error)
Executes code within an active code interpreter session in Amazon Bedrock AgentCore. This operation processes the provided code, runs it in a secure environment, and returns the execution results including output, errors, and generated visualizations.
To execute code, you must specify the code interpreter identifier, session ID, and the code to run in the arguments parameter. The operation returns a stream containing the execution results, which can include text output, error messages, and data visualizations.
This operation is subject to request rate limiting based on your account's service quotas.
The following operations are related to InvokeCodeInterpreter :
func (*Client) InvokeHarness ¶ added in v1.22.0
func (c *Client) InvokeHarness(ctx context.Context, params *InvokeHarnessInput, optFns ...func(*Options)) (*InvokeHarnessOutput, error)
Operation to invoke a Harness.
func (*Client) InvokeWebSearch ¶ added in v1.57.0
func (c *Client) InvokeWebSearch(ctx context.Context, params *InvokeWebSearchInput, optFns ...func(*Options)) (*InvokeWebSearchOutput, error)
Searches the web and returns a ranked list of results. Each result includes a text extract from the page.
You can filter the results by domain and by publication date.
To use this operation, you must have the bedrock-agentcore:InvokeWebSearch permission on the resource arn:${Partition}:bedrock-agentcore:${Region}:aws:tool/web-search.v1 .
func (*Client) ListABTests ¶ added in v1.23.0
func (c *Client) ListABTests(ctx context.Context, params *ListABTestsInput, optFns ...func(*Options)) (*ListABTestsOutput, error)
Lists all A/B tests in the account.
func (*Client) ListActors ¶
func (c *Client) ListActors(ctx context.Context, params *ListActorsInput, optFns ...func(*Options)) (*ListActorsOutput, error)
Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:ListActors permission.
func (*Client) ListAgentInsights ¶ added in v1.59.0
func (c *Client) ListAgentInsights(ctx context.Context, params *ListAgentInsightsInput, optFns ...func(*Options)) (*ListAgentInsightsOutput, error)
Lists Amazon Bedrock AgentCore Agent Insight summaries in your account and Region. Use this operation to review patterns across sessions before you investigate or archive an insight. The response paginates the results. Use the nextToken parameter to retrieve additional results.
func (*Client) ListBatchEvaluations ¶ added in v1.23.0
func (c *Client) ListBatchEvaluations(ctx context.Context, params *ListBatchEvaluationsInput, optFns ...func(*Options)) (*ListBatchEvaluationsOutput, error)
Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration.
func (*Client) ListBrowserSessions ¶
func (c *Client) ListBrowserSessions(ctx context.Context, params *ListBrowserSessionsInput, optFns ...func(*Options)) (*ListBrowserSessionsOutput, error)
Retrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.
You can filter the results by browser identifier and session status. The operation supports pagination to handle large result sets efficiently.
We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.
The following operations are related to ListBrowserSessions :
func (*Client) ListCodeInterpreterSessions ¶
func (c *Client) ListCodeInterpreterSessions(ctx context.Context, params *ListCodeInterpreterSessionsInput, optFns ...func(*Options)) (*ListCodeInterpreterSessionsOutput, error)
Retrieves a list of code interpreter sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.
You can filter the results by code interpreter identifier and session status. The operation supports pagination to handle large result sets efficiently.
We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.
The following operations are related to ListCodeInterpreterSessions :
func (*Client) ListDatasetGenerations ¶ added in v1.59.0
func (c *Client) ListDatasetGenerations(ctx context.Context, params *ListDatasetGenerationsInput, optFns ...func(*Options)) (*ListDatasetGenerationsOutput, error)
Lists the generations for a dataset. AgentCore keeps a generation until you delete it with DeleteDatasetGeneration or delete the dataset. To get a generation's counts and the request it was started with, call GetDatasetGeneration .
func (*Client) ListEvents ¶
func (c *Client) ListEvents(ctx context.Context, params *ListEventsInput, optFns ...func(*Options)) (*ListEventsOutput, error)
Lists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:ListEvents permission.
func (*Client) ListMemoryExtractionJobs ¶ added in v1.9.0
func (c *Client) ListMemoryExtractionJobs(ctx context.Context, params *ListMemoryExtractionJobsInput, optFns ...func(*Options)) (*ListMemoryExtractionJobsOutput, error)
Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.
To use this operation, you must have the bedrock-agentcore:ListMemoryExtractionJobs permission.
func (*Client) ListMemoryRecords ¶
func (c *Client) ListMemoryRecords(ctx context.Context, params *ListMemoryRecordsInput, optFns ...func(*Options)) (*ListMemoryRecordsOutput, error)
Lists memory records in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:ListMemoryRecords permission.
func (*Client) ListPaymentInstruments ¶ added in v1.25.0
func (c *Client) ListPaymentInstruments(ctx context.Context, params *ListPaymentInstrumentsInput, optFns ...func(*Options)) (*ListPaymentInstrumentsOutput, error)
List payment instruments for a manager.
func (*Client) ListPaymentSessions ¶ added in v1.25.0
func (c *Client) ListPaymentSessions(ctx context.Context, params *ListPaymentSessionsInput, optFns ...func(*Options)) (*ListPaymentSessionsOutput, error)
List payment sessions.
func (*Client) ListRecommendations ¶ added in v1.23.0
func (c *Client) ListRecommendations(ctx context.Context, params *ListRecommendationsInput, optFns ...func(*Options)) (*ListRecommendationsOutput, error)
Lists all recommendations in the account, with optional filtering by status.
func (*Client) ListSessions ¶
func (c *Client) ListSessions(ctx context.Context, params *ListSessionsInput, optFns ...func(*Options)) (*ListSessionsOutput, error)
Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
Empty sessions are automatically deleted after one day.
To use this operation, you must have the bedrock-agentcore:ListSessions permission.
func (*Client) 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) ProcessPayment ¶ added in v1.25.0
func (c *Client) ProcessPayment(ctx context.Context, params *ProcessPaymentInput, optFns ...func(*Options)) (*ProcessPaymentOutput, error)
Processes a payment using a payment instrument within a payment session.
func (*Client) RetrieveMemoryRecords ¶
func (c *Client) RetrieveMemoryRecords(ctx context.Context, params *RetrieveMemoryRecordsInput, optFns ...func(*Options)) (*RetrieveMemoryRecordsOutput, error)
Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:RetrieveMemoryRecords permission.
func (*Client) SaveBrowserSessionProfile ¶ added in v1.12.0
func (c *Client) SaveBrowserSessionProfile(ctx context.Context, params *SaveBrowserSessionProfileInput, optFns ...func(*Options)) (*SaveBrowserSessionProfileOutput, error)
Saves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore. A browser profile captures persistent browser data such as cookies and local storage from an active session, enabling you to reuse this data in future browser sessions.
To save a browser session profile, you must specify the profile identifier, browser identifier, and session ID. The session must be active when saving the profile. Once saved, the profile can be used with the StartBrowserSession operation to initialize new sessions with the stored browser state.
Browser profiles are useful for scenarios that require persistent authentication, maintaining user preferences across sessions, or continuing tasks that depend on previously stored browser data.
The following operations are related to SaveBrowserSessionProfile :
func (*Client) SearchRegistryRecords ¶ added in v1.20.0
func (c *Client) SearchRegistryRecords(ctx context.Context, params *SearchRegistryRecordsInput, optFns ...func(*Options)) (*SearchRegistryRecordsOutput, error)
Searches for registry records using semantic, lexical, or hybrid queries.
Returns metadata for matching records ordered by relevance within the specified registry.
func (*Client) StartBatchEvaluation ¶ added in v1.23.0
func (c *Client) StartBatchEvaluation(ctx context.Context, params *StartBatchEvaluationInput, optFns ...func(*Options)) (*StartBatchEvaluationOutput, error)
Starts a batch evaluation job that evaluates agent performance across multiple sessions. Batch evaluations pull agent traces from CloudWatch Logs or an existing online evaluation configuration and run specified evaluators and insights against them.
func (*Client) StartBrowserSession ¶
func (c *Client) StartBrowserSession(ctx context.Context, params *StartBrowserSessionInput, optFns ...func(*Options)) (*StartBrowserSessionOutput, error)
Creates and initializes a browser session in Amazon Bedrock AgentCore. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation.
To create a session, you must specify a browser identifier and a name. You can also configure the viewport dimensions to control the visible area of web content. The session remains active until it times out or you explicitly stop it using the StopBrowserSession operation.
The following operations are related to StartBrowserSession :
func (*Client) StartCodeInterpreterSession ¶
func (c *Client) StartCodeInterpreterSession(ctx context.Context, params *StartCodeInterpreterSessionInput, optFns ...func(*Options)) (*StartCodeInterpreterSessionOutput, error)
Creates and initializes a code interpreter session in Amazon Bedrock AgentCore. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.
To create a session, you must specify a code interpreter identifier and a name. The session remains active until it times out or you explicitly stop it using the StopCodeInterpreterSession operation.
The following operations are related to StartCodeInterpreterSession :
func (*Client) StartDatasetGeneration ¶ added in v1.59.0
func (c *Client) StartDatasetGeneration(ctx context.Context, params *StartDatasetGenerationInput, optFns ...func(*Options)) (*StartDatasetGenerationOutput, error)
Starts a dataset generation, which creates examples for an existing dataset from your agent's traces. The dataset must be ACTIVE . Each generation produces one scenario type, set by scenarioType . When the generation finishes, AgentCore adds the examples to the dataset's draft. Examples that duplicate each other, or that duplicate examples already in the draft, are left out.
A dataset can have only one generation in progress at a time. While it runs, requests that change the dataset's draft or publish a version are rejected with a ConflictException .
AgentCore reads the traces with your credentials, so you need read access to the trace log groups, and to the dataset's KMS key if the dataset uses a customer managed key. The draft can hold at most 1,000 examples, including the examples this generation can add ( maxScenarios ).
The operation returns immediately. To track progress, call GetDatasetGeneration .
func (*Client) StartMemoryExtractionJob ¶ added in v1.9.0
func (c *Client) StartMemoryExtractionJob(ctx context.Context, params *StartMemoryExtractionJobInput, optFns ...func(*Options)) (*StartMemoryExtractionJobOutput, error)
Starts a memory extraction job that processes events that failed extraction
previously in an AgentCore Memory resource and produces structured memory records. When earlier extraction attempts have left events unprocessed, this job will pick up and extract those as well.
To use this operation, you must have the bedrock-agentcore:StartMemoryExtractionJob permission.
func (*Client) StartRecommendation ¶ added in v1.23.0
func (c *Client) StartRecommendation(ctx context.Context, params *StartRecommendationInput, optFns ...func(*Options)) (*StartRecommendationOutput, error)
Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.
func (*Client) StopBatchEvaluation ¶ added in v1.23.0
func (c *Client) StopBatchEvaluation(ctx context.Context, params *StopBatchEvaluationInput, optFns ...func(*Options)) (*StopBatchEvaluationOutput, error)
Stops a running batch evaluation. Sessions that have already been evaluated retain their results.
func (*Client) StopBrowserSession ¶
func (c *Client) StopBrowserSession(ctx context.Context, params *StopBrowserSessionInput, optFns ...func(*Options)) (*StopBrowserSessionOutput, error)
Terminates an active browser session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.
To stop a browser session, you must specify both the browser identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartBrowserSession .
The following operations are related to StopBrowserSession :
func (*Client) StopCodeInterpreterSession ¶
func (c *Client) StopCodeInterpreterSession(ctx context.Context, params *StopCodeInterpreterSessionInput, optFns ...func(*Options)) (*StopCodeInterpreterSessionOutput, error)
Terminates an active code interpreter session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.
To stop a code interpreter session, you must specify both the code interpreter identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartCodeInterpreterSession .
The following operations are related to StopCodeInterpreterSession :
func (*Client) StopRuntimeSession ¶ added in v1.5.0
func (c *Client) StopRuntimeSession(ctx context.Context, params *StopRuntimeSessionInput, optFns ...func(*Options)) (*StopRuntimeSessionOutput, error)
Stops a session that is running in an running AgentCore Runtime agent.
func (*Client) UpdateABTest ¶ added in v1.23.0
func (c *Client) UpdateABTest(ctx context.Context, params *UpdateABTestInput, optFns ...func(*Options)) (*UpdateABTestOutput, error)
Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.
func (*Client) UpdateAgentInsight ¶ added in v1.59.0
func (c *Client) UpdateAgentInsight(ctx context.Context, params *UpdateAgentInsightInput, optFns ...func(*Options)) (*UpdateAgentInsightOutput, error)
Updates the archive status of an Amazon Bedrock AgentCore Agent Insight.
func (*Client) UpdateBrowserStream ¶
func (c *Client) UpdateBrowserStream(ctx context.Context, params *UpdateBrowserStreamInput, optFns ...func(*Options)) (*UpdateBrowserStreamOutput, error)
Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.
type CodeInterpreterStreamOutputReader ¶
type CodeInterpreterStreamOutputReader interface {
Events() <-chan types.CodeInterpreterStreamOutput
Close() error
Err() error
}
CodeInterpreterStreamOutputReader provides the interface for reading events from a stream.
The writer's Close method must allow multiple concurrent calls.
type CompleteResourceTokenAuthInput ¶ added in v1.7.0
type CompleteResourceTokenAuthInput struct {
// Unique identifier for the user's authentication session for retrieving OAuth2
// tokens. This ID tracks the authorization flow state across multiple requests and
// responses during the OAuth2 authentication process.
//
// This member is required.
SessionUri *string
// The OAuth2.0 token or user ID that was used to generate the workload access
// token used for initiating the user authorization flow to retrieve OAuth2.0
// tokens.
//
// This member is required.
UserIdentifier types.UserIdentifier
// contains filtered or unexported fields
}
func (*CompleteResourceTokenAuthInput) Serialize ¶ added in v1.28.3
func (v *CompleteResourceTokenAuthInput) Serialize(s smithy.ShapeSerializer)
func (*CompleteResourceTokenAuthInput) SerializeMembers ¶ added in v1.28.3
func (v *CompleteResourceTokenAuthInput) SerializeMembers(s smithy.ShapeSerializer)
type CompleteResourceTokenAuthOutput ¶ added in v1.7.0
type CompleteResourceTokenAuthOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CompleteResourceTokenAuthOutput) Deserialize ¶ added in v1.28.3
func (v *CompleteResourceTokenAuthOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CompleteResourceTokenAuthOutput) Serialize ¶ added in v1.53.0
func (v *CompleteResourceTokenAuthOutput) Serialize(s smithy.ShapeSerializer)
func (*CompleteResourceTokenAuthOutput) SerializeMembers ¶ added in v1.53.0
func (v *CompleteResourceTokenAuthOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateABTestInput ¶ added in v1.23.0
type CreateABTestInput struct {
// The evaluation configuration specifying which online evaluation configurations
// to use for measuring variant performance.
//
// This member is required.
EvaluationConfig types.ABTestEvaluationConfig
// The Amazon Resource Name (ARN) of the gateway to use for traffic splitting.
//
// This member is required.
GatewayArn *string
// The name of the A/B test. Must be unique within your account.
//
// This member is required.
Name *string
// The IAM role ARN that grants permissions for the A/B test to access gateway and
// evaluation resources.
//
// This member is required.
RoleArn *string
// The list of variants for the A/B test. Must contain exactly two variants: a
// control (C) and a treatment (T1), each with a configuration bundle or target
// reference and a traffic weight.
//
// This member is required.
Variants []types.Variant
// A unique, case-sensitive identifier to ensure that the API request completes no
// more than one time. If this token matches a previous request, the service
// ignores the request, but does not return an error.
ClientToken *string
// The description of the A/B test.
Description *string
// Whether to enable the A/B test immediately upon creation. If true, traffic
// splitting begins automatically.
EnableOnCreate *bool
// Optional filter to restrict which gateway target paths are included in the A/B
// test.
GatewayFilter *types.GatewayFilter
// A map of tag keys and values to associate with the A/B test.
Tags map[string]string
// contains filtered or unexported fields
}
func (*CreateABTestInput) Serialize ¶ added in v1.28.3
func (v *CreateABTestInput) Serialize(s smithy.ShapeSerializer)
func (*CreateABTestInput) SerializeMembers ¶ added in v1.28.3
func (v *CreateABTestInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateABTestOutput ¶ added in v1.23.0
type CreateABTestOutput struct {
// The Amazon Resource Name (ARN) of the created A/B test.
//
// This member is required.
AbTestArn *string
// The unique identifier of the created A/B test.
//
// This member is required.
AbTestId *string
// The timestamp when the A/B test was created.
//
// This member is required.
CreatedAt *time.Time
// The execution status indicating whether the A/B test is currently running.
//
// This member is required.
ExecutionStatus types.ABTestExecutionStatus
// The status of the A/B test.
//
// This member is required.
Status types.ABTestStatus
// The name of the A/B test.
Name *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateABTestOutput) Deserialize ¶ added in v1.28.3
func (v *CreateABTestOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateABTestOutput) Serialize ¶ added in v1.53.0
func (v *CreateABTestOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateABTestOutput) SerializeMembers ¶ added in v1.53.0
func (v *CreateABTestOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateEventInput ¶
type CreateEventInput struct {
// The identifier of the actor associated with this event. An actor represents an
// entity that participates in sessions and generates events.
//
// This member is required.
ActorId *string
// The timestamp when the event occurred. If not specified, the current time is
// used.
//
// This member is required.
EventTimestamp *time.Time
// The identifier of the AgentCore Memory resource in which to create the event.
//
// This member is required.
MemoryId *string
// The content payload of the event. This can include conversational data, JSON
// data, or binary content.
//
// This member is required.
Payload []types.PayloadType
// The branch information for this event. Branches allow for organizing events
// into different conversation threads or paths.
Branch *types.Branch
// A unique, case-sensitive identifier to ensure that the operation completes no
// more than one time. If this token matches a previous request, AgentCore ignores
// the request, but does not return an error.
ClientToken *string
// The extraction configuration for long-term memory records. Use this parameter
// to specify namespace variable keys and their values for namespace substitution
// during extraction.
ExtractionConfig *types.ExtractionConfig
// Controls long-term memory extraction for this event. When set to SKIP , the
// event is stored in short-term memory but is excluded from long-term memory
// extraction. If not specified, the event is processed for extraction as usual.
ExtractionMode types.ExtractionMode
// The key-value metadata to attach to the event.
Metadata map[string]types.MetadataValue
// The identifier of the session in which this event occurs. A session represents
// a sequence of related events.
SessionId *string
// contains filtered or unexported fields
}
func (*CreateEventInput) Serialize ¶ added in v1.28.3
func (v *CreateEventInput) Serialize(s smithy.ShapeSerializer)
func (*CreateEventInput) SerializeMembers ¶ added in v1.28.3
func (v *CreateEventInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateEventOutput ¶
type CreateEventOutput struct {
// The event that was created.
//
// This member is required.
Event *types.Event
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateEventOutput) Deserialize ¶ added in v1.28.3
func (v *CreateEventOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateEventOutput) Serialize ¶ added in v1.53.0
func (v *CreateEventOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateEventOutput) SerializeMembers ¶ added in v1.53.0
func (v *CreateEventOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreatePaymentInstrumentInput ¶ added in v1.25.0
type CreatePaymentInstrumentInput struct {
// The ID of the payment connector to use for this instrument.
//
// This member is required.
PaymentConnectorId *string
// The details of the payment instrument.
//
// This member is required.
PaymentInstrumentDetails types.PaymentInstrumentDetails
// The type of payment instrument being created.
//
// This member is required.
PaymentInstrumentType types.PaymentInstrumentType
// The ARN of the payment manager that owns this payment instrument.
//
// This member is required.
PaymentManagerArn *string
// The agent name associated with this request, used for observability.
AgentName *string
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request.
ClientToken *string
// The user ID associated with this payment instrument.
UserId *string
// contains filtered or unexported fields
}
Request structure for creating a payment instrument.
func (*CreatePaymentInstrumentInput) Serialize ¶ added in v1.28.3
func (v *CreatePaymentInstrumentInput) Serialize(s smithy.ShapeSerializer)
func (*CreatePaymentInstrumentInput) SerializeMembers ¶ added in v1.28.3
func (v *CreatePaymentInstrumentInput) SerializeMembers(s smithy.ShapeSerializer)
type CreatePaymentInstrumentOutput ¶ added in v1.25.0
type CreatePaymentInstrumentOutput struct {
// The created payment instrument.
//
// This member is required.
PaymentInstrument *types.PaymentInstrument
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for creating a payment instrument.
func (*CreatePaymentInstrumentOutput) Deserialize ¶ added in v1.28.3
func (v *CreatePaymentInstrumentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreatePaymentInstrumentOutput) Serialize ¶ added in v1.53.0
func (v *CreatePaymentInstrumentOutput) Serialize(s smithy.ShapeSerializer)
func (*CreatePaymentInstrumentOutput) SerializeMembers ¶ added in v1.53.0
func (v *CreatePaymentInstrumentOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreatePaymentSessionInput ¶ added in v1.25.0
type CreatePaymentSessionInput struct {
// The session expiry time in minutes. Must be between 15 and 480 minutes.
//
// This member is required.
ExpiryTimeInMinutes *int32
// The ARN of the payment manager that owns this session.
//
// This member is required.
PaymentManagerArn *string
// The agent name associated with this request, used for observability.
AgentName *string
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request.
ClientToken *string
// The spending limits for this payment session.
Limits *types.SessionLimits
// The user ID associated with this payment session.
UserId *string
// contains filtered or unexported fields
}
Request structure for creating a payment session.
func (*CreatePaymentSessionInput) Serialize ¶ added in v1.28.3
func (v *CreatePaymentSessionInput) Serialize(s smithy.ShapeSerializer)
func (*CreatePaymentSessionInput) SerializeMembers ¶ added in v1.28.3
func (v *CreatePaymentSessionInput) SerializeMembers(s smithy.ShapeSerializer)
type CreatePaymentSessionOutput ¶ added in v1.25.0
type CreatePaymentSessionOutput struct {
// The created payment session.
//
// This member is required.
PaymentSession *types.PaymentSession
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for creating a payment session.
func (*CreatePaymentSessionOutput) Deserialize ¶ added in v1.28.3
func (v *CreatePaymentSessionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreatePaymentSessionOutput) Serialize ¶ added in v1.53.0
func (v *CreatePaymentSessionOutput) Serialize(s smithy.ShapeSerializer)
func (*CreatePaymentSessionOutput) SerializeMembers ¶ added in v1.53.0
func (v *CreatePaymentSessionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteABTestInput ¶ added in v1.23.0
type DeleteABTestInput struct {
// The unique identifier of the A/B test to delete.
//
// This member is required.
AbTestId *string
// contains filtered or unexported fields
}
func (*DeleteABTestInput) Serialize ¶ added in v1.28.3
func (v *DeleteABTestInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteABTestInput) SerializeMembers ¶ added in v1.28.3
func (v *DeleteABTestInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteABTestOutput ¶ added in v1.23.0
type DeleteABTestOutput struct {
// The Amazon Resource Name (ARN) of the deleted A/B test.
//
// This member is required.
AbTestArn *string
// The unique identifier of the deleted A/B test.
//
// This member is required.
AbTestId *string
// The status of the A/B test deletion operation.
//
// This member is required.
Status types.ABTestStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteABTestOutput) Deserialize ¶ added in v1.28.3
func (v *DeleteABTestOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteABTestOutput) Serialize ¶ added in v1.53.0
func (v *DeleteABTestOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteABTestOutput) SerializeMembers ¶ added in v1.53.0
func (v *DeleteABTestOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteBatchEvaluationInput ¶ added in v1.23.0
type DeleteBatchEvaluationInput struct {
// The unique identifier of the batch evaluation to delete.
//
// This member is required.
BatchEvaluationId *string
// contains filtered or unexported fields
}
func (*DeleteBatchEvaluationInput) Serialize ¶ added in v1.28.3
func (v *DeleteBatchEvaluationInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteBatchEvaluationInput) SerializeMembers ¶ added in v1.28.3
func (v *DeleteBatchEvaluationInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteBatchEvaluationOutput ¶ added in v1.23.0
type DeleteBatchEvaluationOutput struct {
// The Amazon Resource Name (ARN) of the deleted batch evaluation.
//
// This member is required.
BatchEvaluationArn *string
// The unique identifier of the deleted batch evaluation.
//
// This member is required.
BatchEvaluationId *string
// The status of the batch evaluation deletion operation.
//
// This member is required.
Status types.BatchEvaluationStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteBatchEvaluationOutput) Deserialize ¶ added in v1.28.3
func (v *DeleteBatchEvaluationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteBatchEvaluationOutput) Serialize ¶ added in v1.53.0
func (v *DeleteBatchEvaluationOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteBatchEvaluationOutput) SerializeMembers ¶ added in v1.53.0
func (v *DeleteBatchEvaluationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteCapacityProviderSessionInput ¶ added in v1.37.0
type DeleteCapacityProviderSessionInput struct {
// The unique identifier of the capacity provider associated with the session.
//
// This member is required.
CapacityProviderId *string
// The unique identifier of the capacity provider session to delete.
//
// This member is required.
SessionId *string
// contains filtered or unexported fields
}
func (*DeleteCapacityProviderSessionInput) Serialize ¶ added in v1.53.0
func (v *DeleteCapacityProviderSessionInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteCapacityProviderSessionInput) SerializeMembers ¶ added in v1.53.0
func (v *DeleteCapacityProviderSessionInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteCapacityProviderSessionOutput ¶ added in v1.37.0
type DeleteCapacityProviderSessionOutput struct {
// The Amazon Resource Name (ARN) of the capacity provider associated with the
// deleted session.
//
// This member is required.
CapacityProviderArn *string
// The unique identifier of the deleted capacity provider session.
//
// This member is required.
SessionId *string
// The current status of the capacity provider session. When the status is Deleting
// , the session is being deleted and is not available. When the status is Deleted
// , the session is no longer available.
//
// This member is required.
Status types.CapacityProviderSessionStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteCapacityProviderSessionOutput) Deserialize ¶ added in v1.53.0
func (v *DeleteCapacityProviderSessionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteCapacityProviderSessionOutput) Serialize ¶ added in v1.53.0
func (v *DeleteCapacityProviderSessionOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteCapacityProviderSessionOutput) SerializeMembers ¶ added in v1.53.0
func (v *DeleteCapacityProviderSessionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDatasetGenerationInput ¶ added in v1.59.0
type DeleteDatasetGenerationInput struct {
// The unique identifier of the dataset.
//
// This member is required.
DatasetId *string
// The unique identifier of the dataset generation.
//
// This member is required.
GenerationId *string
// contains filtered or unexported fields
}
func (*DeleteDatasetGenerationInput) Serialize ¶ added in v1.59.0
func (v *DeleteDatasetGenerationInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDatasetGenerationInput) SerializeMembers ¶ added in v1.59.0
func (v *DeleteDatasetGenerationInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDatasetGenerationOutput ¶ added in v1.59.0
type DeleteDatasetGenerationOutput struct {
// The unique identifier of the dataset generation.
//
// This member is required.
GenerationId *string
// The status of the dataset generation.
//
// This member is required.
Status types.DatasetGenerationStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteDatasetGenerationOutput) Deserialize ¶ added in v1.59.0
func (v *DeleteDatasetGenerationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteDatasetGenerationOutput) Serialize ¶ added in v1.59.0
func (v *DeleteDatasetGenerationOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDatasetGenerationOutput) SerializeMembers ¶ added in v1.59.0
func (v *DeleteDatasetGenerationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteEventInput ¶
type DeleteEventInput struct {
// The identifier of the actor associated with the event to delete.
//
// This member is required.
ActorId *string
// The identifier of the event to delete.
//
// This member is required.
EventId *string
// The identifier of the AgentCore Memory resource from which to delete the event.
//
// This member is required.
MemoryId *string
// The identifier of the session containing the event to delete.
//
// This member is required.
SessionId *string
// contains filtered or unexported fields
}
func (*DeleteEventInput) Serialize ¶ added in v1.28.3
func (v *DeleteEventInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteEventInput) SerializeMembers ¶ added in v1.28.3
func (v *DeleteEventInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteEventOutput ¶
type DeleteEventOutput struct {
// The identifier of the event that was deleted.
//
// This member is required.
EventId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteEventOutput) Deserialize ¶ added in v1.28.3
func (v *DeleteEventOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteEventOutput) Serialize ¶ added in v1.53.0
func (v *DeleteEventOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteEventOutput) SerializeMembers ¶ added in v1.53.0
func (v *DeleteEventOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteMemoryRecordInput ¶
type DeleteMemoryRecordInput struct {
// The identifier of the AgentCore Memory resource from which to delete the memory
// record.
//
// This member is required.
MemoryId *string
// The identifier of the memory record to delete.
//
// This member is required.
MemoryRecordId *string
// The namespace of the memory record to delete. This value is used for IAM
// condition key authorization.
Namespace *string
// contains filtered or unexported fields
}
func (*DeleteMemoryRecordInput) Serialize ¶ added in v1.28.3
func (v *DeleteMemoryRecordInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteMemoryRecordInput) SerializeMembers ¶ added in v1.28.3
func (v *DeleteMemoryRecordInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteMemoryRecordOutput ¶
type DeleteMemoryRecordOutput struct {
// The identifier of the memory record that was deleted.
//
// This member is required.
MemoryRecordId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteMemoryRecordOutput) Deserialize ¶ added in v1.28.3
func (v *DeleteMemoryRecordOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteMemoryRecordOutput) Serialize ¶ added in v1.53.0
func (v *DeleteMemoryRecordOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteMemoryRecordOutput) SerializeMembers ¶ added in v1.53.0
func (v *DeleteMemoryRecordOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeletePaymentInstrumentInput ¶ added in v1.25.0
type DeletePaymentInstrumentInput struct {
// The payment connector ID. Must match the instrument's paymentConnectorId.
//
// This member is required.
PaymentConnectorId *string
// The payment instrument ID to delete.
//
// This member is required.
PaymentInstrumentId *string
// The payment manager ARN. Must match the instrument's paymentManagerArn.
//
// This member is required.
PaymentManagerArn *string
// The user ID making the delete request. Must match the instrument's userId.
UserId *string
// contains filtered or unexported fields
}
Request structure for deleting a payment instrument.
func (*DeletePaymentInstrumentInput) Serialize ¶ added in v1.28.3
func (v *DeletePaymentInstrumentInput) Serialize(s smithy.ShapeSerializer)
func (*DeletePaymentInstrumentInput) SerializeMembers ¶ added in v1.28.3
func (v *DeletePaymentInstrumentInput) SerializeMembers(s smithy.ShapeSerializer)
type DeletePaymentInstrumentOutput ¶ added in v1.25.0
type DeletePaymentInstrumentOutput struct {
// The status of the instrument after deletion. Always DELETED for successful soft
// delete.
//
// This member is required.
Status types.PaymentInstrumentStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for deleting a payment instrument.
func (*DeletePaymentInstrumentOutput) Deserialize ¶ added in v1.28.3
func (v *DeletePaymentInstrumentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeletePaymentInstrumentOutput) Serialize ¶ added in v1.53.0
func (v *DeletePaymentInstrumentOutput) Serialize(s smithy.ShapeSerializer)
func (*DeletePaymentInstrumentOutput) SerializeMembers ¶ added in v1.53.0
func (v *DeletePaymentInstrumentOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeletePaymentSessionInput ¶ added in v1.25.0
type DeletePaymentSessionInput struct {
// The payment manager ARN. Must match the session's paymentManagerArn.
//
// This member is required.
PaymentManagerArn *string
// The payment session ID to delete.
//
// This member is required.
PaymentSessionId *string
// The user ID making the delete request. Must match the session's userId.
UserId *string
// contains filtered or unexported fields
}
Request structure for deleting a payment session.
func (*DeletePaymentSessionInput) Serialize ¶ added in v1.28.3
func (v *DeletePaymentSessionInput) Serialize(s smithy.ShapeSerializer)
func (*DeletePaymentSessionInput) SerializeMembers ¶ added in v1.28.3
func (v *DeletePaymentSessionInput) SerializeMembers(s smithy.ShapeSerializer)
type DeletePaymentSessionOutput ¶ added in v1.25.0
type DeletePaymentSessionOutput struct {
// The status of the deletion. Always DELETED for successful hard delete.
//
// This member is required.
Status types.PaymentSessionStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for deleting a payment session.
func (*DeletePaymentSessionOutput) Deserialize ¶ added in v1.28.3
func (v *DeletePaymentSessionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeletePaymentSessionOutput) Serialize ¶ added in v1.53.0
func (v *DeletePaymentSessionOutput) Serialize(s smithy.ShapeSerializer)
func (*DeletePaymentSessionOutput) SerializeMembers ¶ added in v1.53.0
func (v *DeletePaymentSessionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteRecommendationInput ¶ added in v1.23.0
type DeleteRecommendationInput struct {
// The unique identifier of the recommendation to delete.
//
// This member is required.
RecommendationId *string
// contains filtered or unexported fields
}
func (*DeleteRecommendationInput) Serialize ¶ added in v1.28.3
func (v *DeleteRecommendationInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteRecommendationInput) SerializeMembers ¶ added in v1.28.3
func (v *DeleteRecommendationInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteRecommendationOutput ¶ added in v1.23.0
type DeleteRecommendationOutput struct {
// The unique identifier of the deleted recommendation.
//
// This member is required.
RecommendationId *string
// The status of the recommendation deletion operation.
//
// This member is required.
Status types.RecommendationStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteRecommendationOutput) Deserialize ¶ added in v1.28.3
func (v *DeleteRecommendationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteRecommendationOutput) Serialize ¶ added in v1.53.0
func (v *DeleteRecommendationOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteRecommendationOutput) SerializeMembers ¶ added in v1.53.0
func (v *DeleteRecommendationOutput) SerializeMembers(s smithy.ShapeSerializer)
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(ctx context.Context, params EndpointParameters) (
smithyendpoints.Endpoint, error,
)
}
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶
func NewDefaultEndpointResolverV2() EndpointResolverV2
type EvaluateInput ¶ added in v1.10.0
type EvaluateInput struct {
// The input data containing agent session spans to be evaluated. Includes a list
// of spans in OpenTelemetry format from supported frameworks like Strands
// (AgentCore Runtime) or LangGraph with OpenInference instrumentation.
//
// This member is required.
EvaluationInput types.EvaluationInput
// The unique identifier of the evaluator to use for scoring. Can be a built-in
// evaluator (e.g., Builtin.Helpfulness , Builtin.Correctness ) or a custom
// evaluator Id created through the control plane API.
//
// This member is required.
EvaluatorId *string
// Ground truth data to compare against agent responses during evaluation. Allows
// to provide expected responses, assertions, and expected tool trajectories at
// different evaluation levels. Session-level reference inputs apply to the entire
// conversation, while trace-level reference inputs target specific
// request-response interactions identified by trace ID.
EvaluationReferenceInputs []types.EvaluationReferenceInput
// The specific trace or span IDs to evaluate within the provided input. Allows
// targeting evaluation at different levels: individual tool calls, single
// request-response interactions (traces), or entire conversation sessions.
EvaluationTarget types.EvaluationTarget
// contains filtered or unexported fields
}
func (*EvaluateInput) Serialize ¶ added in v1.28.3
func (v *EvaluateInput) Serialize(s smithy.ShapeSerializer)
func (*EvaluateInput) SerializeMembers ¶ added in v1.28.3
func (v *EvaluateInput) SerializeMembers(s smithy.ShapeSerializer)
type EvaluateOutput ¶ added in v1.10.0
type EvaluateOutput struct {
// The detailed evaluation results containing scores, explanations, and metadata.
// Includes the evaluator information, numerical or categorical ratings based on
// the evaluator's rating scale, and token usage statistics for the evaluation
// process.
//
// This member is required.
EvaluationResults []types.EvaluationResultContent
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*EvaluateOutput) Deserialize ¶ added in v1.28.3
func (v *EvaluateOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*EvaluateOutput) Serialize ¶ added in v1.53.0
func (v *EvaluateOutput) Serialize(s smithy.ShapeSerializer)
func (*EvaluateOutput) SerializeMembers ¶ added in v1.53.0
func (v *EvaluateOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetABTestInput ¶ added in v1.23.0
type GetABTestInput struct {
// The unique identifier of the A/B test to retrieve.
//
// This member is required.
AbTestId *string
// contains filtered or unexported fields
}
func (*GetABTestInput) Serialize ¶ added in v1.28.3
func (v *GetABTestInput) Serialize(s smithy.ShapeSerializer)
func (*GetABTestInput) SerializeMembers ¶ added in v1.28.3
func (v *GetABTestInput) SerializeMembers(s smithy.ShapeSerializer)
type GetABTestOutput ¶ added in v1.23.0
type GetABTestOutput struct {
// The Amazon Resource Name (ARN) of the A/B test.
//
// This member is required.
AbTestArn *string
// The unique identifier of the A/B test.
//
// This member is required.
AbTestId *string
// The timestamp when the A/B test was created.
//
// This member is required.
CreatedAt *time.Time
// The evaluation configuration for measuring variant performance.
//
// This member is required.
EvaluationConfig types.ABTestEvaluationConfig
// The execution status indicating whether the A/B test is currently running.
//
// This member is required.
ExecutionStatus types.ABTestExecutionStatus
// The Amazon Resource Name (ARN) of the gateway used for traffic splitting.
//
// This member is required.
GatewayArn *string
// The name of the A/B test.
//
// This member is required.
Name *string
// The current status of the A/B test.
//
// This member is required.
Status types.ABTestStatus
// The timestamp when the A/B test was last updated.
//
// This member is required.
UpdatedAt *time.Time
// The list of variants in the A/B test.
//
// This member is required.
Variants []types.Variant
// The identifier of the current run of the A/B test.
CurrentRunId *string
// The description of the A/B test.
Description *string
// The error details if the A/B test encountered failures.
ErrorDetails []string
// The gateway filter restricting which target paths are included.
GatewayFilter *types.GatewayFilter
// The timestamp when the A/B test will automatically expire.
MaxDurationExpiresAt *time.Time
// The statistical results of the A/B test, including per-evaluator metrics and
// significance analysis.
Results *types.ABTestResults
// The IAM role ARN used by the A/B test.
RoleArn *string
// The timestamp when the A/B test was started.
StartedAt *time.Time
// The timestamp when the A/B test was stopped.
StoppedAt *time.Time
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetABTestOutput) Deserialize ¶ added in v1.28.3
func (v *GetABTestOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetABTestOutput) Serialize ¶ added in v1.53.0
func (v *GetABTestOutput) Serialize(s smithy.ShapeSerializer)
func (*GetABTestOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetABTestOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetAgentCardInput ¶ added in v1.5.0
type GetAgentCardInput struct {
// The ARN of the AgentCore Runtime agent for which you want to get the A2A agent
// card.
//
// This member is required.
AgentRuntimeArn *string
// Optional qualifier to specify an agent alias, such as prod code> or dev . If you
// don't provide a value, the DEFAULT alias is used.
Qualifier *string
// The session ID that the AgentCore Runtime agent is using.
RuntimeSessionId *string
// contains filtered or unexported fields
}
func (*GetAgentCardInput) Serialize ¶ added in v1.28.3
func (v *GetAgentCardInput) Serialize(s smithy.ShapeSerializer)
func (*GetAgentCardInput) SerializeMembers ¶ added in v1.28.3
func (v *GetAgentCardInput) SerializeMembers(s smithy.ShapeSerializer)
type GetAgentCardOutput ¶ added in v1.5.0
type GetAgentCardOutput struct {
// An agent card document that contains metadata and capabilities for an AgentCore
// Runtime agent.
//
// This member is required.
AgentCard document.Interface
// The ID of the session associated with the AgentCore Runtime agent.
RuntimeSessionId *string
// The status code of the request.
StatusCode *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetAgentCardOutput) Deserialize ¶ added in v1.28.3
func (v *GetAgentCardOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetAgentCardOutput) Serialize ¶ added in v1.53.0
func (v *GetAgentCardOutput) Serialize(s smithy.ShapeSerializer)
func (*GetAgentCardOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetAgentCardOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetAgentInsightInput ¶ added in v1.59.0
type GetAgentInsightInput struct {
// The unique identifier of the Agent Insight to retrieve.
//
// This member is required.
AgentInsightId *string
// The application that the Agent Insight belongs to.
//
// This member is required.
ApplicationName *string
// contains filtered or unexported fields
}
func (*GetAgentInsightInput) Serialize ¶ added in v1.59.0
func (v *GetAgentInsightInput) Serialize(s smithy.ShapeSerializer)
func (*GetAgentInsightInput) SerializeMembers ¶ added in v1.59.0
func (v *GetAgentInsightInput) SerializeMembers(s smithy.ShapeSerializer)
type GetAgentInsightOutput ¶ added in v1.59.0
type GetAgentInsightOutput struct {
// The unique identifier of the Agent Insight.
//
// This member is required.
AgentInsightId *string
// The application that the Agent Insight belongs to.
//
// This member is required.
ApplicationName *string
// Specifies whether the Agent Insight is active or archived. Valid values:
//
// - ACTIVE - The insight is currently active.
//
// - ARCHIVED - The insight has been archived.
//
// This member is required.
ArchiveStatus types.AgentInsightArchiveStatus
// The date and time when the Agent Insight was first created.
//
// This member is required.
CreatedAt *time.Time
// Specifies whether customer-encrypted metadata is available for the Agent
// Insight.
//
// This member is required.
CustomerMetadataStatus types.AgentInsightCustomerMetadataStatus
// A generated description of the Agent Insight that explains the detected pattern
// and its observed behavior across sessions.
//
// This member is required.
Description *string
// A generated display label for the Agent Insight. This is a human-readable
// summary of the detected pattern, not an identifier.
//
// This member is required.
Name *string
// The type of insight.
//
// This member is required.
Type types.InsightType
// The date and time when the Agent Insight was last updated.
//
// This member is required.
UpdatedAt *time.Time
// The number of sessions affected by the insight pattern.
AffectedSessionCount *int32
// The Batch Evaluation that produced this Insight, when applicable.
BatchEvaluationId *string
// The most recent date and time when the insight pattern was observed.
LastSeenAt *time.Time
// The root causes identified for the Agent Insight, each with an explanation, an
// affected session count, an optional suggested fix, and sample sessions that
// illustrate the root cause.
RootCauses []types.InsightRootCause
// A list of sample sessions that illustrate the Agent Insight, including
// per-session findings that point to the relevant spans or traces.
SampleSessions []types.SampleSession
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetAgentInsightOutput) Deserialize ¶ added in v1.59.0
func (v *GetAgentInsightOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetAgentInsightOutput) Serialize ¶ added in v1.59.0
func (v *GetAgentInsightOutput) Serialize(s smithy.ShapeSerializer)
func (*GetAgentInsightOutput) SerializeMembers ¶ added in v1.59.0
func (v *GetAgentInsightOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetBatchEvaluationInput ¶ added in v1.23.0
type GetBatchEvaluationInput struct {
// The unique identifier of the batch evaluation to retrieve.
//
// This member is required.
BatchEvaluationId *string
// contains filtered or unexported fields
}
func (*GetBatchEvaluationInput) Serialize ¶ added in v1.28.3
func (v *GetBatchEvaluationInput) Serialize(s smithy.ShapeSerializer)
func (*GetBatchEvaluationInput) SerializeMembers ¶ added in v1.28.3
func (v *GetBatchEvaluationInput) SerializeMembers(s smithy.ShapeSerializer)
type GetBatchEvaluationOutput ¶ added in v1.23.0
type GetBatchEvaluationOutput struct {
// The Amazon Resource Name (ARN) of the batch evaluation.
//
// This member is required.
BatchEvaluationArn *string
// The unique identifier of the batch evaluation.
//
// This member is required.
BatchEvaluationId *string
// The name of the batch evaluation.
//
// This member is required.
BatchEvaluationName *string
// The timestamp when the batch evaluation was created.
//
// This member is required.
CreatedAt *time.Time
// The current status of the batch evaluation.
//
// This member is required.
Status types.BatchEvaluationStatus
// The data source configuration specifying where agent traces are pulled from.
DataSourceConfig types.DataSourceConfig
// The details of the dataset and agent that the batch evaluation ran, including
// the dataset version and agent runtime version that the service resolved when the
// batch evaluation started. This field is present only if the batch evaluation was
// started with a datasetExecutionConfig .
DatasetExecutionDetails *types.DatasetExecutionDetails
// The description of the batch evaluation.
Description *string
// The error details if the batch evaluation encountered failures.
ErrorDetails []string
// The aggregated evaluation results, including session completion counts and
// evaluator score summaries.
EvaluationResults *types.EvaluationJobResults
// The list of evaluators applied during the batch evaluation.
Evaluators []types.Evaluator
// The execution summary clustering results from insights, containing grouped
// execution patterns across evaluated sessions.
ExecutionSummaryResult *types.ExecutionSummaryClusteringResultContent
// The failure analysis results from insights, containing categorized failure
// clusters with root causes and recommendations.
FailureAnalysisResult *types.FailureAnalysisResultContent
// The insights generated when the batch evaluation includes the
// Builtin.FailureAnalysis evaluator. Each insight groups related failures found
// across the evaluated sessions. An empty list means that no failures were found.
// If the analysis fails, this field is omitted and errorDetails describes the
// error.
InsightResults []types.InsightResult
// The list of insight analyses applied during the batch evaluation.
Insights []types.Insight
// The ARN of the KMS key used to encrypt evaluation data.
KmsKeyArn *string
// The output configuration specifying where evaluation results are written.
OutputConfig types.OutputConfig
// The timestamp when the batch evaluation was last updated.
UpdatedAt *time.Time
// The user intent clustering results from insights, containing grouped user
// intents across evaluated sessions.
UserIntentResult *types.UserIntentClusteringResultContent
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetBatchEvaluationOutput) Deserialize ¶ added in v1.28.3
func (v *GetBatchEvaluationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetBatchEvaluationOutput) Serialize ¶ added in v1.53.0
func (v *GetBatchEvaluationOutput) Serialize(s smithy.ShapeSerializer)
func (*GetBatchEvaluationOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetBatchEvaluationOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetBrowserSessionInput ¶
type GetBrowserSessionInput struct {
// The unique identifier of the browser associated with the session.
//
// This member is required.
BrowserIdentifier *string
// The unique identifier of the browser session to retrieve.
//
// This member is required.
SessionId *string
// contains filtered or unexported fields
}
func (*GetBrowserSessionInput) Serialize ¶ added in v1.28.3
func (v *GetBrowserSessionInput) Serialize(s smithy.ShapeSerializer)
func (*GetBrowserSessionInput) SerializeMembers ¶ added in v1.28.3
func (v *GetBrowserSessionInput) SerializeMembers(s smithy.ShapeSerializer)
type GetBrowserSessionOutput ¶
type GetBrowserSessionOutput struct {
// The identifier of the browser.
//
// This member is required.
BrowserIdentifier *string
// The time at which the browser session was created.
//
// This member is required.
CreatedAt *time.Time
// The identifier of the browser session.
//
// This member is required.
SessionId *string
// The list of certificates installed in the browser session.
Certificates []types.Certificate
// A list of files containing enterprise policies for the browser session.
EnterprisePolicies []types.BrowserEnterprisePolicy
// The list of browser extensions that are configured in the browser session.
Extensions []types.BrowserExtension
// The file system configurations for the browser session. Each entry describes an
// access point and its mount path.
FilesystemConfigurations []types.ToolsFileSystemConfiguration
// The time at which the browser session was last updated.
LastUpdatedAt *time.Time
// The name of the browser session.
Name *string
// The browser profile configuration associated with this session. Contains the
// profile identifier that links to persistent browser data such as cookies and
// local storage.
ProfileConfiguration *types.BrowserProfileConfiguration
// The active proxy configuration for this browser session. This field is only
// present if proxy configuration was provided when the session was started using
// StartBrowserSession . The configuration includes proxy servers, domain bypass
// rules and the proxy authentication credentials.
ProxyConfiguration *types.ProxyConfiguration
// The artifact containing the session replay information.
SessionReplayArtifact *string
// The timeout period for the browser session in seconds.
SessionTimeoutSeconds *int32
// The current status of the browser session. Possible values include ACTIVE,
// STOPPING, and STOPPED.
Status types.BrowserSessionStatus
// The streams associated with this browser session. These include the automation
// stream and live view stream.
Streams *types.BrowserSessionStream
// The configuration that defines the dimensions of a browser viewport in a
// browser session. The viewport determines the visible area of web content and
// affects how web pages are rendered and displayed. Proper viewport configuration
// ensures that web content is displayed correctly for the agent's browsing tasks.
ViewPort *types.ViewPort
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetBrowserSessionOutput) Deserialize ¶ added in v1.28.3
func (v *GetBrowserSessionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetBrowserSessionOutput) Serialize ¶ added in v1.53.0
func (v *GetBrowserSessionOutput) Serialize(s smithy.ShapeSerializer)
func (*GetBrowserSessionOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetBrowserSessionOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetCodeInterpreterSessionInput ¶
type GetCodeInterpreterSessionInput struct {
// The unique identifier of the code interpreter associated with the session.
//
// This member is required.
CodeInterpreterIdentifier *string
// The unique identifier of the code interpreter session to retrieve.
//
// This member is required.
SessionId *string
// contains filtered or unexported fields
}
func (*GetCodeInterpreterSessionInput) Serialize ¶ added in v1.28.3
func (v *GetCodeInterpreterSessionInput) Serialize(s smithy.ShapeSerializer)
func (*GetCodeInterpreterSessionInput) SerializeMembers ¶ added in v1.28.3
func (v *GetCodeInterpreterSessionInput) SerializeMembers(s smithy.ShapeSerializer)
type GetCodeInterpreterSessionOutput ¶
type GetCodeInterpreterSessionOutput struct {
// The identifier of the code interpreter.
//
// This member is required.
CodeInterpreterIdentifier *string
// The time at which the code interpreter session was created.
//
// This member is required.
CreatedAt *time.Time
// The identifier of the code interpreter session.
//
// This member is required.
SessionId *string
// The list of certificates installed in the code interpreter session.
Certificates []types.Certificate
// The file system configurations for the code interpreter session. Each entry
// describes an access point and its mount path.
FilesystemConfigurations []types.ToolsFileSystemConfiguration
// The name of the code interpreter session.
Name *string
// The timeout period for the code interpreter session in seconds.
SessionTimeoutSeconds *int32
// The current status of the code interpreter session. Possible values include
// ACTIVE, STOPPING, and STOPPED.
Status types.CodeInterpreterSessionStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetCodeInterpreterSessionOutput) Deserialize ¶ added in v1.28.3
func (v *GetCodeInterpreterSessionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetCodeInterpreterSessionOutput) Serialize ¶ added in v1.53.0
func (v *GetCodeInterpreterSessionOutput) Serialize(s smithy.ShapeSerializer)
func (*GetCodeInterpreterSessionOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetCodeInterpreterSessionOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetDatasetGenerationInput ¶ added in v1.59.0
type GetDatasetGenerationInput struct {
// The unique identifier of the dataset.
//
// This member is required.
DatasetId *string
// The unique identifier of the dataset generation.
//
// This member is required.
GenerationId *string
// contains filtered or unexported fields
}
func (*GetDatasetGenerationInput) Serialize ¶ added in v1.59.0
func (v *GetDatasetGenerationInput) Serialize(s smithy.ShapeSerializer)
func (*GetDatasetGenerationInput) SerializeMembers ¶ added in v1.59.0
func (v *GetDatasetGenerationInput) SerializeMembers(s smithy.ShapeSerializer)
type GetDatasetGenerationOutput ¶ added in v1.59.0
type GetDatasetGenerationOutput struct {
// The time at which the dataset generation started.
//
// This member is required.
CreatedAt *time.Time
// The unique identifier of the dataset.
//
// This member is required.
DatasetId *string
// The unique identifier of the dataset generation.
//
// This member is required.
GenerationId *string
// The name of the dataset generation.
//
// This member is required.
Name *string
// The type of scenario the generation produces. This is the value from the
// request, or DYNAMIC if the request didn't specify one.
//
// This member is required.
ScenarioType types.ScenarioType
// The status of the dataset generation.
//
// This member is required.
Status types.DatasetGenerationStatus
// The time at which the dataset generation finished. Present only when the
// generation has finished.
CompletedAt *time.Time
// The description of the dataset generation.
Description *string
// The errors the generation hit, grouped by error code. The list holds the 10
// most frequent error codes, most frequent first.
ErrorDetails []types.GenerationErrorDetail
// The reason the dataset generation failed. Present only when the status is FAILED
// .
FailureReason *string
// Counts of the sessions, scenarios and examples the generation has processed.
GenerationResults *types.GenerationResults
// A summary of what redaction found. Present only when the generation was started
// with redaction.
RedactionSummary *types.RedactionSummary
// The source the generation was started with, including the resolved time window.
// If you selected sessions and traces by ID, the response gives the number of IDs
// instead of the IDs.
Source types.GenerationSourceRecord
// The time at which the dataset generation last changed status.
UpdatedAt *time.Time
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetDatasetGenerationOutput) Deserialize ¶ added in v1.59.0
func (v *GetDatasetGenerationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetDatasetGenerationOutput) Serialize ¶ added in v1.59.0
func (v *GetDatasetGenerationOutput) Serialize(s smithy.ShapeSerializer)
func (*GetDatasetGenerationOutput) SerializeMembers ¶ added in v1.59.0
func (v *GetDatasetGenerationOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetEventInput ¶
type GetEventInput struct {
// The identifier of the actor associated with the event.
//
// This member is required.
ActorId *string
// The identifier of the event to retrieve.
//
// This member is required.
EventId *string
// The identifier of the AgentCore Memory resource containing the event.
//
// This member is required.
MemoryId *string
// The identifier of the session containing the event.
//
// This member is required.
SessionId *string
// contains filtered or unexported fields
}
func (*GetEventInput) Serialize ¶ added in v1.28.3
func (v *GetEventInput) Serialize(s smithy.ShapeSerializer)
func (*GetEventInput) SerializeMembers ¶ added in v1.28.3
func (v *GetEventInput) SerializeMembers(s smithy.ShapeSerializer)
type GetEventOutput ¶
type GetEventOutput struct {
// The requested event information.
//
// This member is required.
Event *types.Event
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetEventOutput) Deserialize ¶ added in v1.28.3
func (v *GetEventOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetEventOutput) Serialize ¶ added in v1.53.0
func (v *GetEventOutput) Serialize(s smithy.ShapeSerializer)
func (*GetEventOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetEventOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetMemoryRecordInput ¶
type GetMemoryRecordInput struct {
// The identifier of the AgentCore Memory resource containing the memory record.
//
// This member is required.
MemoryId *string
// The identifier of the memory record to retrieve.
//
// This member is required.
MemoryRecordId *string
// The namespace of the memory record to retrieve. This value is used for IAM
// condition key authorization.
Namespace *string
// contains filtered or unexported fields
}
func (*GetMemoryRecordInput) Serialize ¶ added in v1.28.3
func (v *GetMemoryRecordInput) Serialize(s smithy.ShapeSerializer)
func (*GetMemoryRecordInput) SerializeMembers ¶ added in v1.28.3
func (v *GetMemoryRecordInput) SerializeMembers(s smithy.ShapeSerializer)
type GetMemoryRecordOutput ¶
type GetMemoryRecordOutput struct {
// The requested memory record.
//
// This member is required.
MemoryRecord *types.MemoryRecord
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetMemoryRecordOutput) Deserialize ¶ added in v1.28.3
func (v *GetMemoryRecordOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetMemoryRecordOutput) Serialize ¶ added in v1.53.0
func (v *GetMemoryRecordOutput) Serialize(s smithy.ShapeSerializer)
func (*GetMemoryRecordOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetMemoryRecordOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetPaymentInstrumentBalanceInput ¶ added in v1.25.0
type GetPaymentInstrumentBalanceInput struct {
// The specific blockchain chain to query balance on. Required because balances
// are chain-specific.
//
// This member is required.
Chain types.BlockchainChainId
// The ID of the payment connector associated with this instrument.
//
// This member is required.
PaymentConnectorId *string
// The ID of the payment instrument to query balance for.
//
// This member is required.
PaymentInstrumentId *string
// The ARN of the payment manager that owns this payment instrument.
//
// This member is required.
PaymentManagerArn *string
// The token to query balance for. Only tokens supported for X402 payments are
// returned.
//
// This member is required.
Token types.InstrumentBalanceToken
// The agent name associated with this request, used for observability.
AgentName *string
// The user ID associated with this payment instrument.
UserId *string
// contains filtered or unexported fields
}
Request structure for getting payment instrument balance.
func (*GetPaymentInstrumentBalanceInput) Serialize ¶ added in v1.28.3
func (v *GetPaymentInstrumentBalanceInput) Serialize(s smithy.ShapeSerializer)
func (*GetPaymentInstrumentBalanceInput) SerializeMembers ¶ added in v1.28.3
func (v *GetPaymentInstrumentBalanceInput) SerializeMembers(s smithy.ShapeSerializer)
type GetPaymentInstrumentBalanceOutput ¶ added in v1.25.0
type GetPaymentInstrumentBalanceOutput struct {
// The ID of the payment instrument.
//
// This member is required.
PaymentInstrumentId *string
// The balance of the supported token on the requested chain.
//
// This member is required.
TokenBalance *types.TokenBalance
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for getting payment instrument balance.
func (*GetPaymentInstrumentBalanceOutput) Deserialize ¶ added in v1.28.3
func (v *GetPaymentInstrumentBalanceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetPaymentInstrumentBalanceOutput) Serialize ¶ added in v1.53.0
func (v *GetPaymentInstrumentBalanceOutput) Serialize(s smithy.ShapeSerializer)
func (*GetPaymentInstrumentBalanceOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetPaymentInstrumentBalanceOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetPaymentInstrumentInput ¶ added in v1.25.0
type GetPaymentInstrumentInput struct {
// The ID of the payment instrument to retrieve.
//
// This member is required.
PaymentInstrumentId *string
// The ARN of the payment manager that owns this payment instrument.
//
// This member is required.
PaymentManagerArn *string
// The agent name associated with this request, used for observability.
AgentName *string
// The ID of the payment connector.
PaymentConnectorId *string
// The user ID associated with this payment instrument.
UserId *string
// contains filtered or unexported fields
}
Request structure for getting a payment instrument.
func (*GetPaymentInstrumentInput) Serialize ¶ added in v1.28.3
func (v *GetPaymentInstrumentInput) Serialize(s smithy.ShapeSerializer)
func (*GetPaymentInstrumentInput) SerializeMembers ¶ added in v1.28.3
func (v *GetPaymentInstrumentInput) SerializeMembers(s smithy.ShapeSerializer)
type GetPaymentInstrumentOutput ¶ added in v1.25.0
type GetPaymentInstrumentOutput struct {
// The payment instrument details.
//
// This member is required.
PaymentInstrument *types.PaymentInstrument
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for getting a payment instrument.
func (*GetPaymentInstrumentOutput) Deserialize ¶ added in v1.28.3
func (v *GetPaymentInstrumentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetPaymentInstrumentOutput) Serialize ¶ added in v1.53.0
func (v *GetPaymentInstrumentOutput) Serialize(s smithy.ShapeSerializer)
func (*GetPaymentInstrumentOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetPaymentInstrumentOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetPaymentSessionInput ¶ added in v1.25.0
type GetPaymentSessionInput struct {
// The ARN of the payment manager that owns this session.
//
// This member is required.
PaymentManagerArn *string
// The ID of the payment session to retrieve.
//
// This member is required.
PaymentSessionId *string
// The agent name associated with this request, used for observability.
AgentName *string
// The user ID associated with this payment session.
UserId *string
// contains filtered or unexported fields
}
Request structure for getting a payment session.
func (*GetPaymentSessionInput) Serialize ¶ added in v1.28.3
func (v *GetPaymentSessionInput) Serialize(s smithy.ShapeSerializer)
func (*GetPaymentSessionInput) SerializeMembers ¶ added in v1.28.3
func (v *GetPaymentSessionInput) SerializeMembers(s smithy.ShapeSerializer)
type GetPaymentSessionOutput ¶ added in v1.25.0
type GetPaymentSessionOutput struct {
// The payment session details.
//
// This member is required.
PaymentSession *types.PaymentSession
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for getting a payment session.
func (*GetPaymentSessionOutput) Deserialize ¶ added in v1.28.3
func (v *GetPaymentSessionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetPaymentSessionOutput) Serialize ¶ added in v1.53.0
func (v *GetPaymentSessionOutput) Serialize(s smithy.ShapeSerializer)
func (*GetPaymentSessionOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetPaymentSessionOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetRecommendationInput ¶ added in v1.23.0
type GetRecommendationInput struct {
// The unique identifier of the recommendation to retrieve.
//
// This member is required.
RecommendationId *string
// contains filtered or unexported fields
}
func (*GetRecommendationInput) Serialize ¶ added in v1.28.3
func (v *GetRecommendationInput) Serialize(s smithy.ShapeSerializer)
func (*GetRecommendationInput) SerializeMembers ¶ added in v1.28.3
func (v *GetRecommendationInput) SerializeMembers(s smithy.ShapeSerializer)
type GetRecommendationOutput ¶ added in v1.23.0
type GetRecommendationOutput struct {
// The timestamp when the recommendation was created.
//
// This member is required.
CreatedAt *time.Time
// The name of the recommendation.
//
// This member is required.
Name *string
// The Amazon Resource Name (ARN) of the recommendation.
//
// This member is required.
RecommendationArn *string
// The configuration for the recommendation.
//
// This member is required.
RecommendationConfig types.RecommendationConfig
// The unique identifier of the recommendation.
//
// This member is required.
RecommendationId *string
// The current status of the recommendation.
//
// This member is required.
Status types.RecommendationStatus
// The type of recommendation.
//
// This member is required.
Type types.RecommendationType
// The timestamp when the recommendation was last updated.
//
// This member is required.
UpdatedAt *time.Time
// The description of the recommendation.
Description *string
// The ARN of the KMS key used to encrypt recommendation data.
KmsKeyArn *string
// The result of the recommendation, containing the optimized system prompt or
// tool descriptions. Only present when the recommendation status is COMPLETED .
RecommendationResult types.RecommendationResult
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetRecommendationOutput) Deserialize ¶ added in v1.28.3
func (v *GetRecommendationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetRecommendationOutput) Serialize ¶ added in v1.53.0
func (v *GetRecommendationOutput) Serialize(s smithy.ShapeSerializer)
func (*GetRecommendationOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetRecommendationOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetResourceApiKeyInput ¶
type GetResourceApiKeyInput struct {
// The credential provider name for the resource from which you are retrieving the
// API key.
//
// This member is required.
ResourceCredentialProviderName *string
// The identity token of the workload from which you want to retrieve the API key.
//
// This member is required.
WorkloadIdentityToken *string
// contains filtered or unexported fields
}
func (*GetResourceApiKeyInput) Serialize ¶ added in v1.28.3
func (v *GetResourceApiKeyInput) Serialize(s smithy.ShapeSerializer)
func (*GetResourceApiKeyInput) SerializeMembers ¶ added in v1.28.3
func (v *GetResourceApiKeyInput) SerializeMembers(s smithy.ShapeSerializer)
type GetResourceApiKeyOutput ¶
type GetResourceApiKeyOutput struct {
// The API key associated with the resource requested.
//
// This member is required.
ApiKey *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetResourceApiKeyOutput) Deserialize ¶ added in v1.28.3
func (v *GetResourceApiKeyOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetResourceApiKeyOutput) Serialize ¶ added in v1.53.0
func (v *GetResourceApiKeyOutput) Serialize(s smithy.ShapeSerializer)
func (*GetResourceApiKeyOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetResourceApiKeyOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetResourceOauth2TokenInput ¶
type GetResourceOauth2TokenInput struct {
// The type of flow to be performed.
//
// This member is required.
Oauth2Flow types.Oauth2FlowType
// The name of the resource's credential provider.
//
// This member is required.
ResourceCredentialProviderName *string
// The OAuth scopes being requested.
//
// This member is required.
Scopes []string
// The identity token of the workload from which you want to retrieve the OAuth2
// token.
//
// This member is required.
WorkloadIdentityToken *string
// The audiences to include in the token request. These are used to specify the
// intended recipients of the OAuth2 token.
Audiences []string
// A map of custom parameters to include in the authorization request to the
// resource credential provider. These parameters are in addition to the standard
// OAuth 2.0 flow parameters, and will not override them.
CustomParameters map[string]string
// An opaque string that will be sent back to the callback URL provided in
// resourceOauth2ReturnUrl. This state should be used to protect the callback URL
// of your application against CSRF attacks by ensuring the response corresponds to
// the original request.
CustomState *string
// Indicates whether to always initiate a new three-legged OAuth (3LO) flow,
// regardless of any existing session.
ForceAuthentication *bool
// The callback URL to redirect to after the OAuth 2.0 token retrieval is
// complete. This URL must be one of the provided URLs configured for the workload
// identity.
ResourceOauth2ReturnUrl *string
// The resources to include in the token request. These are used to specify the
// target resources for which the OAuth2 token is being requested.
Resources []string
// Unique identifier for the user's authentication session for retrieving OAuth2
// tokens. This ID tracks the authorization flow state across multiple requests and
// responses during the OAuth2 authentication process.
SessionUri *string
// contains filtered or unexported fields
}
func (*GetResourceOauth2TokenInput) Serialize ¶ added in v1.28.3
func (v *GetResourceOauth2TokenInput) Serialize(s smithy.ShapeSerializer)
func (*GetResourceOauth2TokenInput) SerializeMembers ¶ added in v1.28.3
func (v *GetResourceOauth2TokenInput) SerializeMembers(s smithy.ShapeSerializer)
type GetResourceOauth2TokenOutput ¶
type GetResourceOauth2TokenOutput struct {
// The OAuth 2.0 access token to use.
AccessToken *string
// The URL to initiate the authorization process, provided when the access token
// requires user authorization.
AuthorizationUrl *string
// Status indicating whether the user's authorization session is in progress or
// has failed. This helps determine the next steps in the OAuth2 authentication
// flow.
SessionStatus types.SessionStatus
// Unique identifier for the user's authorization session for retrieving OAuth2
// tokens. This matches the sessionId from the request and can be used to track the
// session state.
SessionUri *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetResourceOauth2TokenOutput) Deserialize ¶ added in v1.28.3
func (v *GetResourceOauth2TokenOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetResourceOauth2TokenOutput) Serialize ¶ added in v1.53.0
func (v *GetResourceOauth2TokenOutput) Serialize(s smithy.ShapeSerializer)
func (*GetResourceOauth2TokenOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetResourceOauth2TokenOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetResourcePaymentTokenInput ¶ added in v1.25.0
type GetResourcePaymentTokenInput struct {
// Vendor-specific token request input. Contains all request parameters in a
// type-safe, vendor-specific structure.
//
// This member is required.
PaymentTokenRequest types.PaymentTokenRequestInput
// Name of the payment credential provider to use.
//
// This member is required.
ResourceCredentialProviderName *string
// Workload access token for authorization.
//
// This member is required.
WorkloadIdentityToken *string
// contains filtered or unexported fields
}
func (*GetResourcePaymentTokenInput) Serialize ¶ added in v1.28.3
func (v *GetResourcePaymentTokenInput) Serialize(s smithy.ShapeSerializer)
func (*GetResourcePaymentTokenInput) SerializeMembers ¶ added in v1.28.3
func (v *GetResourcePaymentTokenInput) SerializeMembers(s smithy.ShapeSerializer)
type GetResourcePaymentTokenOutput ¶ added in v1.25.0
type GetResourcePaymentTokenOutput struct {
// Vendor-specific token response output. Contains all response data in a
// type-safe, vendor-specific structure.
//
// This member is required.
PaymentTokenResponse types.PaymentTokenResponseOutput
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetResourcePaymentTokenOutput) Deserialize ¶ added in v1.28.3
func (v *GetResourcePaymentTokenOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetResourcePaymentTokenOutput) Serialize ¶ added in v1.53.0
func (v *GetResourcePaymentTokenOutput) Serialize(s smithy.ShapeSerializer)
func (*GetResourcePaymentTokenOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetResourcePaymentTokenOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetWorkloadAccessTokenForJWTInput ¶
type GetWorkloadAccessTokenForJWTInput struct {
// The OAuth 2.0 token issued by the user's identity provider.
//
// This member is required.
UserToken *string
// The unique identifier for the registered workload.
//
// This member is required.
WorkloadName *string
// contains filtered or unexported fields
}
func (*GetWorkloadAccessTokenForJWTInput) Serialize ¶ added in v1.28.3
func (v *GetWorkloadAccessTokenForJWTInput) Serialize(s smithy.ShapeSerializer)
func (*GetWorkloadAccessTokenForJWTInput) SerializeMembers ¶ added in v1.28.3
func (v *GetWorkloadAccessTokenForJWTInput) SerializeMembers(s smithy.ShapeSerializer)
type GetWorkloadAccessTokenForJWTOutput ¶
type GetWorkloadAccessTokenForJWTOutput struct {
// An opaque token representing the identity of both the workload and the user.
//
// This member is required.
WorkloadAccessToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetWorkloadAccessTokenForJWTOutput) Deserialize ¶ added in v1.28.3
func (v *GetWorkloadAccessTokenForJWTOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetWorkloadAccessTokenForJWTOutput) Serialize ¶ added in v1.53.0
func (v *GetWorkloadAccessTokenForJWTOutput) Serialize(s smithy.ShapeSerializer)
func (*GetWorkloadAccessTokenForJWTOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetWorkloadAccessTokenForJWTOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetWorkloadAccessTokenForUserIdInput ¶
type GetWorkloadAccessTokenForUserIdInput struct {
// The ID of the user for whom you are retrieving the access token.
//
// This member is required.
UserId *string
// The name of the workload from which you want to retrieve the access token.
//
// This member is required.
WorkloadName *string
// contains filtered or unexported fields
}
func (*GetWorkloadAccessTokenForUserIdInput) Serialize ¶ added in v1.28.3
func (v *GetWorkloadAccessTokenForUserIdInput) Serialize(s smithy.ShapeSerializer)
func (*GetWorkloadAccessTokenForUserIdInput) SerializeMembers ¶ added in v1.28.3
func (v *GetWorkloadAccessTokenForUserIdInput) SerializeMembers(s smithy.ShapeSerializer)
type GetWorkloadAccessTokenForUserIdOutput ¶
type GetWorkloadAccessTokenForUserIdOutput struct {
// The access token for the specified workload.
//
// This member is required.
WorkloadAccessToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetWorkloadAccessTokenForUserIdOutput) Deserialize ¶ added in v1.28.3
func (v *GetWorkloadAccessTokenForUserIdOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetWorkloadAccessTokenForUserIdOutput) Serialize ¶ added in v1.53.0
func (v *GetWorkloadAccessTokenForUserIdOutput) Serialize(s smithy.ShapeSerializer)
func (*GetWorkloadAccessTokenForUserIdOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetWorkloadAccessTokenForUserIdOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetWorkloadAccessTokenInput ¶
type GetWorkloadAccessTokenInput struct {
// The unique identifier for the registered workload.
//
// This member is required.
WorkloadName *string
// contains filtered or unexported fields
}
func (*GetWorkloadAccessTokenInput) Serialize ¶ added in v1.28.3
func (v *GetWorkloadAccessTokenInput) Serialize(s smithy.ShapeSerializer)
func (*GetWorkloadAccessTokenInput) SerializeMembers ¶ added in v1.28.3
func (v *GetWorkloadAccessTokenInput) SerializeMembers(s smithy.ShapeSerializer)
type GetWorkloadAccessTokenOutput ¶
type GetWorkloadAccessTokenOutput struct {
// An opaque token representing the identity of both the workload and the user.
//
// This member is required.
WorkloadAccessToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetWorkloadAccessTokenOutput) Deserialize ¶ added in v1.28.3
func (v *GetWorkloadAccessTokenOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetWorkloadAccessTokenOutput) Serialize ¶ added in v1.53.0
func (v *GetWorkloadAccessTokenOutput) Serialize(s smithy.ShapeSerializer)
func (*GetWorkloadAccessTokenOutput) SerializeMembers ¶ added in v1.53.0
func (v *GetWorkloadAccessTokenOutput) SerializeMembers(s smithy.ShapeSerializer)
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type IngestDataInput ¶ added in v1.43.0
type IngestDataInput struct {
// The identifier of the actor associated with this content. An actor represents
// an entity that participates in sessions and generates content.
//
// This member is required.
ActorId *string
// The timestamp of when the content occurred.
//
// This member is required.
ContentTimestamp *time.Time
// The identifier of the AgentCore Memory resource to ingest content into.
//
// This member is required.
MemoryId *string
// The content to ingest. Only inline content is supported.
//
// This member is required.
Source types.ContentSource
// A unique, case-sensitive identifier to ensure that the operation completes no
// more than one time. If this token matches a previous request, AgentCore ignores
// the request, but does not return an error.
ClientToken *string
// The extraction configuration for long-term memory records. Use this parameter
// to specify namespace variable keys and their values for namespace substitution
// during extraction.
ExtractionConfig *types.ExtractionConfig
// The key-value metadata to attach to the content.
Metadata map[string]types.MetadataValue
// The identifier of the session that the content belongs to. If not provided, a
// session identifier is generated and returned in the response.
SessionId *string
// contains filtered or unexported fields
}
func (*IngestDataInput) Serialize ¶ added in v1.53.0
func (v *IngestDataInput) Serialize(s smithy.ShapeSerializer)
func (*IngestDataInput) SerializeMembers ¶ added in v1.53.0
func (v *IngestDataInput) SerializeMembers(s smithy.ShapeSerializer)
type IngestDataOutput ¶ added in v1.43.0
type IngestDataOutput struct {
// The identifier of the session that the service ingested the content into. This
// value echoes the session identifier from the request, or the identifier that the
// service generated when you did not provide one.
//
// This member is required.
SessionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*IngestDataOutput) Deserialize ¶ added in v1.53.0
func (v *IngestDataOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*IngestDataOutput) Serialize ¶ added in v1.53.0
func (v *IngestDataOutput) Serialize(s smithy.ShapeSerializer)
func (*IngestDataOutput) SerializeMembers ¶ added in v1.53.0
func (v *IngestDataOutput) SerializeMembers(s smithy.ShapeSerializer)
type InvokeAgentRuntimeCommandEventStream ¶ added in v1.14.0
type InvokeAgentRuntimeCommandEventStream struct {
// InvokeAgentRuntimeCommandStreamOutputReader is the EventStream reader for the
// InvokeAgentRuntimeCommandStreamOutput events. This value is automatically set by
// the SDK when the API call is made Use this member when unit testing your code
// with the SDK to mock out the EventStream Reader.
//
// Must not be nil.
Reader InvokeAgentRuntimeCommandStreamOutputReader
// contains filtered or unexported fields
}
InvokeAgentRuntimeCommandEventStream provides the event stream handling for the InvokeAgentRuntimeCommand operation.
For testing and mocking the event stream this type should be initialized via the NewInvokeAgentRuntimeCommandEventStream constructor function. Using the functional options to pass in nested mock behavior.
func NewInvokeAgentRuntimeCommandEventStream ¶ added in v1.14.0
func NewInvokeAgentRuntimeCommandEventStream(optFns ...func(*InvokeAgentRuntimeCommandEventStream)) *InvokeAgentRuntimeCommandEventStream
NewInvokeAgentRuntimeCommandEventStream initializes an InvokeAgentRuntimeCommandEventStream. This function should only be used for testing and mocking the InvokeAgentRuntimeCommandEventStream stream within your application.
The Reader member must be set before reading events from the stream.
func (*InvokeAgentRuntimeCommandEventStream) Close ¶ added in v1.14.0
func (es *InvokeAgentRuntimeCommandEventStream) Close() error
Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.
Will close the underlying EventStream writer and reader, and no more events can be sent or received.
func (*InvokeAgentRuntimeCommandEventStream) Err ¶ added in v1.14.0
func (es *InvokeAgentRuntimeCommandEventStream) Err() error
Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.
func (*InvokeAgentRuntimeCommandEventStream) Events ¶ added in v1.14.0
func (es *InvokeAgentRuntimeCommandEventStream) Events() <-chan types.InvokeAgentRuntimeCommandStreamOutput
Events returns a channel to read events from.
type InvokeAgentRuntimeCommandInitialReply ¶ added in v1.14.0
type InvokeAgentRuntimeCommandInitialReply struct {
// The MIME type of the response data. This indicates how to interpret the
// response data. Common values include application/json for JSON data.
//
// This member is required.
ContentType *string
// Additional context information for distributed tracing.
Baggage *string
// The unique identifier of the runtime session in which the command was executed.
RuntimeSessionId *string
// The HTTP status code of the response. A status code of 200 indicates a
// successful operation. Other status codes indicate various error conditions.
StatusCode *int32
// The trace identifier for request tracking.
TraceId *string
// The parent trace information for distributed tracing.
TraceParent *string
// The trace state information for distributed tracing.
TraceState *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response for InvokeAgentRuntimeCommand operation.
func (*InvokeAgentRuntimeCommandInitialReply) Deserialize ¶ added in v1.56.2
func (v *InvokeAgentRuntimeCommandInitialReply) Deserialize(d smithy.ShapeDeserializer) error
type InvokeAgentRuntimeCommandInput ¶ added in v1.14.0
type InvokeAgentRuntimeCommandInput struct {
// The Amazon Resource Name (ARN) of the agent runtime on which to execute the
// command. This identifies the specific agent runtime environment where the
// command will run.
//
// This member is required.
AgentRuntimeArn *string
// The request body containing the command to execute and optional configuration
// parameters such as timeout settings.
//
// This member is required.
Body *types.InvokeAgentRuntimeCommandRequestBody
// The desired MIME type for the response from the agent runtime command. This
// tells the agent runtime what format to use for the response data. Common values
// include application/json for JSON data.
Accept *string
// The identifier of the Amazon Web Services account for the agent runtime
// resource. This parameter is required when you specify an agent ID instead of the
// full ARN for agentRuntimeArn .
AccountId *string
// Additional context information for distributed tracing.
Baggage *string
// The MIME type of the input data in the request payload. This tells the agent
// runtime how to interpret the payload data. Common values include
// application/json for JSON data.
ContentType *string
// The qualifier to use for the agent runtime. This is an endpoint name that
// points to a specific version. If not specified, Amazon Bedrock AgentCore uses
// the default endpoint of the agent runtime.
Qualifier *string
// The unique identifier of the runtime session in which to execute the command.
// This session ID is used to maintain state and context across multiple command
// invocations.
RuntimeSessionId *string
// The trace identifier for request tracking.
TraceId *string
// The parent trace information for distributed tracing.
TraceParent *string
// The trace state information for distributed tracing.
TraceState *string
// contains filtered or unexported fields
}
Request for InvokeAgentRuntimeCommand operation.
func (*InvokeAgentRuntimeCommandInput) Serialize ¶ added in v1.28.3
func (v *InvokeAgentRuntimeCommandInput) Serialize(s smithy.ShapeSerializer)
func (*InvokeAgentRuntimeCommandInput) SerializeMembers ¶ added in v1.28.3
func (v *InvokeAgentRuntimeCommandInput) SerializeMembers(s smithy.ShapeSerializer)
type InvokeAgentRuntimeCommandOutput ¶ added in v1.14.0
type InvokeAgentRuntimeCommandOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response for InvokeAgentRuntimeCommand operation.
func (*InvokeAgentRuntimeCommandOutput) Deserialize ¶ added in v1.28.3
func (v *InvokeAgentRuntimeCommandOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*InvokeAgentRuntimeCommandOutput) GetInitialReply ¶ added in v1.14.0
func (o *InvokeAgentRuntimeCommandOutput) GetInitialReply() <-chan InvokeAgentRuntimeCommandInitialReply
func (*InvokeAgentRuntimeCommandOutput) GetStream ¶ added in v1.14.0
func (o *InvokeAgentRuntimeCommandOutput) GetStream() *InvokeAgentRuntimeCommandEventStream
GetStream returns the type to interact with the event stream.
func (*InvokeAgentRuntimeCommandOutput) Serialize ¶ added in v1.53.0
func (v *InvokeAgentRuntimeCommandOutput) Serialize(s smithy.ShapeSerializer)
func (*InvokeAgentRuntimeCommandOutput) SerializeMembers ¶ added in v1.53.0
func (v *InvokeAgentRuntimeCommandOutput) SerializeMembers(s smithy.ShapeSerializer)
type InvokeAgentRuntimeCommandStreamOutputReader ¶ added in v1.14.0
type InvokeAgentRuntimeCommandStreamOutputReader interface {
Events() <-chan types.InvokeAgentRuntimeCommandStreamOutput
Close() error
Err() error
}
InvokeAgentRuntimeCommandStreamOutputReader provides the interface for reading events from a stream.
The writer's Close method must allow multiple concurrent calls.
type InvokeAgentRuntimeInput ¶
type InvokeAgentRuntimeInput struct {
// The identifier of the agent runtime to invoke. You can specify either the full
// Amazon Web Services Resource Name (ARN) or the agent ID. If you use the agent
// ID, you must also provide the accountId query parameter.
//
// This member is required.
AgentRuntimeArn *string
// The input data to send to the agent runtime. The format of this data depends on
// the specific agent configuration and must match the specified content type. For
// most agents, this is a JSON object containing the user's request.
//
// This member is required.
Payload []byte
// The desired MIME type for the response from the agent runtime. This tells the
// agent runtime what format to use for the response data. Common values include
// application/json for JSON data.
Accept *string
// The identifier of the Amazon Web Services account for the agent runtime
// resource. This parameter is required when you specify an agent ID instead of the
// full ARN for agentRuntimeArn .
AccountId *string
// Additional context information for distributed tracing.
Baggage *string
// The MIME type of the input data in the payload. This tells the agent runtime
// how to interpret the payload data. Common values include application/json for
// JSON data.
ContentType *string
// The MCP method being invoked. For example, tools/call , resources/read , or
// prompts/get .
McpMethod *string
// The name of the MCP resource, tool, or prompt being accessed. The value depends
// on the method:
//
// - tools/call – The tool name.
//
// - resources/read – The resource URI.
//
// - prompts/get – The prompt name.
McpName *string
// The version of the MCP protocol being used.
McpProtocolVersion *string
// The identifier of the MCP session.
McpSessionId *string
// The qualifier to use for the agent runtime. This is an endpoint name that
// points to a specific version. If not specified, Amazon Bedrock AgentCore uses
// the default endpoint of the agent runtime.
Qualifier *string
// The identifier of the runtime session.
RuntimeSessionId *string
// The identifier of the runtime user.
RuntimeUserId *string
// The trace identifier for request tracking.
TraceId *string
// The parent trace information for distributed tracing.
TraceParent *string
// The trace state information for distributed tracing.
TraceState *string
// contains filtered or unexported fields
}
func (*InvokeAgentRuntimeInput) Serialize ¶ added in v1.28.3
func (v *InvokeAgentRuntimeInput) Serialize(s smithy.ShapeSerializer)
func (*InvokeAgentRuntimeInput) SerializeMembers ¶ added in v1.28.3
func (v *InvokeAgentRuntimeInput) SerializeMembers(s smithy.ShapeSerializer)
type InvokeAgentRuntimeOutput ¶
type InvokeAgentRuntimeOutput struct {
// The MIME type of the response data. This indicates how to interpret the
// response data. Common values include application/json for JSON data.
//
// This member is required.
ContentType *string
// Additional context information for distributed tracing.
Baggage *string
// The version of the MCP protocol being used.
McpProtocolVersion *string
// The identifier of the MCP session.
McpSessionId *string
// The response data from the agent runtime. The format of this data depends on
// the specific agent configuration and the requested accept type. For most agents,
// this is a JSON object containing the agent's response to the user's request.
Response io.ReadCloser
// The identifier of the runtime session.
RuntimeSessionId *string
// The HTTPS endpoint that addresses this runtime session directly. This value is
// returned only when the agent runtime is configured with allowed ports and direct
// runtime access is available for the session. If this value is not present, use
// InvokeAgentRuntime to communicate with the session.
SessionEndpointUrl *string
// The HTTP status code of the response. A status code of 200 indicates a
// successful operation. Other status codes indicate various error conditions.
StatusCode *int32
// The trace identifier for request tracking.
TraceId *string
// The parent trace information for distributed tracing.
TraceParent *string
// The trace state information for distributed tracing.
TraceState *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*InvokeAgentRuntimeOutput) Deserialize ¶ added in v1.28.3
func (v *InvokeAgentRuntimeOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*InvokeAgentRuntimeOutput) GetPayloadStream ¶ added in v1.28.3
func (v *InvokeAgentRuntimeOutput) GetPayloadStream() io.Reader
func (*InvokeAgentRuntimeOutput) Serialize ¶ added in v1.53.0
func (v *InvokeAgentRuntimeOutput) Serialize(s smithy.ShapeSerializer)
func (*InvokeAgentRuntimeOutput) SerializeMembers ¶ added in v1.53.0
func (v *InvokeAgentRuntimeOutput) SerializeMembers(s smithy.ShapeSerializer)
func (*InvokeAgentRuntimeOutput) SetPayloadStream ¶ added in v1.28.3
func (v *InvokeAgentRuntimeOutput) SetPayloadStream(r io.ReadCloser)
type InvokeBrowserInput ¶ added in v1.19.0
type InvokeBrowserInput struct {
// The browser action to perform. Exactly one member of the BrowserAction union
// must be set per request.
//
// This member is required.
Action types.BrowserAction
// The unique identifier of the browser associated with the session. This must
// match the identifier used when creating the session with StartBrowserSession .
//
// This member is required.
BrowserIdentifier *string
// The unique identifier of the browser session on which to perform the action.
// This must be an active session created with StartBrowserSession .
//
// This member is required.
SessionId *string
// contains filtered or unexported fields
}
Request for the InvokeBrowser operation.
func (*InvokeBrowserInput) Serialize ¶ added in v1.28.3
func (v *InvokeBrowserInput) Serialize(s smithy.ShapeSerializer)
func (*InvokeBrowserInput) SerializeMembers ¶ added in v1.28.3
func (v *InvokeBrowserInput) SerializeMembers(s smithy.ShapeSerializer)
type InvokeBrowserOutput ¶ added in v1.19.0
type InvokeBrowserOutput struct {
// The result of the browser action. The member set in the result corresponds to
// the action that was performed.
//
// This member is required.
Result types.BrowserActionResult
// The unique identifier of the browser session on which the action was performed.
//
// This member is required.
SessionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response for the InvokeBrowser operation.
func (*InvokeBrowserOutput) Deserialize ¶ added in v1.28.3
func (v *InvokeBrowserOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*InvokeBrowserOutput) Serialize ¶ added in v1.53.0
func (v *InvokeBrowserOutput) Serialize(s smithy.ShapeSerializer)
func (*InvokeBrowserOutput) SerializeMembers ¶ added in v1.53.0
func (v *InvokeBrowserOutput) SerializeMembers(s smithy.ShapeSerializer)
type InvokeCodeInterpreterEventStream ¶
type InvokeCodeInterpreterEventStream struct {
// CodeInterpreterStreamOutputReader is the EventStream reader for the
// CodeInterpreterStreamOutput events. This value is automatically set by the SDK
// when the API call is made Use this member when unit testing your code with the
// SDK to mock out the EventStream Reader.
//
// Must not be nil.
Reader CodeInterpreterStreamOutputReader
// contains filtered or unexported fields
}
InvokeCodeInterpreterEventStream provides the event stream handling for the InvokeCodeInterpreter operation.
For testing and mocking the event stream this type should be initialized via the NewInvokeCodeInterpreterEventStream constructor function. Using the functional options to pass in nested mock behavior.
func NewInvokeCodeInterpreterEventStream ¶
func NewInvokeCodeInterpreterEventStream(optFns ...func(*InvokeCodeInterpreterEventStream)) *InvokeCodeInterpreterEventStream
NewInvokeCodeInterpreterEventStream initializes an InvokeCodeInterpreterEventStream. This function should only be used for testing and mocking the InvokeCodeInterpreterEventStream stream within your application.
The Reader member must be set before reading events from the stream.
func (*InvokeCodeInterpreterEventStream) Close ¶
func (es *InvokeCodeInterpreterEventStream) Close() error
Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.
Will close the underlying EventStream writer and reader, and no more events can be sent or received.
func (*InvokeCodeInterpreterEventStream) Err ¶
func (es *InvokeCodeInterpreterEventStream) Err() error
Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.
func (*InvokeCodeInterpreterEventStream) Events ¶
func (es *InvokeCodeInterpreterEventStream) Events() <-chan types.CodeInterpreterStreamOutput
Events returns a channel to read events from.
type InvokeCodeInterpreterInput ¶
type InvokeCodeInterpreterInput struct {
// The unique identifier of the code interpreter associated with the session. This
// must match the identifier used when creating the session with
// StartCodeInterpreterSession .
//
// This member is required.
CodeInterpreterIdentifier *string
// The name of the code interpreter to invoke.
//
// This member is required.
Name types.ToolName
// The arguments for the code interpreter. This includes the code to execute and
// any additional parameters such as the programming language, whether to clear the
// execution context, and other execution options. The structure of this parameter
// depends on the specific code interpreter being used.
Arguments *types.ToolArguments
// The unique identifier of the code interpreter session to use. This must be an
// active session created with StartCodeInterpreterSession . If the session has
// expired or been stopped, the request will fail.
SessionId *string
// The trace identifier for request tracking.
TraceId *string
// The parent trace information for distributed tracing.
TraceParent *string
// contains filtered or unexported fields
}
func (*InvokeCodeInterpreterInput) Serialize ¶ added in v1.28.3
func (v *InvokeCodeInterpreterInput) Serialize(s smithy.ShapeSerializer)
func (*InvokeCodeInterpreterInput) SerializeMembers ¶ added in v1.28.3
func (v *InvokeCodeInterpreterInput) SerializeMembers(s smithy.ShapeSerializer)
type InvokeCodeInterpreterOutput ¶
type InvokeCodeInterpreterOutput struct {
// The identifier of the code interpreter session.
SessionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*InvokeCodeInterpreterOutput) Deserialize ¶ added in v1.28.3
func (v *InvokeCodeInterpreterOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*InvokeCodeInterpreterOutput) GetStream ¶
func (o *InvokeCodeInterpreterOutput) GetStream() *InvokeCodeInterpreterEventStream
GetStream returns the type to interact with the event stream.
func (*InvokeCodeInterpreterOutput) Serialize ¶ added in v1.53.0
func (v *InvokeCodeInterpreterOutput) Serialize(s smithy.ShapeSerializer)
func (*InvokeCodeInterpreterOutput) SerializeMembers ¶ added in v1.53.0
func (v *InvokeCodeInterpreterOutput) SerializeMembers(s smithy.ShapeSerializer)
type InvokeHarnessEventStream ¶ added in v1.22.0
type InvokeHarnessEventStream struct {
// InvokeHarnessStreamOutputReader is the EventStream reader for the
// InvokeHarnessStreamOutput events. This value is automatically set by the SDK
// when the API call is made Use this member when unit testing your code with the
// SDK to mock out the EventStream Reader.
//
// Must not be nil.
Reader InvokeHarnessStreamOutputReader
// contains filtered or unexported fields
}
InvokeHarnessEventStream provides the event stream handling for the InvokeHarness operation.
For testing and mocking the event stream this type should be initialized via the NewInvokeHarnessEventStream constructor function. Using the functional options to pass in nested mock behavior.
func NewInvokeHarnessEventStream ¶ added in v1.22.0
func NewInvokeHarnessEventStream(optFns ...func(*InvokeHarnessEventStream)) *InvokeHarnessEventStream
NewInvokeHarnessEventStream initializes an InvokeHarnessEventStream. This function should only be used for testing and mocking the InvokeHarnessEventStream stream within your application.
The Reader member must be set before reading events from the stream.
func (*InvokeHarnessEventStream) Close ¶ added in v1.22.0
func (es *InvokeHarnessEventStream) Close() error
Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.
Will close the underlying EventStream writer and reader, and no more events can be sent or received.
func (*InvokeHarnessEventStream) Err ¶ added in v1.22.0
func (es *InvokeHarnessEventStream) Err() error
Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.
func (*InvokeHarnessEventStream) Events ¶ added in v1.22.0
func (es *InvokeHarnessEventStream) Events() <-chan types.InvokeHarnessStreamOutput
Events returns a channel to read events from.
type InvokeHarnessInitialReply ¶ added in v1.22.0
type InvokeHarnessInitialReply struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*InvokeHarnessInitialReply) Deserialize ¶ added in v1.56.2
func (v *InvokeHarnessInitialReply) Deserialize(d smithy.ShapeDeserializer) error
type InvokeHarnessInput ¶ added in v1.22.0
type InvokeHarnessInput struct {
// The ARN of the harness to invoke.
//
// This member is required.
HarnessArn *string
// The messages to send to the agent.
//
// This member is required.
Messages []types.HarnessMessage
// The session ID for the invocation. Use the same session ID across requests to
// continue a conversation.
//
// This member is required.
RuntimeSessionId *string
// The actor ID for memory operations. Overrides the actor ID configured on the
// harness.
ActorId *string
// The tools that the agent is allowed to use for this invocation. If specified,
// overrides the harness default.
AllowedTools []string
// W3C Baggage header for user-defined context propagation. Format:
// key1=value1,key2=value2
Baggage *string
// The maximum number of iterations the agent loop can execute. If specified,
// overrides the harness default.
MaxIterations *int32
// The maximum number of tokens the agent can generate per iteration. If
// specified, overrides the harness default.
MaxTokens *int32
// The model configuration to use for this invocation. If specified, overrides the
// harness default.
Model types.HarnessModelConfiguration
// The endpoint name to invoke. If omitted, the DEFAULT endpoint is used.
Qualifier *string
// An identifier for the end user making the request. This value is passed through
// to the runtime container.
RuntimeUserId *string
// The skills available to the agent for this invocation. If specified, overrides
// the harness default.
Skills []types.HarnessSkill
// The system prompt to use for this invocation. If specified, overrides the
// harness default.
SystemPrompt []types.HarnessSystemContentBlock
// The maximum duration in seconds for the agent loop execution. If specified,
// overrides the harness default.
TimeoutSeconds *int32
// The tools available to the agent for this invocation. If specified, overrides
// the harness default.
Tools []types.HarnessTool
// Trace ID for maintaining observability through the operation.
TraceId *string
// W3C trace context parent header containing version, trace ID, parent span ID,
// and trace flags.
TraceParent *string
// W3C trace context state header for vendor-specific trace information.
TraceState *string
// contains filtered or unexported fields
}
func (*InvokeHarnessInput) Serialize ¶ added in v1.28.3
func (v *InvokeHarnessInput) Serialize(s smithy.ShapeSerializer)
func (*InvokeHarnessInput) SerializeMembers ¶ added in v1.28.3
func (v *InvokeHarnessInput) SerializeMembers(s smithy.ShapeSerializer)
type InvokeHarnessOutput ¶ added in v1.22.0
type InvokeHarnessOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*InvokeHarnessOutput) Deserialize ¶ added in v1.28.3
func (v *InvokeHarnessOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*InvokeHarnessOutput) GetInitialReply ¶ added in v1.22.0
func (o *InvokeHarnessOutput) GetInitialReply() <-chan InvokeHarnessInitialReply
func (*InvokeHarnessOutput) GetStream ¶ added in v1.22.0
func (o *InvokeHarnessOutput) GetStream() *InvokeHarnessEventStream
GetStream returns the type to interact with the event stream.
func (*InvokeHarnessOutput) Serialize ¶ added in v1.53.0
func (v *InvokeHarnessOutput) Serialize(s smithy.ShapeSerializer)
func (*InvokeHarnessOutput) SerializeMembers ¶ added in v1.53.0
func (v *InvokeHarnessOutput) SerializeMembers(s smithy.ShapeSerializer)
type InvokeHarnessStreamOutputReader ¶ added in v1.22.0
type InvokeHarnessStreamOutputReader interface {
Events() <-chan types.InvokeHarnessStreamOutput
Close() error
Err() error
}
InvokeHarnessStreamOutputReader provides the interface for reading events from a stream.
The writer's Close method must allow multiple concurrent calls.
type InvokeWebSearchInput ¶ added in v1.57.0
type InvokeWebSearchInput struct {
// The text to search for.
//
// This member is required.
SearchQuery *string
// The identifier of the web search tool to invoke. The Amazon Web
// Services-managed web search tool is web-search.v1 .
//
// This member is required.
WebSearchId *string
// The filters to apply to the search results.
Filters *types.WebSearchFilters
// The maximum number of results to return. Defaults to 25.
MaxResults *int32
// contains filtered or unexported fields
}
Request for the InvokeWebSearch operation.
func (*InvokeWebSearchInput) Serialize ¶ added in v1.57.0
func (v *InvokeWebSearchInput) Serialize(s smithy.ShapeSerializer)
func (*InvokeWebSearchInput) SerializeMembers ¶ added in v1.57.0
func (v *InvokeWebSearchInput) SerializeMembers(s smithy.ShapeSerializer)
type InvokeWebSearchOutput ¶ added in v1.57.0
type InvokeWebSearchOutput struct {
// The search results, in ranked order.
//
// This member is required.
Results []types.WebSearchResult
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response for the InvokeWebSearch operation.
func (*InvokeWebSearchOutput) Deserialize ¶ added in v1.57.0
func (v *InvokeWebSearchOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*InvokeWebSearchOutput) Serialize ¶ added in v1.57.0
func (v *InvokeWebSearchOutput) Serialize(s smithy.ShapeSerializer)
func (*InvokeWebSearchOutput) SerializeMembers ¶ added in v1.57.0
func (v *InvokeWebSearchOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListABTestsAPIClient ¶ added in v1.23.0
type ListABTestsAPIClient interface {
ListABTests(context.Context, *ListABTestsInput, ...func(*Options)) (*ListABTestsOutput, error)
}
ListABTestsAPIClient is a client that implements the ListABTests operation.
type ListABTestsInput ¶ added in v1.23.0
type ListABTestsInput 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
// contains filtered or unexported fields
}
func (*ListABTestsInput) Serialize ¶ added in v1.28.3
func (v *ListABTestsInput) Serialize(s smithy.ShapeSerializer)
func (*ListABTestsInput) SerializeMembers ¶ added in v1.28.3
func (v *ListABTestsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListABTestsOutput ¶ added in v1.23.0
type ListABTestsOutput struct {
// The list of A/B test summaries.
//
// This member is required.
AbTests []types.ABTestSummary
// 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
}
func (*ListABTestsOutput) Deserialize ¶ added in v1.28.3
func (v *ListABTestsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListABTestsOutput) Serialize ¶ added in v1.53.0
func (v *ListABTestsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListABTestsOutput) SerializeMembers ¶ added in v1.53.0
func (v *ListABTestsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListABTestsPaginator ¶ added in v1.23.0
type ListABTestsPaginator struct {
// contains filtered or unexported fields
}
ListABTestsPaginator is a paginator for ListABTests
func NewListABTestsPaginator ¶ added in v1.23.0
func NewListABTestsPaginator(client ListABTestsAPIClient, params *ListABTestsInput, optFns ...func(*ListABTestsPaginatorOptions)) *ListABTestsPaginator
NewListABTestsPaginator returns a new ListABTestsPaginator
func (*ListABTestsPaginator) HasMorePages ¶ added in v1.23.0
func (p *ListABTestsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListABTestsPaginator) NextPage ¶ added in v1.23.0
func (p *ListABTestsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListABTestsOutput, error)
NextPage retrieves the next ListABTests page.
type ListABTestsPaginatorOptions ¶ added in v1.23.0
type ListABTestsPaginatorOptions 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
}
ListABTestsPaginatorOptions is the paginator options for ListABTests
type ListActorsAPIClient ¶
type ListActorsAPIClient interface {
ListActors(context.Context, *ListActorsInput, ...func(*Options)) (*ListActorsOutput, error)
}
ListActorsAPIClient is a client that implements the ListActors operation.
type ListActorsInput ¶
type ListActorsInput struct {
// The identifier of the AgentCore Memory resource for which to list actors.
//
// This member is required.
MemoryId *string
// The maximum number of results to return in a single call. The default value is
// 20.
MaxResults *int32
// The token for the next set of results. Use the value returned in the previous
// response in the next request to retrieve the next set of results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListActorsInput) Serialize ¶ added in v1.28.3
func (v *ListActorsInput) Serialize(s smithy.ShapeSerializer)
func (*ListActorsInput) SerializeMembers ¶ added in v1.28.3
func (v *ListActorsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListActorsOutput ¶
type ListActorsOutput struct {
// The list of actor summaries.
//
// This member is required.
ActorSummaries []types.ActorSummary
// The token to use in a subsequent request to get the next set of results. This
// value is null when there are no more results to return.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListActorsOutput) Deserialize ¶ added in v1.28.3
func (v *ListActorsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListActorsOutput) Serialize ¶ added in v1.53.0
func (v *ListActorsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListActorsOutput) SerializeMembers ¶ added in v1.53.0
func (v *ListActorsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListActorsPaginator ¶
type ListActorsPaginator struct {
// contains filtered or unexported fields
}
ListActorsPaginator is a paginator for ListActors
func NewListActorsPaginator ¶
func NewListActorsPaginator(client ListActorsAPIClient, params *ListActorsInput, optFns ...func(*ListActorsPaginatorOptions)) *ListActorsPaginator
NewListActorsPaginator returns a new ListActorsPaginator
func (*ListActorsPaginator) HasMorePages ¶
func (p *ListActorsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListActorsPaginator) NextPage ¶
func (p *ListActorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListActorsOutput, error)
NextPage retrieves the next ListActors page.
type ListActorsPaginatorOptions ¶
type ListActorsPaginatorOptions struct {
// The maximum number of results to return in a single call. The default value is
// 20.
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
}
ListActorsPaginatorOptions is the paginator options for ListActors
type ListAgentInsightsAPIClient ¶ added in v1.59.0
type ListAgentInsightsAPIClient interface {
ListAgentInsights(context.Context, *ListAgentInsightsInput, ...func(*Options)) (*ListAgentInsightsOutput, error)
}
ListAgentInsightsAPIClient is a client that implements the ListAgentInsights operation.
type ListAgentInsightsInput ¶ added in v1.59.0
type ListAgentInsightsInput struct {
// Filters the results to Agent Insights for an application.
ApplicationName *string
// Filters the results by archive status.
ArchiveStatus types.AgentInsightArchiveStatus
// Filters the results to Agent Insights produced by a batch evaluation.
BatchEvaluationId *string
// The maximum number of Agent Insight summaries to return in one response. If you
// don't specify a value, the operation returns up to 50 summaries.
MaxResults *int32
// A token to specify where to start paginating the results. This token is
// returned in a previous response.
NextToken *string
// contains filtered or unexported fields
}
func (*ListAgentInsightsInput) Serialize ¶ added in v1.59.0
func (v *ListAgentInsightsInput) Serialize(s smithy.ShapeSerializer)
func (*ListAgentInsightsInput) SerializeMembers ¶ added in v1.59.0
func (v *ListAgentInsightsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListAgentInsightsOutput ¶ added in v1.59.0
type ListAgentInsightsOutput struct {
// The Agent Insight summaries.
//
// This member is required.
AgentInsights []types.AgentInsightSummary
// A token to use to retrieve the next page of results. This value is present only
// when additional results are available.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListAgentInsightsOutput) Deserialize ¶ added in v1.59.0
func (v *ListAgentInsightsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListAgentInsightsOutput) Serialize ¶ added in v1.59.0
func (v *ListAgentInsightsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListAgentInsightsOutput) SerializeMembers ¶ added in v1.59.0
func (v *ListAgentInsightsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListAgentInsightsPaginator ¶ added in v1.59.0
type ListAgentInsightsPaginator struct {
// contains filtered or unexported fields
}
ListAgentInsightsPaginator is a paginator for ListAgentInsights
func NewListAgentInsightsPaginator ¶ added in v1.59.0
func NewListAgentInsightsPaginator(client ListAgentInsightsAPIClient, params *ListAgentInsightsInput, optFns ...func(*ListAgentInsightsPaginatorOptions)) *ListAgentInsightsPaginator
NewListAgentInsightsPaginator returns a new ListAgentInsightsPaginator
func (*ListAgentInsightsPaginator) HasMorePages ¶ added in v1.59.0
func (p *ListAgentInsightsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAgentInsightsPaginator) NextPage ¶ added in v1.59.0
func (p *ListAgentInsightsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAgentInsightsOutput, error)
NextPage retrieves the next ListAgentInsights page.
type ListAgentInsightsPaginatorOptions ¶ added in v1.59.0
type ListAgentInsightsPaginatorOptions struct {
// The maximum number of Agent Insight summaries to return in one response. If you
// don't specify a value, the operation returns up to 50 summaries.
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
}
ListAgentInsightsPaginatorOptions is the paginator options for ListAgentInsights
type ListBatchEvaluationsAPIClient ¶ added in v1.23.0
type ListBatchEvaluationsAPIClient interface {
ListBatchEvaluations(context.Context, *ListBatchEvaluationsInput, ...func(*Options)) (*ListBatchEvaluationsOutput, error)
}
ListBatchEvaluationsAPIClient is a client that implements the ListBatchEvaluations operation.
type ListBatchEvaluationsInput ¶ added in v1.23.0
type ListBatchEvaluationsInput 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
// contains filtered or unexported fields
}
func (*ListBatchEvaluationsInput) Serialize ¶ added in v1.28.3
func (v *ListBatchEvaluationsInput) Serialize(s smithy.ShapeSerializer)
func (*ListBatchEvaluationsInput) SerializeMembers ¶ added in v1.28.3
func (v *ListBatchEvaluationsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListBatchEvaluationsOutput ¶ added in v1.23.0
type ListBatchEvaluationsOutput struct {
// The list of batch evaluation summaries.
//
// This member is required.
BatchEvaluations []types.BatchEvaluationSummary
// 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
}
func (*ListBatchEvaluationsOutput) Deserialize ¶ added in v1.28.3
func (v *ListBatchEvaluationsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListBatchEvaluationsOutput) Serialize ¶ added in v1.53.0
func (v *ListBatchEvaluationsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListBatchEvaluationsOutput) SerializeMembers ¶ added in v1.53.0
func (v *ListBatchEvaluationsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListBatchEvaluationsPaginator ¶ added in v1.23.0
type ListBatchEvaluationsPaginator struct {
// contains filtered or unexported fields
}
ListBatchEvaluationsPaginator is a paginator for ListBatchEvaluations
func NewListBatchEvaluationsPaginator ¶ added in v1.23.0
func NewListBatchEvaluationsPaginator(client ListBatchEvaluationsAPIClient, params *ListBatchEvaluationsInput, optFns ...func(*ListBatchEvaluationsPaginatorOptions)) *ListBatchEvaluationsPaginator
NewListBatchEvaluationsPaginator returns a new ListBatchEvaluationsPaginator
func (*ListBatchEvaluationsPaginator) HasMorePages ¶ added in v1.23.0
func (p *ListBatchEvaluationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListBatchEvaluationsPaginator) NextPage ¶ added in v1.23.0
func (p *ListBatchEvaluationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBatchEvaluationsOutput, error)
NextPage retrieves the next ListBatchEvaluations page.
type ListBatchEvaluationsPaginatorOptions ¶ added in v1.23.0
type ListBatchEvaluationsPaginatorOptions 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
}
ListBatchEvaluationsPaginatorOptions is the paginator options for ListBatchEvaluations
type ListBrowserSessionsInput ¶
type ListBrowserSessionsInput struct {
// The unique identifier of the browser to list sessions for. If specified, only
// sessions for this browser are returned. If not specified, sessions for all
// browsers are returned.
//
// This member is required.
BrowserIdentifier *string
// The maximum number of results to return in a single call. The default value is
// 10. Valid values range from 1 to 100. To retrieve the remaining results, make
// another call with the returned nextToken value.
MaxResults *int32
// The token for the next set of results. Use the value returned in the previous
// response in the next request to retrieve the next set of results. If not
// specified, Amazon Bedrock AgentCore returns the first page of results.
NextToken *string
// The status of the browser sessions to list. Valid values include ACTIVE,
// STOPPING, and STOPPED. If not specified, sessions with any status are returned.
Status types.BrowserSessionStatus
// contains filtered or unexported fields
}
func (*ListBrowserSessionsInput) Serialize ¶ added in v1.28.3
func (v *ListBrowserSessionsInput) Serialize(s smithy.ShapeSerializer)
func (*ListBrowserSessionsInput) SerializeMembers ¶ added in v1.28.3
func (v *ListBrowserSessionsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListBrowserSessionsOutput ¶
type ListBrowserSessionsOutput struct {
// The list of browser sessions that match the specified criteria.
//
// This member is required.
Items []types.BrowserSessionSummary
// The token to use in a subsequent ListBrowserSessions request to get the next
// set of results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListBrowserSessionsOutput) Deserialize ¶ added in v1.28.3
func (v *ListBrowserSessionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListBrowserSessionsOutput) Serialize ¶ added in v1.53.0
func (v *ListBrowserSessionsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListBrowserSessionsOutput) SerializeMembers ¶ added in v1.53.0
func (v *ListBrowserSessionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListCodeInterpreterSessionsInput ¶
type ListCodeInterpreterSessionsInput struct {
// The unique identifier of the code interpreter to list sessions for. If
// specified, only sessions for this code interpreter are returned. If not
// specified, sessions for all code interpreters are returned.
//
// This member is required.
CodeInterpreterIdentifier *string
// The maximum number of results to return in a single call. The default value is
// 10. Valid values range from 1 to 100. To retrieve the remaining results, make
// another call with the returned nextToken value.
MaxResults *int32
// The token for the next set of results. Use the value returned in the previous
// response in the next request to retrieve the next set of results. If not
// specified, Amazon Bedrock AgentCore returns the first page of results.
NextToken *string
// The status of the code interpreter sessions to list. Valid values include
// ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are
// returned.
Status types.CodeInterpreterSessionStatus
// contains filtered or unexported fields
}
func (*ListCodeInterpreterSessionsInput) Serialize ¶ added in v1.28.3
func (v *ListCodeInterpreterSessionsInput) Serialize(s smithy.ShapeSerializer)
func (*ListCodeInterpreterSessionsInput) SerializeMembers ¶ added in v1.28.3
func (v *ListCodeInterpreterSessionsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListCodeInterpreterSessionsOutput ¶
type ListCodeInterpreterSessionsOutput struct {
// The list of code interpreter sessions that match the specified criteria.
//
// This member is required.
Items []types.CodeInterpreterSessionSummary
// The token to use in a subsequent ListCodeInterpreterSessions request to get the
// next set of results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListCodeInterpreterSessionsOutput) Deserialize ¶ added in v1.28.3
func (v *ListCodeInterpreterSessionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListCodeInterpreterSessionsOutput) Serialize ¶ added in v1.53.0
func (v *ListCodeInterpreterSessionsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListCodeInterpreterSessionsOutput) SerializeMembers ¶ added in v1.53.0
func (v *ListCodeInterpreterSessionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListDatasetGenerationsAPIClient ¶ added in v1.59.0
type ListDatasetGenerationsAPIClient interface {
ListDatasetGenerations(context.Context, *ListDatasetGenerationsInput, ...func(*Options)) (*ListDatasetGenerationsOutput, error)
}
ListDatasetGenerationsAPIClient is a client that implements the ListDatasetGenerations operation.
type ListDatasetGenerationsInput ¶ added in v1.59.0
type ListDatasetGenerationsInput struct {
// The unique identifier of the dataset.
//
// This member is required.
DatasetId *string
// The maximum number of results to return in the response. The default is 20. 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
// contains filtered or unexported fields
}
func (*ListDatasetGenerationsInput) Serialize ¶ added in v1.59.0
func (v *ListDatasetGenerationsInput) Serialize(s smithy.ShapeSerializer)
func (*ListDatasetGenerationsInput) SerializeMembers ¶ added in v1.59.0
func (v *ListDatasetGenerationsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListDatasetGenerationsOutput ¶ added in v1.59.0
type ListDatasetGenerationsOutput struct {
// The dataset generations.
//
// This member is required.
DatasetGenerations []types.DatasetGenerationSummary
// 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
}
func (*ListDatasetGenerationsOutput) Deserialize ¶ added in v1.59.0
func (v *ListDatasetGenerationsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListDatasetGenerationsOutput) Serialize ¶ added in v1.59.0
func (v *ListDatasetGenerationsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListDatasetGenerationsOutput) SerializeMembers ¶ added in v1.59.0
func (v *ListDatasetGenerationsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListDatasetGenerationsPaginator ¶ added in v1.59.0
type ListDatasetGenerationsPaginator struct {
// contains filtered or unexported fields
}
ListDatasetGenerationsPaginator is a paginator for ListDatasetGenerations
func NewListDatasetGenerationsPaginator ¶ added in v1.59.0
func NewListDatasetGenerationsPaginator(client ListDatasetGenerationsAPIClient, params *ListDatasetGenerationsInput, optFns ...func(*ListDatasetGenerationsPaginatorOptions)) *ListDatasetGenerationsPaginator
NewListDatasetGenerationsPaginator returns a new ListDatasetGenerationsPaginator
func (*ListDatasetGenerationsPaginator) HasMorePages ¶ added in v1.59.0
func (p *ListDatasetGenerationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDatasetGenerationsPaginator) NextPage ¶ added in v1.59.0
func (p *ListDatasetGenerationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetGenerationsOutput, error)
NextPage retrieves the next ListDatasetGenerations page.
type ListDatasetGenerationsPaginatorOptions ¶ added in v1.59.0
type ListDatasetGenerationsPaginatorOptions struct {
// The maximum number of results to return in the response. The default is 20. 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
}
ListDatasetGenerationsPaginatorOptions is the paginator options for ListDatasetGenerations
type ListEventsAPIClient ¶
type ListEventsAPIClient interface {
ListEvents(context.Context, *ListEventsInput, ...func(*Options)) (*ListEventsOutput, error)
}
ListEventsAPIClient is a client that implements the ListEvents operation.
type ListEventsInput ¶
type ListEventsInput struct {
// The identifier of the actor for which to list events.
//
// This member is required.
ActorId *string
// The identifier of the AgentCore Memory resource for which to list events.
//
// This member is required.
MemoryId *string
// The identifier of the session for which to list events.
//
// This member is required.
SessionId *string
// Filter criteria to apply when listing events.
Filter *types.FilterInput
// Specifies whether to include event payloads in the response. Set to true to
// include payloads, or false to exclude them.
IncludePayloads *bool
// The maximum number of results to return in a single call. The default value is
// 20.
MaxResults *int32
// The token for the next set of results. Use the value returned in the previous
// response in the next request to retrieve the next set of results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListEventsInput) Serialize ¶ added in v1.28.3
func (v *ListEventsInput) Serialize(s smithy.ShapeSerializer)
func (*ListEventsInput) SerializeMembers ¶ added in v1.28.3
func (v *ListEventsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListEventsOutput ¶
type ListEventsOutput struct {
// The list of events that match the specified criteria.
//
// This member is required.
Events []types.Event
// The token to use in a subsequent request to get the next set of results. This
// value is null when there are no more results to return.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListEventsOutput) Deserialize ¶ added in v1.28.3
func (v *ListEventsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListEventsOutput) Serialize ¶ added in v1.53.0
func (v *ListEventsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListEventsOutput) SerializeMembers ¶ added in v1.53.0
func (v *ListEventsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListEventsPaginator ¶
type ListEventsPaginator struct {
// contains filtered or unexported fields
}
ListEventsPaginator is a paginator for ListEvents
func NewListEventsPaginator ¶
func NewListEventsPaginator(client ListEventsAPIClient, params *ListEventsInput, optFns ...func(*ListEventsPaginatorOptions)) *ListEventsPaginator
NewListEventsPaginator returns a new ListEventsPaginator
func (*ListEventsPaginator) HasMorePages ¶
func (p *ListEventsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListEventsPaginator) NextPage ¶
func (p *ListEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEventsOutput, error)
NextPage retrieves the next ListEvents page.
type ListEventsPaginatorOptions ¶
type ListEventsPaginatorOptions struct {
// The maximum number of results to return in a single call. The default value is
// 20.
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
}
ListEventsPaginatorOptions is the paginator options for ListEvents
type ListMemoryExtractionJobsAPIClient ¶ added in v1.9.0
type ListMemoryExtractionJobsAPIClient interface {
ListMemoryExtractionJobs(context.Context, *ListMemoryExtractionJobsInput, ...func(*Options)) (*ListMemoryExtractionJobsOutput, error)
}
ListMemoryExtractionJobsAPIClient is a client that implements the ListMemoryExtractionJobs operation.
type ListMemoryExtractionJobsInput ¶ added in v1.9.0
type ListMemoryExtractionJobsInput struct {
// The unique identifier of the memory to list extraction jobs for.
//
// This member is required.
MemoryId *string
// Filter criteria to apply when listing extraction jobs.
Filter *types.ExtractionJobFilterInput
// The maximum number of results to return in a single call. The default value is
// 20.
MaxResults *int32
// The token for the next set of results. Use the value returned in the previous
// response in the next request to retrieve the next set of results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListMemoryExtractionJobsInput) Serialize ¶ added in v1.28.3
func (v *ListMemoryExtractionJobsInput) Serialize(s smithy.ShapeSerializer)
func (*ListMemoryExtractionJobsInput) SerializeMembers ¶ added in v1.28.3
func (v *ListMemoryExtractionJobsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListMemoryExtractionJobsOutput ¶ added in v1.9.0
type ListMemoryExtractionJobsOutput struct {
// List of extraction job metadata matching the specified criteria.
//
// This member is required.
Jobs []types.ExtractionJobMetadata
// Token to retrieve the next page of results, if available.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListMemoryExtractionJobsOutput) Deserialize ¶ added in v1.28.3
func (v *ListMemoryExtractionJobsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListMemoryExtractionJobsOutput) Serialize ¶ added in v1.53.0
func (v *ListMemoryExtractionJobsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListMemoryExtractionJobsOutput) SerializeMembers ¶ added in v1.53.0
func (v *ListMemoryExtractionJobsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListMemoryExtractionJobsPaginator ¶ added in v1.9.0
type ListMemoryExtractionJobsPaginator struct {
// contains filtered or unexported fields
}
ListMemoryExtractionJobsPaginator is a paginator for ListMemoryExtractionJobs
func NewListMemoryExtractionJobsPaginator ¶ added in v1.9.0
func NewListMemoryExtractionJobsPaginator(client ListMemoryExtractionJobsAPIClient, params *ListMemoryExtractionJobsInput, optFns ...func(*ListMemoryExtractionJobsPaginatorOptions)) *ListMemoryExtractionJobsPaginator
NewListMemoryExtractionJobsPaginator returns a new ListMemoryExtractionJobsPaginator
func (*ListMemoryExtractionJobsPaginator) HasMorePages ¶ added in v1.9.0
func (p *ListMemoryExtractionJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListMemoryExtractionJobsPaginator) NextPage ¶ added in v1.9.0
func (p *ListMemoryExtractionJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMemoryExtractionJobsOutput, error)
NextPage retrieves the next ListMemoryExtractionJobs page.
type ListMemoryExtractionJobsPaginatorOptions ¶ added in v1.9.0
type ListMemoryExtractionJobsPaginatorOptions struct {
// The maximum number of results to return in a single call. The default value is
// 20.
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
}
ListMemoryExtractionJobsPaginatorOptions is the paginator options for ListMemoryExtractionJobs
type ListMemoryRecordsAPIClient ¶
type ListMemoryRecordsAPIClient interface {
ListMemoryRecords(context.Context, *ListMemoryRecordsInput, ...func(*Options)) (*ListMemoryRecordsOutput, error)
}
ListMemoryRecordsAPIClient is a client that implements the ListMemoryRecords operation.
type ListMemoryRecordsInput ¶
type ListMemoryRecordsInput struct {
// The identifier of the AgentCore Memory resource for which to list memory
// records.
//
// This member is required.
MemoryId *string
// The maximum number of results to return in a single call. The default value is
// 20.
MaxResults *int32
// The memory strategy identifier to filter memory records by. If specified, only
// memory records with this strategy ID are returned.
MemoryStrategyId *string
// A list of metadata filter expressions to scope the returned memory records.
MetadataFilters []types.MemoryMetadataFilterExpression
// The exact namespace to filter memory records by. Returns all memory records
// that matches the provided namespace. Either namespace or namespacePath is
// required.
Namespace *string
// Use namespacePath for hierarchical retrievals. Return all memory records where
// namespace falls under the same parent hierarchy. Either namespace or
// namespacePath is required.
NamespacePath *string
// The token for the next set of results. Use the value returned in the previous
// response in the next request to retrieve the next set of results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListMemoryRecordsInput) Serialize ¶ added in v1.28.3
func (v *ListMemoryRecordsInput) Serialize(s smithy.ShapeSerializer)
func (*ListMemoryRecordsInput) SerializeMembers ¶ added in v1.28.3
func (v *ListMemoryRecordsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListMemoryRecordsOutput ¶
type ListMemoryRecordsOutput struct {
// The list of memory record summaries that match the specified criteria.
//
// This member is required.
MemoryRecordSummaries []types.MemoryRecordSummary
// The token to use in a subsequent request to get the next set of results. This
// value is null when there are no more results to return.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListMemoryRecordsOutput) Deserialize ¶ added in v1.28.3
func (v *ListMemoryRecordsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListMemoryRecordsOutput) Serialize ¶ added in v1.53.0
func (v *ListMemoryRecordsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListMemoryRecordsOutput) SerializeMembers ¶ added in v1.53.0
func (v *ListMemoryRecordsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListMemoryRecordsPaginator ¶
type ListMemoryRecordsPaginator struct {
// contains filtered or unexported fields
}
ListMemoryRecordsPaginator is a paginator for ListMemoryRecords
func NewListMemoryRecordsPaginator ¶
func NewListMemoryRecordsPaginator(client ListMemoryRecordsAPIClient, params *ListMemoryRecordsInput, optFns ...func(*ListMemoryRecordsPaginatorOptions)) *ListMemoryRecordsPaginator
NewListMemoryRecordsPaginator returns a new ListMemoryRecordsPaginator
func (*ListMemoryRecordsPaginator) HasMorePages ¶
func (p *ListMemoryRecordsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListMemoryRecordsPaginator) NextPage ¶
func (p *ListMemoryRecordsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMemoryRecordsOutput, error)
NextPage retrieves the next ListMemoryRecords page.
type ListMemoryRecordsPaginatorOptions ¶
type ListMemoryRecordsPaginatorOptions struct {
// The maximum number of results to return in a single call. The default value is
// 20.
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
}
ListMemoryRecordsPaginatorOptions is the paginator options for ListMemoryRecords
type ListPaymentInstrumentsAPIClient ¶ added in v1.25.0
type ListPaymentInstrumentsAPIClient interface {
ListPaymentInstruments(context.Context, *ListPaymentInstrumentsInput, ...func(*Options)) (*ListPaymentInstrumentsOutput, error)
}
ListPaymentInstrumentsAPIClient is a client that implements the ListPaymentInstruments operation.
type ListPaymentInstrumentsInput ¶ added in v1.25.0
type ListPaymentInstrumentsInput struct {
// The ARN of the payment manager that owns the payment instruments.
//
// This member is required.
PaymentManagerArn *string
// The agent name associated with this request, used for observability.
AgentName *string
// Maximum number of results to return in a single response.
MaxResults *int32
// Token for pagination to retrieve the next set of results.
NextToken *string
// The ID of the payment connector to filter by.
PaymentConnectorId *string
// The user ID associated with the payment instruments.
UserId *string
// contains filtered or unexported fields
}
Request structure for listing payment instruments.
func (*ListPaymentInstrumentsInput) Serialize ¶ added in v1.28.3
func (v *ListPaymentInstrumentsInput) Serialize(s smithy.ShapeSerializer)
func (*ListPaymentInstrumentsInput) SerializeMembers ¶ added in v1.28.3
func (v *ListPaymentInstrumentsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListPaymentInstrumentsOutput ¶ added in v1.25.0
type ListPaymentInstrumentsOutput struct {
// List of payment instrument summaries matching the request criteria.
//
// This member is required.
PaymentInstruments []types.PaymentInstrumentSummary
// Token for pagination to retrieve the next set of results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for listing payment instruments.
func (*ListPaymentInstrumentsOutput) Deserialize ¶ added in v1.28.3
func (v *ListPaymentInstrumentsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListPaymentInstrumentsOutput) Serialize ¶ added in v1.53.0
func (v *ListPaymentInstrumentsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListPaymentInstrumentsOutput) SerializeMembers ¶ added in v1.53.0
func (v *ListPaymentInstrumentsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListPaymentInstrumentsPaginator ¶ added in v1.25.0
type ListPaymentInstrumentsPaginator struct {
// contains filtered or unexported fields
}
ListPaymentInstrumentsPaginator is a paginator for ListPaymentInstruments
func NewListPaymentInstrumentsPaginator ¶ added in v1.25.0
func NewListPaymentInstrumentsPaginator(client ListPaymentInstrumentsAPIClient, params *ListPaymentInstrumentsInput, optFns ...func(*ListPaymentInstrumentsPaginatorOptions)) *ListPaymentInstrumentsPaginator
NewListPaymentInstrumentsPaginator returns a new ListPaymentInstrumentsPaginator
func (*ListPaymentInstrumentsPaginator) HasMorePages ¶ added in v1.25.0
func (p *ListPaymentInstrumentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPaymentInstrumentsPaginator) NextPage ¶ added in v1.25.0
func (p *ListPaymentInstrumentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPaymentInstrumentsOutput, error)
NextPage retrieves the next ListPaymentInstruments page.
type ListPaymentInstrumentsPaginatorOptions ¶ added in v1.25.0
type ListPaymentInstrumentsPaginatorOptions struct {
// Maximum number of results to return in a single 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
}
ListPaymentInstrumentsPaginatorOptions is the paginator options for ListPaymentInstruments
type ListPaymentSessionsAPIClient ¶ added in v1.25.0
type ListPaymentSessionsAPIClient interface {
ListPaymentSessions(context.Context, *ListPaymentSessionsInput, ...func(*Options)) (*ListPaymentSessionsOutput, error)
}
ListPaymentSessionsAPIClient is a client that implements the ListPaymentSessions operation.
type ListPaymentSessionsInput ¶ added in v1.25.0
type ListPaymentSessionsInput struct {
// The ARN of the payment manager that owns the sessions.
//
// This member is required.
PaymentManagerArn *string
// The agent name associated with this request, used for observability.
AgentName *string
// Maximum number of results to return in a single response.
MaxResults *int32
// Token for pagination to retrieve the next set of results.
NextToken *string
// The user ID associated with the payment sessions.
UserId *string
// contains filtered or unexported fields
}
Request structure for listing payment sessions.
func (*ListPaymentSessionsInput) Serialize ¶ added in v1.28.3
func (v *ListPaymentSessionsInput) Serialize(s smithy.ShapeSerializer)
func (*ListPaymentSessionsInput) SerializeMembers ¶ added in v1.28.3
func (v *ListPaymentSessionsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListPaymentSessionsOutput ¶ added in v1.25.0
type ListPaymentSessionsOutput struct {
// List of payment session summaries matching the request criteria.
//
// This member is required.
PaymentSessions []types.PaymentSessionSummary
// Token for pagination to retrieve the next set of results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for listing payment sessions.
func (*ListPaymentSessionsOutput) Deserialize ¶ added in v1.28.3
func (v *ListPaymentSessionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListPaymentSessionsOutput) Serialize ¶ added in v1.53.0
func (v *ListPaymentSessionsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListPaymentSessionsOutput) SerializeMembers ¶ added in v1.53.0
func (v *ListPaymentSessionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListPaymentSessionsPaginator ¶ added in v1.25.0
type ListPaymentSessionsPaginator struct {
// contains filtered or unexported fields
}
ListPaymentSessionsPaginator is a paginator for ListPaymentSessions
func NewListPaymentSessionsPaginator ¶ added in v1.25.0
func NewListPaymentSessionsPaginator(client ListPaymentSessionsAPIClient, params *ListPaymentSessionsInput, optFns ...func(*ListPaymentSessionsPaginatorOptions)) *ListPaymentSessionsPaginator
NewListPaymentSessionsPaginator returns a new ListPaymentSessionsPaginator
func (*ListPaymentSessionsPaginator) HasMorePages ¶ added in v1.25.0
func (p *ListPaymentSessionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPaymentSessionsPaginator) NextPage ¶ added in v1.25.0
func (p *ListPaymentSessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPaymentSessionsOutput, error)
NextPage retrieves the next ListPaymentSessions page.
type ListPaymentSessionsPaginatorOptions ¶ added in v1.25.0
type ListPaymentSessionsPaginatorOptions struct {
// Maximum number of results to return in a single 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
}
ListPaymentSessionsPaginatorOptions is the paginator options for ListPaymentSessions
type ListRecommendationsAPIClient ¶ added in v1.23.0
type ListRecommendationsAPIClient interface {
ListRecommendations(context.Context, *ListRecommendationsInput, ...func(*Options)) (*ListRecommendationsOutput, error)
}
ListRecommendationsAPIClient is a client that implements the ListRecommendations operation.
type ListRecommendationsInput ¶ added in v1.23.0
type ListRecommendationsInput 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
// Optional filter to return only recommendations with the specified status.
StatusFilter types.RecommendationStatus
// contains filtered or unexported fields
}
func (*ListRecommendationsInput) Serialize ¶ added in v1.28.3
func (v *ListRecommendationsInput) Serialize(s smithy.ShapeSerializer)
func (*ListRecommendationsInput) SerializeMembers ¶ added in v1.28.3
func (v *ListRecommendationsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListRecommendationsOutput ¶ added in v1.23.0
type ListRecommendationsOutput struct {
// The list of recommendation summaries.
//
// This member is required.
RecommendationSummaries []types.RecommendationSummary
// 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
}
func (*ListRecommendationsOutput) Deserialize ¶ added in v1.28.3
func (v *ListRecommendationsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListRecommendationsOutput) Serialize ¶ added in v1.53.0
func (v *ListRecommendationsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListRecommendationsOutput) SerializeMembers ¶ added in v1.53.0
func (v *ListRecommendationsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListRecommendationsPaginator ¶ added in v1.23.0
type ListRecommendationsPaginator struct {
// contains filtered or unexported fields
}
ListRecommendationsPaginator is a paginator for ListRecommendations
func NewListRecommendationsPaginator ¶ added in v1.23.0
func NewListRecommendationsPaginator(client ListRecommendationsAPIClient, params *ListRecommendationsInput, optFns ...func(*ListRecommendationsPaginatorOptions)) *ListRecommendationsPaginator
NewListRecommendationsPaginator returns a new ListRecommendationsPaginator
func (*ListRecommendationsPaginator) HasMorePages ¶ added in v1.23.0
func (p *ListRecommendationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRecommendationsPaginator) NextPage ¶ added in v1.23.0
func (p *ListRecommendationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecommendationsOutput, error)
NextPage retrieves the next ListRecommendations page.
type ListRecommendationsPaginatorOptions ¶ added in v1.23.0
type ListRecommendationsPaginatorOptions 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
}
ListRecommendationsPaginatorOptions is the paginator options for ListRecommendations
type ListSessionsAPIClient ¶
type ListSessionsAPIClient interface {
ListSessions(context.Context, *ListSessionsInput, ...func(*Options)) (*ListSessionsOutput, error)
}
ListSessionsAPIClient is a client that implements the ListSessions operation.
type ListSessionsInput ¶
type ListSessionsInput struct {
// The identifier of the actor for which to list sessions.
//
// This member is required.
ActorId *string
// The identifier of the AgentCore Memory resource for which to list sessions.
//
// This member is required.
MemoryId *string
// Filter criteria to apply when listing sessions.
Filter *types.SessionFilter
// The maximum number of results to return in a single call. The default value is
// 20.
MaxResults *int32
// The token for the next set of results. Use the value returned in the previous
// response in the next request to retrieve the next set of results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListSessionsInput) Serialize ¶ added in v1.28.3
func (v *ListSessionsInput) Serialize(s smithy.ShapeSerializer)
func (*ListSessionsInput) SerializeMembers ¶ added in v1.28.3
func (v *ListSessionsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListSessionsOutput ¶
type ListSessionsOutput struct {
// The list of session summaries that match the specified criteria.
//
// This member is required.
SessionSummaries []types.SessionSummary
// The token to use in a subsequent request to get the next set of results. This
// value is null when there are no more results to return.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListSessionsOutput) Deserialize ¶ added in v1.28.3
func (v *ListSessionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListSessionsOutput) Serialize ¶ added in v1.53.0
func (v *ListSessionsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListSessionsOutput) SerializeMembers ¶ added in v1.53.0
func (v *ListSessionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListSessionsPaginator ¶
type ListSessionsPaginator struct {
// contains filtered or unexported fields
}
ListSessionsPaginator is a paginator for ListSessions
func NewListSessionsPaginator ¶
func NewListSessionsPaginator(client ListSessionsAPIClient, params *ListSessionsInput, optFns ...func(*ListSessionsPaginatorOptions)) *ListSessionsPaginator
NewListSessionsPaginator returns a new ListSessionsPaginator
func (*ListSessionsPaginator) HasMorePages ¶
func (p *ListSessionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListSessionsPaginator) NextPage ¶
func (p *ListSessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSessionsOutput, error)
NextPage retrieves the next ListSessions page.
type ListSessionsPaginatorOptions ¶
type ListSessionsPaginatorOptions struct {
// The maximum number of results to return in a single call. The default value is
// 20.
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
}
ListSessionsPaginatorOptions is the paginator options for ListSessions
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
// Disables SDK clock skew correction. When set, the SDK will not adjust request
// signing timestamps to compensate for clock drift between the client and the
// service.
DisableClockSkewCorrection bool
// 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.
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
Protocol smithyhttp.ClientProtocol
// The HTTP client to invoke API calls with. Defaults to client's default HTTP
// implementation if nil.
HTTPClient HTTPClient
// Client registry of operation interceptors.
Interceptors smithyhttp.InterceptorRegistry
// 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
// Priority list of preferred auth scheme names (e.g. sigv4a).
AuthSchemePreference []string
// contains filtered or unexported fields
}
func (Options) GetIdentityResolver ¶
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type PartialResult ¶ added in v1.14.0
type PartialResult struct {
Output any
Metadata middleware.Metadata
Error error
}
PartialResult represents a placeholder value to return immediately when calling an event streaming operation. This contains no meaningful result for the caller
type ProcessPaymentInput ¶ added in v1.25.0
type ProcessPaymentInput struct {
// The payment input details specific to the payment type.
//
// This member is required.
PaymentInput types.PaymentInput
// The ID of the payment instrument to use. For the CRYPTO_X402 and MPP payment
// types, specify the ID of a payment instrument that you created. For the
// AWS_BILLING_X402 payment type, specify the service-managed instrument ID
// aws.agentcorepayments.awsbilling.v1 . You don't create this instrument; it's
// available for any payment manager that has an AWS Billing payment connector.
//
// This member is required.
PaymentInstrumentId *string
// The ARN of the payment manager.
//
// This member is required.
PaymentManagerArn *string
// The ID of the payment session.
//
// This member is required.
PaymentSessionId *string
// The type of payment to process.
//
// This member is required.
PaymentType types.PaymentType
// The agent name associated with this request, used for observability.
AgentName *string
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request.
ClientToken *string
// The user ID associated with this payment.
UserId *string
// contains filtered or unexported fields
}
Request structure for processing a payment.
func (*ProcessPaymentInput) Serialize ¶ added in v1.28.3
func (v *ProcessPaymentInput) Serialize(s smithy.ShapeSerializer)
func (*ProcessPaymentInput) SerializeMembers ¶ added in v1.28.3
func (v *ProcessPaymentInput) SerializeMembers(s smithy.ShapeSerializer)
type ProcessPaymentOutput ¶ added in v1.25.0
type ProcessPaymentOutput struct {
// The timestamp when the payment was created.
//
// This member is required.
CreatedAt *time.Time
// The ID of the payment instrument used. For the AWS_BILLING_X402 payment type,
// this is the service-managed instrument ID aws.agentcorepayments.awsbilling.v1 .
//
// This member is required.
PaymentInstrumentId *string
// The ARN of the payment manager.
//
// This member is required.
PaymentManagerArn *string
// The payment output details specific to the payment type.
//
// This member is required.
PaymentOutput types.PaymentOutput
// The ID of the payment session used.
//
// This member is required.
PaymentSessionId *string
// The type of payment processed.
//
// This member is required.
PaymentType types.PaymentType
// The unique identifier of the processed payment.
//
// This member is required.
ProcessPaymentId *string
// The status of the payment.
//
// This member is required.
Status types.PaymentStatus
// The timestamp when the payment was last updated.
//
// This member is required.
UpdatedAt *time.Time
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for processing a payment.
func (*ProcessPaymentOutput) Deserialize ¶ added in v1.28.3
func (v *ProcessPaymentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ProcessPaymentOutput) Serialize ¶ added in v1.53.0
func (v *ProcessPaymentOutput) Serialize(s smithy.ShapeSerializer)
func (*ProcessPaymentOutput) SerializeMembers ¶ added in v1.53.0
func (v *ProcessPaymentOutput) SerializeMembers(s smithy.ShapeSerializer)
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 RetrieveMemoryRecordsAPIClient ¶
type RetrieveMemoryRecordsAPIClient interface {
RetrieveMemoryRecords(context.Context, *RetrieveMemoryRecordsInput, ...func(*Options)) (*RetrieveMemoryRecordsOutput, error)
}
RetrieveMemoryRecordsAPIClient is a client that implements the RetrieveMemoryRecords operation.
type RetrieveMemoryRecordsInput ¶
type RetrieveMemoryRecordsInput struct {
// The identifier of the AgentCore Memory resource from which to retrieve memory
// records.
//
// This member is required.
MemoryId *string
// The search criteria to use for finding relevant memory records. This includes
// the search query, memory strategy ID, and other search parameters.
//
// This member is required.
SearchCriteria *types.SearchCriteria
// The maximum number of results to return in a single call. The default value is
// 20.
MaxResults *int32
// The exact namespace to filter memory records by. Searches for memory records
// that matches the provided namespace value. Either namespace or namespacePath is
// required.
Namespace *string
// Use namespacePath for hierarchical retrievals. Return all memory records where
// namespace falls under the same parent hierarchy. Either namespace or
// namespacePath is required.
NamespacePath *string
// The token for the next set of results. Use the value returned in the previous
// response in the next request to retrieve the next set of results.
NextToken *string
// contains filtered or unexported fields
}
func (*RetrieveMemoryRecordsInput) Serialize ¶ added in v1.28.3
func (v *RetrieveMemoryRecordsInput) Serialize(s smithy.ShapeSerializer)
func (*RetrieveMemoryRecordsInput) SerializeMembers ¶ added in v1.28.3
func (v *RetrieveMemoryRecordsInput) SerializeMembers(s smithy.ShapeSerializer)
type RetrieveMemoryRecordsOutput ¶
type RetrieveMemoryRecordsOutput struct {
// The list of memory record summaries that match the search criteria, ordered by
// relevance.
//
// This member is required.
MemoryRecordSummaries []types.MemoryRecordSummary
// The token to use in a subsequent request to get the next set of results. This
// value is null when there are no more results to return.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*RetrieveMemoryRecordsOutput) Deserialize ¶ added in v1.28.3
func (v *RetrieveMemoryRecordsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*RetrieveMemoryRecordsOutput) Serialize ¶ added in v1.53.0
func (v *RetrieveMemoryRecordsOutput) Serialize(s smithy.ShapeSerializer)
func (*RetrieveMemoryRecordsOutput) SerializeMembers ¶ added in v1.53.0
func (v *RetrieveMemoryRecordsOutput) SerializeMembers(s smithy.ShapeSerializer)
type RetrieveMemoryRecordsPaginator ¶
type RetrieveMemoryRecordsPaginator struct {
// contains filtered or unexported fields
}
RetrieveMemoryRecordsPaginator is a paginator for RetrieveMemoryRecords
func NewRetrieveMemoryRecordsPaginator ¶
func NewRetrieveMemoryRecordsPaginator(client RetrieveMemoryRecordsAPIClient, params *RetrieveMemoryRecordsInput, optFns ...func(*RetrieveMemoryRecordsPaginatorOptions)) *RetrieveMemoryRecordsPaginator
NewRetrieveMemoryRecordsPaginator returns a new RetrieveMemoryRecordsPaginator
func (*RetrieveMemoryRecordsPaginator) HasMorePages ¶
func (p *RetrieveMemoryRecordsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*RetrieveMemoryRecordsPaginator) NextPage ¶
func (p *RetrieveMemoryRecordsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*RetrieveMemoryRecordsOutput, error)
NextPage retrieves the next RetrieveMemoryRecords page.
type RetrieveMemoryRecordsPaginatorOptions ¶
type RetrieveMemoryRecordsPaginatorOptions struct {
// The maximum number of results to return in a single call. The default value is
// 20.
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
}
RetrieveMemoryRecordsPaginatorOptions is the paginator options for RetrieveMemoryRecords
type SaveBrowserSessionProfileInput ¶ added in v1.12.0
type SaveBrowserSessionProfileInput struct {
// The unique identifier of the browser associated with the session from which to
// save the profile.
//
// This member is required.
BrowserIdentifier *string
// The unique identifier for the browser profile. This identifier is used to
// reference the profile when starting new browser sessions. The identifier must
// follow the pattern of an alphanumeric name (up to 48 characters) followed by a
// hyphen and a 10-character alphanumeric suffix.
//
// This member is required.
ProfileIdentifier *string
// The unique identifier of the browser session from which to save the profile.
// The session must be active when saving the profile.
//
// This member is required.
SessionId *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
// AgentCore ignores the request, but does not return an error.
ClientToken *string
// The trace identifier for request tracking.
TraceId *string
// The parent trace information for distributed tracing.
TraceParent *string
// contains filtered or unexported fields
}
func (*SaveBrowserSessionProfileInput) Serialize ¶ added in v1.28.3
func (v *SaveBrowserSessionProfileInput) Serialize(s smithy.ShapeSerializer)
func (*SaveBrowserSessionProfileInput) SerializeMembers ¶ added in v1.28.3
func (v *SaveBrowserSessionProfileInput) SerializeMembers(s smithy.ShapeSerializer)
type SaveBrowserSessionProfileOutput ¶ added in v1.12.0
type SaveBrowserSessionProfileOutput struct {
// The unique identifier of the browser associated with the session from which the
// profile was saved.
//
// This member is required.
BrowserIdentifier *string
// The timestamp when the browser profile was last updated. This value is in ISO
// 8601 format.
//
// This member is required.
LastUpdatedAt *time.Time
// The unique identifier of the saved browser profile.
//
// This member is required.
ProfileIdentifier *string
// The unique identifier of the browser session from which the profile was saved.
//
// This member is required.
SessionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SaveBrowserSessionProfileOutput) Deserialize ¶ added in v1.28.3
func (v *SaveBrowserSessionProfileOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SaveBrowserSessionProfileOutput) Serialize ¶ added in v1.53.0
func (v *SaveBrowserSessionProfileOutput) Serialize(s smithy.ShapeSerializer)
func (*SaveBrowserSessionProfileOutput) SerializeMembers ¶ added in v1.53.0
func (v *SaveBrowserSessionProfileOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchRegistryRecordsInput ¶ added in v1.20.0
type SearchRegistryRecordsInput struct {
// The list of registry identifiers to search within. Currently, you can specify
// exactly one registry identifier. You can provide either the full Amazon Web
// Services Resource Name (ARN) or the 12-character alphanumeric registry ID.
//
// This member is required.
RegistryIds []string
// The search query to find matching registry records.
//
// This member is required.
SearchQuery *string
// A metadata filter expression to narrow search results. Uses structured JSON
// operators including field-level operators ( $eq , $ne , $in ) and logical
// operators ( $and , $or ) on filterable fields ( name , descriptorType , version
// ). For example, to filter by descriptor type: {"descriptorType": {"$eq":
// "MCP"}} . To combine filters: {"$and": [{"descriptorType": {"$eq": "MCP"}},
// {"name": {"$eq": "my-tool"}}]} .
Filters document.Interface
// The maximum number of records to return in a single call. Valid values are 1
// through 20. The default value is 10.
MaxResults *int32
// contains filtered or unexported fields
}
func (*SearchRegistryRecordsInput) Serialize ¶ added in v1.28.3
func (v *SearchRegistryRecordsInput) Serialize(s smithy.ShapeSerializer)
func (*SearchRegistryRecordsInput) SerializeMembers ¶ added in v1.28.3
func (v *SearchRegistryRecordsInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchRegistryRecordsOutput ¶ added in v1.20.0
type SearchRegistryRecordsOutput struct {
// The list of registry records that match the search query, ordered by relevance.
//
// This member is required.
RegistryRecords []types.RegistryRecordSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchRegistryRecordsOutput) Deserialize ¶ added in v1.28.3
func (v *SearchRegistryRecordsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchRegistryRecordsOutput) Serialize ¶ added in v1.53.0
func (v *SearchRegistryRecordsOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchRegistryRecordsOutput) SerializeMembers ¶ added in v1.53.0
func (v *SearchRegistryRecordsOutput) SerializeMembers(s smithy.ShapeSerializer)
type StartBatchEvaluationInput ¶ added in v1.23.0
type StartBatchEvaluationInput struct {
// The name of the batch evaluation. Must be unique within your account.
//
// This member is required.
BatchEvaluationName *string
// The data source configuration that specifies where to pull agent session traces
// from for evaluation.
//
// This member is required.
DataSourceConfig types.DataSourceConfig
// A unique, case-sensitive identifier to ensure that the API request completes no
// more than one time. If this token matches a previous request, the service
// ignores the request, but does not return an error.
ClientToken *string
// The configuration for running the scenarios in a dataset against an agent
// before evaluating the resulting sessions. When you specify this field, the batch
// evaluation runs each scenario in the dataset against the agent. It then
// evaluates the sessions that the agent produces. You must also specify evaluators
// and a dataSourceConfig that uses cloudWatchLogs . Configure cloudWatchLogs with
// the service name and log groups that the agent uses for its traces. You can't
// specify insights or an onlineEvaluationConfigSource data source with this field.
DatasetExecutionConfig *types.DatasetExecutionConfig
// The description of the batch evaluation.
Description *string
// Optional metadata for the evaluation, including session-specific ground truth
// data and test scenario identifiers.
EvaluationMetadata types.EvaluationMetadata
// The list of evaluators to apply during the batch evaluation. Can include both
// built-in evaluators and custom evaluators. Maximum of 10 evaluators.
Evaluators []types.Evaluator
// The list of insight analyses to run against sessions during the batch
// evaluation. Maximum of 10 insights.
Insights []types.Insight
// The ARN of the KMS key used to encrypt evaluation data. If provided, customer
// data is encrypted at rest with the specified key.
KmsKeyArn *string
// Output destination configuration.
OutputConfig types.OutputConfig
// A map of tag keys and values to associate with the batch evaluation.
Tags map[string]string
// contains filtered or unexported fields
}
func (*StartBatchEvaluationInput) Serialize ¶ added in v1.28.3
func (v *StartBatchEvaluationInput) Serialize(s smithy.ShapeSerializer)
func (*StartBatchEvaluationInput) SerializeMembers ¶ added in v1.28.3
func (v *StartBatchEvaluationInput) SerializeMembers(s smithy.ShapeSerializer)
type StartBatchEvaluationOutput ¶ added in v1.23.0
type StartBatchEvaluationOutput struct {
// The Amazon Resource Name (ARN) of the created batch evaluation.
//
// This member is required.
BatchEvaluationArn *string
// The unique identifier of the created batch evaluation.
//
// This member is required.
BatchEvaluationId *string
// The name of the batch evaluation.
//
// This member is required.
BatchEvaluationName *string
// The timestamp when the batch evaluation was created.
//
// This member is required.
CreatedAt *time.Time
// The status of the batch evaluation.
//
// This member is required.
Status types.BatchEvaluationStatus
// The description of the batch evaluation.
Description *string
// The list of evaluators applied during the batch evaluation.
Evaluators []types.Evaluator
// The list of insight analyses applied during the batch evaluation.
Insights []types.Insight
// The ARN of the KMS key used to encrypt evaluation data.
KmsKeyArn *string
// The output configuration specifying where evaluation results are written.
OutputConfig types.OutputConfig
// The tags associated with the batch evaluation.
Tags map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StartBatchEvaluationOutput) Deserialize ¶ added in v1.28.3
func (v *StartBatchEvaluationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StartBatchEvaluationOutput) Serialize ¶ added in v1.53.0
func (v *StartBatchEvaluationOutput) Serialize(s smithy.ShapeSerializer)
func (*StartBatchEvaluationOutput) SerializeMembers ¶ added in v1.53.0
func (v *StartBatchEvaluationOutput) SerializeMembers(s smithy.ShapeSerializer)
type StartBrowserSessionInput ¶
type StartBrowserSessionInput struct {
// The unique identifier of the browser to use for this session. This identifier
// specifies which browser environment to initialize for the session.
//
// This member is required.
BrowserIdentifier *string
// A list of certificates to install in the browser session.
Certificates []types.Certificate
// 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
// AgentCore ignores the request, but does not return an error. This parameter
// helps prevent the creation of duplicate sessions if there are temporary network
// issues.
ClientToken *string
// A list of files containing enterprise policies for the browser.
EnterprisePolicies []types.BrowserEnterprisePolicy
// A list of browser extensions to load into the browser session.
Extensions []types.BrowserExtension
// The file system configurations to mount into the browser session. Use these
// configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files
// or Amazon Elastic File System (Amazon EFS) access points. Your session can then
// read and write your data. If you don't specify this field, no additional file
// systems are mounted.
FilesystemConfigurations []types.ToolsFileSystemConfiguration
// The name of the browser session. This name helps you identify and manage the
// session. The name does not need to be unique.
Name *string
// The browser profile configuration to use for this session. A browser profile
// contains persistent data such as cookies and local storage that can be reused
// across multiple browser sessions. If specified, the session initializes with the
// profile's stored data, enabling continuity for tasks that require authentication
// or personalized settings.
ProfileConfiguration *types.BrowserProfileConfiguration
// Optional proxy configuration for routing browser traffic through
// customer-specified proxy servers. When provided, enables HTTP Basic
// authentication via Amazon Web Services Secrets Manager and domain-based routing
// rules. Requires secretsmanager:GetSecretValue IAM permission for the specified
// secret ARNs.
ProxyConfiguration *types.ProxyConfiguration
// The duration in seconds (time-to-live) after which the session automatically
// terminates, regardless of ongoing activity. Defaults to 3600 seconds (1 hour).
// Recommended minimum: 60 seconds. Maximum allowed: 28,800 seconds (8 hours).
SessionTimeoutSeconds *int32
// The trace identifier for request tracking.
TraceId *string
// The parent trace information for distributed tracing.
TraceParent *string
// The dimensions of the browser viewport for this session. This determines the
// visible area of the web content and affects how web pages are rendered. If not
// specified, Amazon Bedrock AgentCore uses a default viewport size.
ViewPort *types.ViewPort
// contains filtered or unexported fields
}
func (*StartBrowserSessionInput) Serialize ¶ added in v1.28.3
func (v *StartBrowserSessionInput) Serialize(s smithy.ShapeSerializer)
func (*StartBrowserSessionInput) SerializeMembers ¶ added in v1.28.3
func (v *StartBrowserSessionInput) SerializeMembers(s smithy.ShapeSerializer)
type StartBrowserSessionOutput ¶
type StartBrowserSessionOutput struct {
// The identifier of the browser.
//
// This member is required.
BrowserIdentifier *string
// The timestamp when the browser session was created.
//
// This member is required.
CreatedAt *time.Time
// The unique identifier of the created browser session.
//
// This member is required.
SessionId *string
// The streams associated with this browser session. These include the automation
// stream and live view stream.
Streams *types.BrowserSessionStream
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StartBrowserSessionOutput) Deserialize ¶ added in v1.28.3
func (v *StartBrowserSessionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StartBrowserSessionOutput) Serialize ¶ added in v1.53.0
func (v *StartBrowserSessionOutput) Serialize(s smithy.ShapeSerializer)
func (*StartBrowserSessionOutput) SerializeMembers ¶ added in v1.53.0
func (v *StartBrowserSessionOutput) SerializeMembers(s smithy.ShapeSerializer)
type StartCodeInterpreterSessionInput ¶
type StartCodeInterpreterSessionInput struct {
// The unique identifier of the code interpreter to use for this session. This
// identifier specifies which code interpreter environment to initialize for the
// session.
//
// This member is required.
CodeInterpreterIdentifier *string
// A list of certificates to install in the code interpreter session.
Certificates []types.Certificate
// 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
// AgentCore ignores the request, but does not return an error. This parameter
// helps prevent the creation of duplicate sessions if there are temporary network
// issues.
ClientToken *string
// The file system configurations to mount into the code interpreter session. Use
// these configurations to mount your own Amazon Simple Storage Service (Amazon S3)
// Files or Amazon Elastic File System (Amazon EFS) access points. Your session can
// then read and write your data. If you don't specify this field, no additional
// file systems are mounted.
FilesystemConfigurations []types.ToolsFileSystemConfiguration
// The name of the code interpreter session. This name helps you identify and
// manage the session. The name does not need to be unique.
Name *string
// The duration in seconds (time-to-live) after which the session automatically
// terminates, regardless of ongoing activity. Defaults to 900 seconds (15
// minutes). Recommended minimum: 60 seconds. Maximum allowed: 28,800 seconds (8
// hours).
SessionTimeoutSeconds *int32
// The trace identifier for request tracking.
TraceId *string
// The parent trace information for distributed tracing.
TraceParent *string
// contains filtered or unexported fields
}
func (*StartCodeInterpreterSessionInput) Serialize ¶ added in v1.28.3
func (v *StartCodeInterpreterSessionInput) Serialize(s smithy.ShapeSerializer)
func (*StartCodeInterpreterSessionInput) SerializeMembers ¶ added in v1.28.3
func (v *StartCodeInterpreterSessionInput) SerializeMembers(s smithy.ShapeSerializer)
type StartCodeInterpreterSessionOutput ¶
type StartCodeInterpreterSessionOutput struct {
// The identifier of the code interpreter.
//
// This member is required.
CodeInterpreterIdentifier *string
// The time at which the code interpreter session was created.
//
// This member is required.
CreatedAt *time.Time
// The unique identifier of the created code interpreter session.
//
// This member is required.
SessionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StartCodeInterpreterSessionOutput) Deserialize ¶ added in v1.28.3
func (v *StartCodeInterpreterSessionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StartCodeInterpreterSessionOutput) Serialize ¶ added in v1.53.0
func (v *StartCodeInterpreterSessionOutput) Serialize(s smithy.ShapeSerializer)
func (*StartCodeInterpreterSessionOutput) SerializeMembers ¶ added in v1.53.0
func (v *StartCodeInterpreterSessionOutput) SerializeMembers(s smithy.ShapeSerializer)
type StartDatasetGenerationInput ¶ added in v1.59.0
type StartDatasetGenerationInput struct {
// The unique identifier of the dataset to add the generated examples to. The
// dataset must be ACTIVE .
//
// This member is required.
DatasetId *string
// The name of the dataset generation. The generation ID starts with this name.
//
// This member is required.
Name *string
// Where the generation reads sessions from, and how it selects, samples, labels
// and redacts them.
//
// This member is required.
Source types.GenerationSource
// A unique, case-sensitive identifier to ensure that the API request completes no
// more than one time. If this token matches a previous request, the service
// ignores the request, but does not return an error.
ClientToken *string
// A description of the dataset generation.
Description *string
// The type of scenario to generate. If you don't specify a value, the generation
// produces DYNAMIC scenarios.
ScenarioType types.ScenarioType
// contains filtered or unexported fields
}
func (*StartDatasetGenerationInput) Serialize ¶ added in v1.59.0
func (v *StartDatasetGenerationInput) Serialize(s smithy.ShapeSerializer)
func (*StartDatasetGenerationInput) SerializeMembers ¶ added in v1.59.0
func (v *StartDatasetGenerationInput) SerializeMembers(s smithy.ShapeSerializer)
type StartDatasetGenerationOutput ¶ added in v1.59.0
type StartDatasetGenerationOutput struct {
// The time at which the dataset generation started.
//
// This member is required.
CreatedAt *time.Time
// The unique identifier of the dataset.
//
// This member is required.
DatasetId *string
// The unique identifier of the dataset generation.
//
// This member is required.
GenerationId *string
// The name of the dataset generation.
//
// This member is required.
Name *string
// The status of the dataset generation.
//
// This member is required.
Status types.DatasetGenerationStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StartDatasetGenerationOutput) Deserialize ¶ added in v1.59.0
func (v *StartDatasetGenerationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StartDatasetGenerationOutput) Serialize ¶ added in v1.59.0
func (v *StartDatasetGenerationOutput) Serialize(s smithy.ShapeSerializer)
func (*StartDatasetGenerationOutput) SerializeMembers ¶ added in v1.59.0
func (v *StartDatasetGenerationOutput) SerializeMembers(s smithy.ShapeSerializer)
type StartMemoryExtractionJobInput ¶ added in v1.9.0
type StartMemoryExtractionJobInput struct {
// Extraction job to start in this operation.
//
// This member is required.
ExtractionJob *types.ExtractionJob
// The unique identifier of the memory for which to start extraction jobs.
//
// This member is required.
MemoryId *string
// A unique, case-sensitive identifier to ensure idempotent processing of the
// request.
ClientToken *string
// contains filtered or unexported fields
}
func (*StartMemoryExtractionJobInput) Serialize ¶ added in v1.28.3
func (v *StartMemoryExtractionJobInput) Serialize(s smithy.ShapeSerializer)
func (*StartMemoryExtractionJobInput) SerializeMembers ¶ added in v1.28.3
func (v *StartMemoryExtractionJobInput) SerializeMembers(s smithy.ShapeSerializer)
type StartMemoryExtractionJobOutput ¶ added in v1.9.0
type StartMemoryExtractionJobOutput struct {
// Extraction Job ID that was attempted to start.
//
// This member is required.
JobId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StartMemoryExtractionJobOutput) Deserialize ¶ added in v1.28.3
func (v *StartMemoryExtractionJobOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StartMemoryExtractionJobOutput) Serialize ¶ added in v1.53.0
func (v *StartMemoryExtractionJobOutput) Serialize(s smithy.ShapeSerializer)
func (*StartMemoryExtractionJobOutput) SerializeMembers ¶ added in v1.53.0
func (v *StartMemoryExtractionJobOutput) SerializeMembers(s smithy.ShapeSerializer)
type StartRecommendationInput ¶ added in v1.23.0
type StartRecommendationInput struct {
// The name of the recommendation. Must be unique within your account.
//
// This member is required.
Name *string
// The configuration for the recommendation, including the input to optimize,
// agent traces to analyze, and evaluation settings.
//
// This member is required.
RecommendationConfig types.RecommendationConfig
// The type of recommendation to generate. Valid values are
// SYSTEM_PROMPT_RECOMMENDATION for system prompt optimization or
// TOOL_DESCRIPTION_RECOMMENDATION for tool description optimization.
//
// This member is required.
Type types.RecommendationType
// A unique, case-sensitive identifier to ensure that the API request completes no
// more than one time. If this token matches a previous request, the service
// ignores the request, but does not return an error.
ClientToken *string
// The description of the recommendation.
Description *string
// The ARN of the KMS key used to encrypt recommendation data. If provided,
// customer data is encrypted at rest with the specified key.
KmsKeyArn *string
// A map of tag keys and values to associate with the recommendation.
Tags map[string]string
// contains filtered or unexported fields
}
func (*StartRecommendationInput) Serialize ¶ added in v1.28.3
func (v *StartRecommendationInput) Serialize(s smithy.ShapeSerializer)
func (*StartRecommendationInput) SerializeMembers ¶ added in v1.28.3
func (v *StartRecommendationInput) SerializeMembers(s smithy.ShapeSerializer)
type StartRecommendationOutput ¶ added in v1.23.0
type StartRecommendationOutput struct {
// The timestamp when the recommendation was created.
//
// This member is required.
CreatedAt *time.Time
// The name of the recommendation.
//
// This member is required.
Name *string
// The Amazon Resource Name (ARN) of the created recommendation.
//
// This member is required.
RecommendationArn *string
// The configuration for the recommendation.
//
// This member is required.
RecommendationConfig types.RecommendationConfig
// The unique identifier of the created recommendation.
//
// This member is required.
RecommendationId *string
// The status of the recommendation.
//
// This member is required.
Status types.RecommendationStatus
// The type of recommendation.
//
// This member is required.
Type types.RecommendationType
// The timestamp when the recommendation was last updated.
//
// This member is required.
UpdatedAt *time.Time
// The description of the recommendation.
Description *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StartRecommendationOutput) Deserialize ¶ added in v1.28.3
func (v *StartRecommendationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StartRecommendationOutput) Serialize ¶ added in v1.53.0
func (v *StartRecommendationOutput) Serialize(s smithy.ShapeSerializer)
func (*StartRecommendationOutput) SerializeMembers ¶ added in v1.53.0
func (v *StartRecommendationOutput) SerializeMembers(s smithy.ShapeSerializer)
type StopBatchEvaluationInput ¶ added in v1.23.0
type StopBatchEvaluationInput struct {
// The unique identifier of the batch evaluation to stop.
//
// This member is required.
BatchEvaluationId *string
// contains filtered or unexported fields
}
func (*StopBatchEvaluationInput) Serialize ¶ added in v1.28.3
func (v *StopBatchEvaluationInput) Serialize(s smithy.ShapeSerializer)
func (*StopBatchEvaluationInput) SerializeMembers ¶ added in v1.28.3
func (v *StopBatchEvaluationInput) SerializeMembers(s smithy.ShapeSerializer)
type StopBatchEvaluationOutput ¶ added in v1.23.0
type StopBatchEvaluationOutput struct {
// The Amazon Resource Name (ARN) of the stopped batch evaluation.
//
// This member is required.
BatchEvaluationArn *string
// The unique identifier of the stopped batch evaluation.
//
// This member is required.
BatchEvaluationId *string
// The status of the batch evaluation after the stop request.
//
// This member is required.
Status types.BatchEvaluationStatus
// The description of the batch evaluation.
Description *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StopBatchEvaluationOutput) Deserialize ¶ added in v1.28.3
func (v *StopBatchEvaluationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StopBatchEvaluationOutput) Serialize ¶ added in v1.53.0
func (v *StopBatchEvaluationOutput) Serialize(s smithy.ShapeSerializer)
func (*StopBatchEvaluationOutput) SerializeMembers ¶ added in v1.53.0
func (v *StopBatchEvaluationOutput) SerializeMembers(s smithy.ShapeSerializer)
type StopBrowserSessionInput ¶
type StopBrowserSessionInput struct {
// The unique identifier of the browser associated with the session.
//
// This member is required.
BrowserIdentifier *string
// The unique identifier of the browser session to stop.
//
// This member is required.
SessionId *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
// AgentCore ignores the request, but does not return an error.
ClientToken *string
// The trace identifier for request tracking.
TraceId *string
// The parent trace information for distributed tracing.
TraceParent *string
// contains filtered or unexported fields
}
func (*StopBrowserSessionInput) Serialize ¶ added in v1.28.3
func (v *StopBrowserSessionInput) Serialize(s smithy.ShapeSerializer)
func (*StopBrowserSessionInput) SerializeMembers ¶ added in v1.28.3
func (v *StopBrowserSessionInput) SerializeMembers(s smithy.ShapeSerializer)
type StopBrowserSessionOutput ¶
type StopBrowserSessionOutput struct {
// The identifier of the browser.
//
// This member is required.
BrowserIdentifier *string
// The time at which the browser session was last updated.
//
// This member is required.
LastUpdatedAt *time.Time
// The identifier of the browser session.
//
// This member is required.
SessionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StopBrowserSessionOutput) Deserialize ¶ added in v1.28.3
func (v *StopBrowserSessionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StopBrowserSessionOutput) Serialize ¶ added in v1.53.0
func (v *StopBrowserSessionOutput) Serialize(s smithy.ShapeSerializer)
func (*StopBrowserSessionOutput) SerializeMembers ¶ added in v1.53.0
func (v *StopBrowserSessionOutput) SerializeMembers(s smithy.ShapeSerializer)
type StopCodeInterpreterSessionInput ¶
type StopCodeInterpreterSessionInput struct {
// The unique identifier of the code interpreter associated with the session.
//
// This member is required.
CodeInterpreterIdentifier *string
// The unique identifier of the code interpreter session to stop.
//
// This member is required.
SessionId *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
// AgentCore ignores the request, but does not return an error.
ClientToken *string
// The trace identifier for request tracking.
TraceId *string
// The parent trace information for distributed tracing.
TraceParent *string
// contains filtered or unexported fields
}
func (*StopCodeInterpreterSessionInput) Serialize ¶ added in v1.28.3
func (v *StopCodeInterpreterSessionInput) Serialize(s smithy.ShapeSerializer)
func (*StopCodeInterpreterSessionInput) SerializeMembers ¶ added in v1.28.3
func (v *StopCodeInterpreterSessionInput) SerializeMembers(s smithy.ShapeSerializer)
type StopCodeInterpreterSessionOutput ¶
type StopCodeInterpreterSessionOutput struct {
// The identifier of the code interpreter.
//
// This member is required.
CodeInterpreterIdentifier *string
// The timestamp when the code interpreter session was last updated.
//
// This member is required.
LastUpdatedAt *time.Time
// The identifier of the code interpreter session.
//
// This member is required.
SessionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StopCodeInterpreterSessionOutput) Deserialize ¶ added in v1.28.3
func (v *StopCodeInterpreterSessionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StopCodeInterpreterSessionOutput) Serialize ¶ added in v1.53.0
func (v *StopCodeInterpreterSessionOutput) Serialize(s smithy.ShapeSerializer)
func (*StopCodeInterpreterSessionOutput) SerializeMembers ¶ added in v1.53.0
func (v *StopCodeInterpreterSessionOutput) SerializeMembers(s smithy.ShapeSerializer)
type StopRuntimeSessionInput ¶ added in v1.5.0
type StopRuntimeSessionInput struct {
// The ARN of the agent that contains the session that you want to stop.
//
// This member is required.
AgentRuntimeArn *string
// The ID of the session that you want to stop.
//
// This member is required.
RuntimeSessionId *string
// Idempotent token used to identify the request. If you use the same token with
// multiple requests, the same response is returned. Use ClientToken to prevent the
// same request from being processed more than once.
ClientToken *string
// Optional qualifier to specify an agent alias, such as prod code> or dev . If you
// don't provide a value, the DEFAULT alias is used.
Qualifier *string
// contains filtered or unexported fields
}
func (*StopRuntimeSessionInput) Serialize ¶ added in v1.28.3
func (v *StopRuntimeSessionInput) Serialize(s smithy.ShapeSerializer)
func (*StopRuntimeSessionInput) SerializeMembers ¶ added in v1.28.3
func (v *StopRuntimeSessionInput) SerializeMembers(s smithy.ShapeSerializer)
type StopRuntimeSessionOutput ¶ added in v1.5.0
type StopRuntimeSessionOutput struct {
// The ID of the session that you requested to stop.
RuntimeSessionId *string
// The status code of the request to stop the session.
StatusCode *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StopRuntimeSessionOutput) Deserialize ¶ added in v1.28.3
func (v *StopRuntimeSessionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StopRuntimeSessionOutput) Serialize ¶ added in v1.53.0
func (v *StopRuntimeSessionOutput) Serialize(s smithy.ShapeSerializer)
func (*StopRuntimeSessionOutput) SerializeMembers ¶ added in v1.53.0
func (v *StopRuntimeSessionOutput) SerializeMembers(s smithy.ShapeSerializer)
type UnknownEventMessageError ¶
type UnknownEventMessageError struct {
Type string
Message eventstream.Message
}
UnknownEventMessageError provides an error when a message is received from the stream, but the reader is unable to determine what kind of message it is.
func (*UnknownEventMessageError) Error ¶
func (e *UnknownEventMessageError) Error() string
Error retruns the error message string.
type UpdateABTestInput ¶ added in v1.23.0
type UpdateABTestInput struct {
// The unique identifier of the A/B test to update.
//
// This member is required.
AbTestId *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, the service
// ignores the request, but does not return an error.
ClientToken *string
// The updated description of the A/B test.
Description *string
// The updated evaluation configuration.
EvaluationConfig types.ABTestEvaluationConfig
// The updated execution status to enable or disable the A/B test.
ExecutionStatus types.ABTestExecutionStatus
// The updated gateway filter.
GatewayFilter *types.GatewayFilter
// The updated name of the A/B test.
Name *string
// The updated IAM role ARN.
RoleArn *string
// The updated list of variants.
Variants []types.Variant
// contains filtered or unexported fields
}
func (*UpdateABTestInput) Serialize ¶ added in v1.28.3
func (v *UpdateABTestInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateABTestInput) SerializeMembers ¶ added in v1.28.3
func (v *UpdateABTestInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateABTestOutput ¶ added in v1.23.0
type UpdateABTestOutput struct {
// The Amazon Resource Name (ARN) of the updated A/B test.
//
// This member is required.
AbTestArn *string
// The unique identifier of the updated A/B test.
//
// This member is required.
AbTestId *string
// The execution status of the A/B test.
//
// This member is required.
ExecutionStatus types.ABTestExecutionStatus
// The status of the A/B test.
//
// This member is required.
Status types.ABTestStatus
// The timestamp when the A/B test was updated.
//
// This member is required.
UpdatedAt *time.Time
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateABTestOutput) Deserialize ¶ added in v1.28.3
func (v *UpdateABTestOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateABTestOutput) Serialize ¶ added in v1.53.0
func (v *UpdateABTestOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateABTestOutput) SerializeMembers ¶ added in v1.53.0
func (v *UpdateABTestOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAgentInsightInput ¶ added in v1.59.0
type UpdateAgentInsightInput struct {
// The unique identifier of the Agent Insight to update.
//
// This member is required.
AgentInsightId *string
// The application that the Agent Insight belongs to.
//
// This member is required.
ApplicationName *string
// The archive status to apply to the Agent Insight. Valid values:
//
// - ACTIVE - Marks the insight as active.
//
// - ARCHIVED - Marks the insight as archived.
//
// This member is required.
ArchiveStatus types.AgentInsightArchiveStatus
// contains filtered or unexported fields
}
func (*UpdateAgentInsightInput) Serialize ¶ added in v1.59.0
func (v *UpdateAgentInsightInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAgentInsightInput) SerializeMembers ¶ added in v1.59.0
func (v *UpdateAgentInsightInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAgentInsightOutput ¶ added in v1.59.0
type UpdateAgentInsightOutput struct {
// The unique identifier of the updated Agent Insight.
//
// This member is required.
AgentInsightId *string
// The archive status of the updated Agent Insight. Valid values:
//
// - ACTIVE - The insight is active.
//
// - ARCHIVED - The insight is archived.
//
// This member is required.
ArchiveStatus types.AgentInsightArchiveStatus
// The date and time when the Agent Insight was updated.
//
// This member is required.
UpdatedAt *time.Time
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateAgentInsightOutput) Deserialize ¶ added in v1.59.0
func (v *UpdateAgentInsightOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateAgentInsightOutput) Serialize ¶ added in v1.59.0
func (v *UpdateAgentInsightOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAgentInsightOutput) SerializeMembers ¶ added in v1.59.0
func (v *UpdateAgentInsightOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateBrowserStreamInput ¶
type UpdateBrowserStreamInput struct {
// The identifier of the browser.
//
// This member is required.
BrowserIdentifier *string
// The identifier of the browser session.
//
// This member is required.
SessionId *string
// The update to apply to the browser stream.
//
// This member is required.
StreamUpdate types.StreamUpdate
// A unique, case-sensitive identifier to ensure that the operation completes no
// more than one time. If this token matches a previous request, Amazon Bedrock
// ignores the request, but does not return an error.
ClientToken *string
// contains filtered or unexported fields
}
func (*UpdateBrowserStreamInput) Serialize ¶ added in v1.28.3
func (v *UpdateBrowserStreamInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateBrowserStreamInput) SerializeMembers ¶ added in v1.28.3
func (v *UpdateBrowserStreamInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateBrowserStreamOutput ¶
type UpdateBrowserStreamOutput struct {
// The identifier of the browser.
//
// This member is required.
BrowserIdentifier *string
// The identifier of the browser session.
//
// This member is required.
SessionId *string
// The collection of streams associated with a browser session in Amazon Bedrock
// AgentCore. These streams provide different ways to interact with and observe the
// browser session, including programmatic control and visual representation of the
// browser content.
//
// This member is required.
Streams *types.BrowserSessionStream
// The time at which the browser stream was updated.
//
// This member is required.
UpdatedAt *time.Time
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateBrowserStreamOutput) Deserialize ¶ added in v1.28.3
func (v *UpdateBrowserStreamOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateBrowserStreamOutput) Serialize ¶ added in v1.53.0
func (v *UpdateBrowserStreamOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateBrowserStreamOutput) SerializeMembers ¶ added in v1.53.0
func (v *UpdateBrowserStreamOutput) SerializeMembers(s smithy.ShapeSerializer)
Source Files
¶
- api_client.go
- api_op_BatchCreateMemoryRecords.go
- api_op_BatchDeleteMemoryRecords.go
- api_op_BatchUpdateMemoryRecords.go
- api_op_CompleteResourceTokenAuth.go
- api_op_CreateABTest.go
- api_op_CreateEvent.go
- api_op_CreatePaymentInstrument.go
- api_op_CreatePaymentSession.go
- api_op_DeleteABTest.go
- api_op_DeleteBatchEvaluation.go
- api_op_DeleteCapacityProviderSession.go
- api_op_DeleteDatasetGeneration.go
- api_op_DeleteEvent.go
- api_op_DeleteMemoryRecord.go
- api_op_DeletePaymentInstrument.go
- api_op_DeletePaymentSession.go
- api_op_DeleteRecommendation.go
- api_op_Evaluate.go
- api_op_GetABTest.go
- api_op_GetAgentCard.go
- api_op_GetAgentInsight.go
- api_op_GetBatchEvaluation.go
- api_op_GetBrowserSession.go
- api_op_GetCodeInterpreterSession.go
- api_op_GetDatasetGeneration.go
- api_op_GetEvent.go
- api_op_GetMemoryRecord.go
- api_op_GetPaymentInstrument.go
- api_op_GetPaymentInstrumentBalance.go
- api_op_GetPaymentSession.go
- api_op_GetRecommendation.go
- api_op_GetResourceApiKey.go
- api_op_GetResourceOauth2Token.go
- api_op_GetResourcePaymentToken.go
- api_op_GetWorkloadAccessToken.go
- api_op_GetWorkloadAccessTokenForJWT.go
- api_op_GetWorkloadAccessTokenForUserId.go
- api_op_IngestData.go
- api_op_InvokeAgentRuntime.go
- api_op_InvokeAgentRuntimeCommand.go
- api_op_InvokeBrowser.go
- api_op_InvokeCodeInterpreter.go
- api_op_InvokeHarness.go
- api_op_InvokeWebSearch.go
- api_op_ListABTests.go
- api_op_ListActors.go
- api_op_ListAgentInsights.go
- api_op_ListBatchEvaluations.go
- api_op_ListBrowserSessions.go
- api_op_ListCodeInterpreterSessions.go
- api_op_ListDatasetGenerations.go
- api_op_ListEvents.go
- api_op_ListMemoryExtractionJobs.go
- api_op_ListMemoryRecords.go
- api_op_ListPaymentInstruments.go
- api_op_ListPaymentSessions.go
- api_op_ListRecommendations.go
- api_op_ListSessions.go
- api_op_ProcessPayment.go
- api_op_RetrieveMemoryRecords.go
- api_op_SaveBrowserSessionProfile.go
- api_op_SearchRegistryRecords.go
- api_op_StartBatchEvaluation.go
- api_op_StartBrowserSession.go
- api_op_StartCodeInterpreterSession.go
- api_op_StartDatasetGeneration.go
- api_op_StartMemoryExtractionJob.go
- api_op_StartRecommendation.go
- api_op_StopBatchEvaluation.go
- api_op_StopBrowserSession.go
- api_op_StopCodeInterpreterSession.go
- api_op_StopRuntimeSession.go
- api_op_UpdateABTest.go
- api_op_UpdateAgentInsight.go
- api_op_UpdateBrowserStream.go
- auth.go
- common_serde.go
- doc.go
- endpoints.go
- eventstream.go
- go_module_metadata.go
- options.go
- type_registry.go
- validators.go