qapps

package module
v1.3.3 Latest Latest
Warning

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

 Go to latest Published: Oct 28, 2024 License: Apache-2.0 Imports: 44 Imported by: 2

Documentation

Overview

Package qapps provides the API client, operations, and parameter types for QApps.

The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create a Q App that exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information on the capabilities, see Amazon Q Apps capabilitiesin the Amazon Q Business User Guide.

For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API operations.

For information about the IAM access control permissions you need to use the Amazon Q Apps API, see IAM role for the Amazon Q Business web experience including Amazon Q Appsin the Amazon Q Business User Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2023-11-27"
View Source 
const ServiceID = "QApps"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

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

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

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

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

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

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

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

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

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

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

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

Types

type AssociateLibraryItemReviewInput 

type AssociateLibraryItemReviewInput struct {

	// The unique identifier for the Amazon Q Business application environment
	// instance.
	//
	// This member is required.
	InstanceId *string

	// The unique identifier of the library item to associate the review with.
	//
	// This member is required.
	LibraryItemId *string
	// contains filtered or unexported fields
}

type AssociateLibraryItemReviewOutput 

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

type AssociateQAppWithUserInput 

type AssociateQAppWithUserInput struct {

	// The ID of the Amazon Q App to associate with the user.
	//
	// This member is required.
	AppId *string

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type AssociateQAppWithUserOutput 

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

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 Client 

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

Client provides the API client to make operations call for QApps.

func New 

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

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

func NewFromConfig 

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

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateLibraryItemReview 

func (c *Client) AssociateLibraryItemReview(ctx context.Context, params *AssociateLibraryItemReviewInput, optFns ...func(*Options)) (*AssociateLibraryItemReviewOutput, error)

Associates a rating or review for a library item with the user submitting the request. This increments the rating count for the specified library item.

func (*Client) AssociateQAppWithUser 

func (c *Client) AssociateQAppWithUser(ctx context.Context, params *AssociateQAppWithUserInput, optFns ...func(*Options)) (*AssociateQAppWithUserOutput, error)

This operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a favorite for the user if the user doesn't own the Amazon Q App so they can still run it and see it in their inventory of Q Apps.

func (*Client) CreateLibraryItem 

func (c *Client) CreateLibraryItem(ctx context.Context, params *CreateLibraryItemInput, optFns ...func(*Options)) (*CreateLibraryItemOutput, error)

Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.

func (*Client) CreateQApp 

func (c *Client) CreateQApp(ctx context.Context, params *CreateQAppInput, optFns ...func(*Options)) (*CreateQAppOutput, error)

Creates a new Amazon Q App based on the provided definition. The Q App definition specifies the cards and flow of the Q App. This operation also calculates the dependencies between the cards by inspecting the references in the prompts.

func (*Client) DeleteLibraryItem 

func (c *Client) DeleteLibraryItem(ctx context.Context, params *DeleteLibraryItemInput, optFns ...func(*Options)) (*DeleteLibraryItemOutput, error)

Deletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users.

func (*Client) DeleteQApp 

func (c *Client) DeleteQApp(ctx context.Context, params *DeleteQAppInput, optFns ...func(*Options)) (*DeleteQAppOutput, error)

Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.

func (*Client) DisassociateLibraryItemReview 

func (c *Client) DisassociateLibraryItemReview(ctx context.Context, params *DisassociateLibraryItemReviewInput, optFns ...func(*Options)) (*DisassociateLibraryItemReviewOutput, error)

Removes a rating or review previously submitted by the user for a library item.

func (*Client) DisassociateQAppFromUser 

func (c *Client) DisassociateQAppFromUser(ctx context.Context, params *DisassociateQAppFromUserInput, optFns ...func(*Options)) (*DisassociateQAppFromUserOutput, error)

Disassociates a Q App from a user removing the user's access to run the Q App.

func (*Client) GetLibraryItem 

func (c *Client) GetLibraryItem(ctx context.Context, params *GetLibraryItemInput, optFns ...func(*Options)) (*GetLibraryItemOutput, error)

Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

func (*Client) GetQApp 

func (c *Client) GetQApp(ctx context.Context, params *GetQAppInput, optFns ...func(*Options)) (*GetQAppOutput, error)

Retrieves the full details of an Q App, including its definition specifying the cards and flow.

func (*Client) GetQAppSession 

func (c *Client) GetQAppSession(ctx context.Context, params *GetQAppSessionInput, optFns ...func(*Options)) (*GetQAppSessionOutput, error)

Retrieves the current state and results for an active session of an Amazon Q App.

func (*Client) ImportDocument 

func (c *Client) ImportDocument(ctx context.Context, params *ImportDocumentInput, optFns ...func(*Options)) (*ImportDocumentOutput, error)

Uploads a file that can then be used either as a default in a FileUploadCard from Q App definition or as a file that is used inside a single Q App run. The purpose of the document is determined by a scope parameter that indicates whether it is at the app definition level or at the app session level.

func (*Client) ListLibraryItems 

func (c *Client) ListLibraryItems(ctx context.Context, params *ListLibraryItemsInput, optFns ...func(*Options)) (*ListLibraryItemsOutput, error)

Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.

func (*Client) ListQApps 

func (c *Client) ListQApps(ctx context.Context, params *ListQAppsInput, optFns ...func(*Options)) (*ListQAppsOutput, error)

Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation..

func (*Client) ListTagsForResource 

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

Lists the tags associated with an Amazon Q Apps resource.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

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

func (*Client) PredictQApp 

func (c *Client) PredictQApp(ctx context.Context, params *PredictQAppInput, optFns ...func(*Options)) (*PredictQAppOutput, error)

Generates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call CreateQApp . This API doesn't create Amazon Q Apps directly.

func (*Client) StartQAppSession 

func (c *Client) StartQAppSession(ctx context.Context, params *StartQAppSessionInput, optFns ...func(*Options)) (*StartQAppSessionOutput, error)

Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.

Each Q App session will be condensed into a single conversation in the web experience.

func (*Client) StopQAppSession 

func (c *Client) StopQAppSession(ctx context.Context, params *StopQAppSessionInput, optFns ...func(*Options)) (*StopQAppSessionOutput, error)

Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation.

func (*Client) TagResource 

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

Associates tags with an Amazon Q Apps resource.

func (*Client) UntagResource 

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

Disassociates tags from an Amazon Q Apps resource.

func (*Client) UpdateLibraryItem 

func (c *Client) UpdateLibraryItem(ctx context.Context, params *UpdateLibraryItemInput, optFns ...func(*Options)) (*UpdateLibraryItemOutput, error)

Updates the library item for an Amazon Q App.

func (*Client) UpdateLibraryItemMetadata added in v1.1.0 

func (c *Client) UpdateLibraryItemMetadata(ctx context.Context, params *UpdateLibraryItemMetadataInput, optFns ...func(*Options)) (*UpdateLibraryItemMetadataOutput, error)

Updates the verification status of a library item for an Amazon Q App.

func (*Client) UpdateQApp 

func (c *Client) UpdateQApp(ctx context.Context, params *UpdateQAppInput, optFns ...func(*Options)) (*UpdateQAppOutput, error)

Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.

func (*Client) UpdateQAppSession 

func (c *Client) UpdateQAppSession(ctx context.Context, params *UpdateQAppSessionInput, optFns ...func(*Options)) (*UpdateQAppSessionOutput, error)

Updates the session for a given Q App sessionId . This is only valid when at least one card of the session is in the WAITING state. Data for each WAITING card can be provided as input. If inputs are not provided, the call will be accepted but session will not move forward. Inputs for cards that are not in the WAITING status will be ignored.

type CreateLibraryItemInput 

type CreateLibraryItemInput struct {

	// The unique identifier of the Amazon Q App to publish to the library.
	//
	// This member is required.
	AppId *string

	// The version of the Amazon Q App to publish to the library.
	//
	// This member is required.
	AppVersion *int32

	// The categories to associate with the library item for easier discovery.
	//
	// This member is required.
	Categories []string

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type CreateLibraryItemOutput 

type CreateLibraryItemOutput struct {

	// The date and time the library item was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user who created the library item.
	//
	// This member is required.
	CreatedBy *string

	// The unique identifier of the new library item.
	//
	// This member is required.
	LibraryItemId *string

	// The number of ratings the library item has received from users.
	//
	// This member is required.
	RatingCount *int32

	// The status of the new library item, such as "Published".
	//
	// This member is required.
	Status *string

	// Indicates whether the library item has been verified.
	IsVerified *bool

	// The date and time the library item was last updated.
	UpdatedAt *time.Time

	// The user who last updated the library item.
	UpdatedBy *string

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

type CreateQAppInput 

type CreateQAppInput struct {

	// The definition of the new Q App, specifying the cards and flow.
	//
	// This member is required.
	AppDefinition *types.AppDefinitionInput

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// The title of the new Q App.
	//
	// This member is required.
	Title *string

	// The description of the new Q App.
	Description *string

	// Optional tags to associate with the new Q App.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateQAppOutput 

type CreateQAppOutput struct {

	// The Amazon Resource Name (ARN) of the new Q App.
	//
	// This member is required.
	AppArn *string

	// The unique identifier of the new Q App.
	//
	// This member is required.
	AppId *string

	// The version of the new Q App.
	//
	// This member is required.
	AppVersion *int32

	// The date and time the Q App was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user who created the Q App.
	//
	// This member is required.
	CreatedBy *string

	// The status of the new Q App, such as "Created".
	//
	// This member is required.
	Status types.AppStatus

	// The title of the new Q App.
	//
	// This member is required.
	Title *string

	// The date and time the Q App was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The user who last updated the Q App.
	//
	// This member is required.
	UpdatedBy *string

	// The description of the new Q App.
	Description *string

	// The initial prompt displayed when the Q App is started.
	InitialPrompt *string

	// The capabilities required to run the Q App, such as file upload or third-party
	// integrations.
	RequiredCapabilities []types.AppRequiredCapability

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

type DeleteLibraryItemInput 

type DeleteLibraryItemInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// The unique identifier of the library item to delete.
	//
	// This member is required.
	LibraryItemId *string
	// contains filtered or unexported fields
}

type DeleteLibraryItemOutput 

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

type DeleteQAppInput 

type DeleteQAppInput struct {

	// The unique identifier of the Q App to delete.
	//
	// This member is required.
	AppId *string

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DeleteQAppOutput 

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

type DisassociateLibraryItemReviewInput 

type DisassociateLibraryItemReviewInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// The unique identifier of the library item to remove the review from.
	//
	// This member is required.
	LibraryItemId *string
	// contains filtered or unexported fields
}

type DisassociateLibraryItemReviewOutput 

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

type DisassociateQAppFromUserInput 

type DisassociateQAppFromUserInput struct {

	// The unique identifier of the Q App to disassociate from the user.
	//
	// This member is required.
	AppId *string

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type DisassociateQAppFromUserOutput 

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

type EndpointParameters 

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

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

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

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

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

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

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

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

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

type EndpointResolverFunc 

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

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

func (EndpointResolverFunc) ResolveEndpoint 

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

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

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

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetLibraryItemInput 

type GetLibraryItemInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// The unique identifier of the library item to retrieve.
	//
	// This member is required.
	LibraryItemId *string

	// The unique identifier of the Amazon Q App associated with the library item.
	AppId *string
	// contains filtered or unexported fields
}

type GetLibraryItemOutput 

type GetLibraryItemOutput struct {

	// The unique identifier of the Q App associated with the library item.
	//
	// This member is required.
	AppId *string

	// The version of the Q App associated with the library item.
	//
	// This member is required.
	AppVersion *int32

	// The categories associated with the library item for discovery.
	//
	// This member is required.
	Categories []types.Category

	// The date and time the library item was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user who created the library item.
	//
	// This member is required.
	CreatedBy *string

	// The unique identifier of the library item.
	//
	// This member is required.
	LibraryItemId *string

	// The number of ratings the library item has received from users.
	//
	// This member is required.
	RatingCount *int32

	// The status of the library item, such as "Published".
	//
	// This member is required.
	Status *string

	// Whether the current user has rated the library item.
	IsRatedByUser *bool

	// Indicates whether the library item has been verified.
	IsVerified *bool

	// The date and time the library item was last updated.
	UpdatedAt *time.Time

	// The user who last updated the library item.
	UpdatedBy *string

	// The number of users who have associated the Q App with their account.
	UserCount *int32

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

type GetQAppInput 

type GetQAppInput struct {

	// The unique identifier of the Q App to retrieve.
	//
	// This member is required.
	AppId *string

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

type GetQAppOutput 

type GetQAppOutput struct {

	// The Amazon Resource Name (ARN) of the Q App.
	//
	// This member is required.
	AppArn *string

	// The full definition of the Q App, specifying the cards and flow.
	//
	// This member is required.
	AppDefinition *types.AppDefinition

	// The unique identifier of the Q App.
	//
	// This member is required.
	AppId *string

	// The version of the Q App.
	//
	// This member is required.
	AppVersion *int32

	// The date and time the Q App was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user who created the Q App.
	//
	// This member is required.
	CreatedBy *string

	// The status of the Q App.
	//
	// This member is required.
	Status types.AppStatus

	// The title of the Q App.
	//
	// This member is required.
	Title *string

	// The date and time the Q App was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The user who last updated the Q App.
	//
	// This member is required.
	UpdatedBy *string

	// The description of the Q App.
	Description *string

	// The initial prompt displayed when the Q App is started.
	InitialPrompt *string

	// The capabilities required to run the Q App, such as file upload or third-party
	// integrations.
	RequiredCapabilities []types.AppRequiredCapability

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

type GetQAppSessionInput 

type GetQAppSessionInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// The unique identifier of the Q App session to retrieve.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

type GetQAppSessionOutput 

type GetQAppSessionOutput struct {

	// The current status for each card in the Q App session.
	//
	// This member is required.
	CardStatus map[string]types.CardStatus

	// The Amazon Resource Name (ARN) of the Q App session.
	//
	// This member is required.
	SessionArn *string

	// The unique identifier of the Q App session.
	//
	// This member is required.
	SessionId *string

	// The current status of the Q App session.
	//
	// This member is required.
	Status types.ExecutionStatus

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

type HTTPClient 

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

type HTTPSignerV4 

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

type ImportDocumentInput 

type ImportDocumentInput struct {

	// The unique identifier of the Q App the file is associated with.
	//
	// This member is required.
	AppId *string

	// The unique identifier of the card the file is associated with, if applicable.
	//
	// This member is required.
	CardId *string

	// The base64-encoded contents of the file to upload.
	//
	// This member is required.
	FileContentsBase64 *string

	// The name of the file being uploaded.
	//
	// This member is required.
	FileName *string

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// Whether the file is associated with an Q App definition or a specific Q App
	// session.
	//
	// This member is required.
	Scope types.DocumentScope

	// The unique identifier of the Q App session the file is associated with, if
	// applicable.
	SessionId *string
	// contains filtered or unexported fields
}

type ImportDocumentOutput 

type ImportDocumentOutput struct {

	// The unique identifier assigned to the uploaded file.
	FileId *string

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

type ListLibraryItemsAPIClient 

type ListLibraryItemsAPIClient interface {
	ListLibraryItems(context.Context, *ListLibraryItemsInput, ...func(*Options)) (*ListLibraryItemsOutput, error)
}

ListLibraryItemsAPIClient is a client that implements the ListLibraryItems operation.

type ListLibraryItemsInput 

type ListLibraryItemsInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// Optional category to filter the library items by.
	CategoryId *string

	// The maximum number of library items to return in the response.
	Limit *int32

	// The token to request the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLibraryItemsOutput 

type ListLibraryItemsOutput struct {

	// The list of library items meeting the request criteria.
	LibraryItems []types.LibraryItemMember

	// The token to use to request the next page of results.
	NextToken *string

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

type ListLibraryItemsPaginator 

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

ListLibraryItemsPaginator is a paginator for ListLibraryItems

func NewListLibraryItemsPaginator 

func NewListLibraryItemsPaginator(client ListLibraryItemsAPIClient, params *ListLibraryItemsInput, optFns ...func(*ListLibraryItemsPaginatorOptions)) *ListLibraryItemsPaginator

NewListLibraryItemsPaginator returns a new ListLibraryItemsPaginator

func (*ListLibraryItemsPaginator) HasMorePages 

func (p *ListLibraryItemsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLibraryItemsPaginator) NextPage 

func (p *ListLibraryItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLibraryItemsOutput, error)

NextPage retrieves the next ListLibraryItems page.

type ListLibraryItemsPaginatorOptions 

type ListLibraryItemsPaginatorOptions struct {
	// The maximum number of library items to return in the response.
	Limit int32

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

ListLibraryItemsPaginatorOptions is the paginator options for ListLibraryItems

type ListQAppsAPIClient 

type ListQAppsAPIClient interface {
	ListQApps(context.Context, *ListQAppsInput, ...func(*Options)) (*ListQAppsOutput, error)
}

ListQAppsAPIClient is a client that implements the ListQApps operation.

type ListQAppsInput 

type ListQAppsInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// The maximum number of Q Apps to return in the response.
	Limit *int32

	// The token to request the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListQAppsOutput 

type ListQAppsOutput struct {

	// The list of Amazon Q Apps meeting the request criteria.
	//
	// This member is required.
	Apps []types.UserAppItem

	// The token to use to request the next page of results.
	NextToken *string

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

type ListQAppsPaginator 

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

ListQAppsPaginator is a paginator for ListQApps

func NewListQAppsPaginator 

func NewListQAppsPaginator(client ListQAppsAPIClient, params *ListQAppsInput, optFns ...func(*ListQAppsPaginatorOptions)) *ListQAppsPaginator

NewListQAppsPaginator returns a new ListQAppsPaginator

func (*ListQAppsPaginator) HasMorePages 

func (p *ListQAppsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQAppsPaginator) NextPage 

func (p *ListQAppsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQAppsOutput, error)

NextPage retrieves the next ListQApps page.

type ListQAppsPaginatorOptions 

type ListQAppsPaginatorOptions struct {
	// The maximum number of Q Apps to return in the response.
	Limit int32

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

ListQAppsPaginatorOptions is the paginator options for ListQApps

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of tags that are assigned to the resource.
	Tags map[string]string

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

type Options 

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

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

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

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

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

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

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

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

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

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

	// The client meter provider.
	MeterProvider metrics.MeterProvider

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

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

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

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

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

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

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

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

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

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver 

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

type PredictQAppInput 

type PredictQAppInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// The input to generate the Q App definition from, either a conversation or
	// problem statement.
	Options types.PredictQAppInputOptions
	// contains filtered or unexported fields
}

type PredictQAppOutput 

type PredictQAppOutput struct {

	// The generated Q App definition.
	//
	// This member is required.
	App *types.PredictAppDefinition

	// The problem statement extracted from the input conversation, if provided.
	//
	// This member is required.
	ProblemStatement *string

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

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

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartQAppSessionInput 

type StartQAppSessionInput struct {

	// The unique identifier of the Q App to start a session for.
	//
	// This member is required.
	AppId *string

	// The version of the Q App to use for the session.
	//
	// This member is required.
	AppVersion *int32

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// Optional initial input values to provide for the Q App session.
	InitialValues []types.CardValue

	// Optional tags to associate with the new Q App session.
	Tags map[string]string
	// contains filtered or unexported fields
}

type StartQAppSessionOutput 

type StartQAppSessionOutput struct {

	// The Amazon Resource Name (ARN) of the new Q App session.
	//
	// This member is required.
	SessionArn *string

	// The unique identifier of the new Q App session.
	//
	// This member is required.
	SessionId *string

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

type StopQAppSessionInput 

type StopQAppSessionInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// The unique identifier of the Q App session to stop.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

type StopQAppSessionOutput 

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

type TagResourceInput 

type TagResourceInput struct {

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

	// The tags to associate with the resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

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

type UntagResourceInput 

type UntagResourceInput struct {

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

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

type UntagResourceOutput 

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

type UpdateLibraryItemInput 

type UpdateLibraryItemInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// The unique identifier of the library item to update.
	//
	// This member is required.
	LibraryItemId *string

	// The new categories to associate with the library item.
	Categories []string

	// The new status to set for the library item, such as "Published" or "Hidden".
	Status types.LibraryItemStatus
	// contains filtered or unexported fields
}

type UpdateLibraryItemMetadataInput added in v1.1.0 

type UpdateLibraryItemMetadataInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// The unique identifier of the updated library item.
	//
	// This member is required.
	LibraryItemId *string

	// The verification status of the library item
	IsVerified *bool
	// contains filtered or unexported fields
}

type UpdateLibraryItemMetadataOutput added in v1.1.0 

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

type UpdateLibraryItemOutput 

type UpdateLibraryItemOutput struct {

	// The unique identifier of the Q App associated with the library item.
	//
	// This member is required.
	AppId *string

	// The version of the Q App associated with the library item.
	//
	// This member is required.
	AppVersion *int32

	// The categories associated with the updated library item.
	//
	// This member is required.
	Categories []types.Category

	// The date and time the library item was originally created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user who originally created the library item.
	//
	// This member is required.
	CreatedBy *string

	// The unique identifier of the updated library item.
	//
	// This member is required.
	LibraryItemId *string

	// The number of ratings the library item has received.
	//
	// This member is required.
	RatingCount *int32

	// The new status of the updated library item.
	//
	// This member is required.
	Status *string

	// Whether the current user has rated the library item.
	IsRatedByUser *bool

	// Indicates whether the library item has been verified.
	IsVerified *bool

	// The date and time the library item was last updated.
	UpdatedAt *time.Time

	// The user who last updated the library item.
	UpdatedBy *string

	// The number of users who have the associated Q App.
	UserCount *int32

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

type UpdateQAppInput 

type UpdateQAppInput struct {

	// The unique identifier of the Q App to update.
	//
	// This member is required.
	AppId *string

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// The new definition specifying the cards and flow for the Q App.
	AppDefinition *types.AppDefinitionInput

	// The new description for the Q App.
	Description *string

	// The new title for the Q App.
	Title *string
	// contains filtered or unexported fields
}

type UpdateQAppOutput 

type UpdateQAppOutput struct {

	// The Amazon Resource Name (ARN) of the updated Q App.
	//
	// This member is required.
	AppArn *string

	// The unique identifier of the updated Q App.
	//
	// This member is required.
	AppId *string

	// The new version of the updated Q App.
	//
	// This member is required.
	AppVersion *int32

	// The date and time the Q App was originally created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user who originally created the Q App.
	//
	// This member is required.
	CreatedBy *string

	// The status of the updated Q App.
	//
	// This member is required.
	Status types.AppStatus

	// The new title of the updated Q App.
	//
	// This member is required.
	Title *string

	// The date and time the Q App was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The user who last updated the Q App.
	//
	// This member is required.
	UpdatedBy *string

	// The new description of the updated Q App.
	Description *string

	// The initial prompt for the updated Q App.
	InitialPrompt *string

	// The capabilities required for the updated Q App.
	RequiredCapabilities []types.AppRequiredCapability

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

type UpdateQAppSessionInput 

type UpdateQAppSessionInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// This member is required.
	InstanceId *string

	// The unique identifier of the Q App session to provide input for.
	//
	// This member is required.
	SessionId *string

	// The input values to provide for the current state of the Q App session.
	Values []types.CardValue
	// contains filtered or unexported fields
}

type UpdateQAppSessionOutput 

type UpdateQAppSessionOutput struct {

	// The Amazon Resource Name (ARN) of the updated Q App session.
	//
	// This member is required.
	SessionArn *string

	// The unique identifier of the updated Q App session.
	//
	// This member is required.
	SessionId *string

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

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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