Documentation
¶
Overview ¶
Package devopsagent provides the API client, operations, and parameter types for AWS DevOps Agent Service.
AWS DevOps Agent is your always-available operations teammate. It resolves and proactively prevents incidents, optimizes application reliability and performance, and handles on-demand SRE tasks across AWS, multicloud, and on-premises environments. AWS DevOps Agent investigates incidents as an experienced DevOps engineer would. It learns your applications and their relationships. It works with your observability tools, runbooks, code repositories, and CI/CD pipelines. The agent correlates telemetry, code, and deployment data across all of them.
Index ¶
- Constants
- 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 AssociateServiceInput
- type AssociateServiceOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) AssociateService(ctx context.Context, params *AssociateServiceInput, optFns ...func(*Options)) (*AssociateServiceOutput, error)
- func (c *Client) CreateAgentSpace(ctx context.Context, params *CreateAgentSpaceInput, optFns ...func(*Options)) (*CreateAgentSpaceOutput, error)
- func (c *Client) CreateAsset(ctx context.Context, params *CreateAssetInput, optFns ...func(*Options)) (*CreateAssetOutput, error)
- func (c *Client) CreateAssetFile(ctx context.Context, params *CreateAssetFileInput, optFns ...func(*Options)) (*CreateAssetFileOutput, error)
- func (c *Client) CreateBacklogTask(ctx context.Context, params *CreateBacklogTaskInput, optFns ...func(*Options)) (*CreateBacklogTaskOutput, error)
- func (c *Client) CreateChat(ctx context.Context, params *CreateChatInput, optFns ...func(*Options)) (*CreateChatOutput, error)
- func (c *Client) CreatePrivateConnection(ctx context.Context, params *CreatePrivateConnectionInput, ...) (*CreatePrivateConnectionOutput, error)
- func (c *Client) CreateTrigger(ctx context.Context, params *CreateTriggerInput, optFns ...func(*Options)) (*CreateTriggerOutput, error)
- func (c *Client) DeleteAgentSpace(ctx context.Context, params *DeleteAgentSpaceInput, optFns ...func(*Options)) (*DeleteAgentSpaceOutput, error)
- func (c *Client) DeleteAsset(ctx context.Context, params *DeleteAssetInput, optFns ...func(*Options)) (*DeleteAssetOutput, error)
- func (c *Client) DeleteAssetFile(ctx context.Context, params *DeleteAssetFileInput, optFns ...func(*Options)) (*DeleteAssetFileOutput, error)
- func (c *Client) DeletePrivateConnection(ctx context.Context, params *DeletePrivateConnectionInput, ...) (*DeletePrivateConnectionOutput, error)
- func (c *Client) DeleteTrigger(ctx context.Context, params *DeleteTriggerInput, optFns ...func(*Options)) (*DeleteTriggerOutput, error)
- func (c *Client) DeregisterService(ctx context.Context, params *DeregisterServiceInput, optFns ...func(*Options)) (*DeregisterServiceOutput, error)
- func (c *Client) DescribePrivateConnection(ctx context.Context, params *DescribePrivateConnectionInput, ...) (*DescribePrivateConnectionOutput, error)
- func (c *Client) DisableOperatorApp(ctx context.Context, params *DisableOperatorAppInput, optFns ...func(*Options)) (*DisableOperatorAppOutput, error)
- func (c *Client) DisassociateService(ctx context.Context, params *DisassociateServiceInput, ...) (*DisassociateServiceOutput, error)
- func (c *Client) EnableOperatorApp(ctx context.Context, params *EnableOperatorAppInput, optFns ...func(*Options)) (*EnableOperatorAppOutput, error)
- func (c *Client) GetAccountUsage(ctx context.Context, params *GetAccountUsageInput, optFns ...func(*Options)) (*GetAccountUsageOutput, error)
- func (c *Client) GetAgentSpace(ctx context.Context, params *GetAgentSpaceInput, optFns ...func(*Options)) (*GetAgentSpaceOutput, error)
- func (c *Client) GetAsset(ctx context.Context, params *GetAssetInput, optFns ...func(*Options)) (*GetAssetOutput, error)
- func (c *Client) GetAssetContent(ctx context.Context, params *GetAssetContentInput, optFns ...func(*Options)) (*GetAssetContentOutput, error)
- func (c *Client) GetAssetFile(ctx context.Context, params *GetAssetFileInput, optFns ...func(*Options)) (*GetAssetFileOutput, error)
- func (c *Client) GetAssociation(ctx context.Context, params *GetAssociationInput, optFns ...func(*Options)) (*GetAssociationOutput, error)
- func (c *Client) GetBacklogTask(ctx context.Context, params *GetBacklogTaskInput, optFns ...func(*Options)) (*GetBacklogTaskOutput, error)
- func (c *Client) GetOperatorApp(ctx context.Context, params *GetOperatorAppInput, optFns ...func(*Options)) (*GetOperatorAppOutput, error)
- func (c *Client) GetRecommendation(ctx context.Context, params *GetRecommendationInput, optFns ...func(*Options)) (*GetRecommendationOutput, error)
- func (c *Client) GetService(ctx context.Context, params *GetServiceInput, optFns ...func(*Options)) (*GetServiceOutput, error)
- func (c *Client) GetTrigger(ctx context.Context, params *GetTriggerInput, optFns ...func(*Options)) (*GetTriggerOutput, error)
- func (c *Client) ListAgentSpaces(ctx context.Context, params *ListAgentSpacesInput, optFns ...func(*Options)) (*ListAgentSpacesOutput, error)
- func (c *Client) ListAssetFiles(ctx context.Context, params *ListAssetFilesInput, optFns ...func(*Options)) (*ListAssetFilesOutput, error)
- func (c *Client) ListAssetTypes(ctx context.Context, params *ListAssetTypesInput, optFns ...func(*Options)) (*ListAssetTypesOutput, error)
- func (c *Client) ListAssetVersions(ctx context.Context, params *ListAssetVersionsInput, optFns ...func(*Options)) (*ListAssetVersionsOutput, error)
- func (c *Client) ListAssets(ctx context.Context, params *ListAssetsInput, optFns ...func(*Options)) (*ListAssetsOutput, error)
- func (c *Client) ListAssociations(ctx context.Context, params *ListAssociationsInput, optFns ...func(*Options)) (*ListAssociationsOutput, error)
- func (c *Client) ListBacklogTasks(ctx context.Context, params *ListBacklogTasksInput, optFns ...func(*Options)) (*ListBacklogTasksOutput, error)
- func (c *Client) ListChats(ctx context.Context, params *ListChatsInput, optFns ...func(*Options)) (*ListChatsOutput, error)
- func (c *Client) ListExecutions(ctx context.Context, params *ListExecutionsInput, optFns ...func(*Options)) (*ListExecutionsOutput, error)
- func (c *Client) ListGoals(ctx context.Context, params *ListGoalsInput, optFns ...func(*Options)) (*ListGoalsOutput, error)
- func (c *Client) ListJournalRecords(ctx context.Context, params *ListJournalRecordsInput, optFns ...func(*Options)) (*ListJournalRecordsOutput, error)
- func (c *Client) ListPendingMessages(ctx context.Context, params *ListPendingMessagesInput, ...) (*ListPendingMessagesOutput, error)
- func (c *Client) ListPrivateConnections(ctx context.Context, params *ListPrivateConnectionsInput, ...) (*ListPrivateConnectionsOutput, error)
- func (c *Client) ListRecommendations(ctx context.Context, params *ListRecommendationsInput, ...) (*ListRecommendationsOutput, error)
- func (c *Client) ListServices(ctx context.Context, params *ListServicesInput, optFns ...func(*Options)) (*ListServicesOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) ListTriggers(ctx context.Context, params *ListTriggersInput, optFns ...func(*Options)) (*ListTriggersOutput, error)
- func (c *Client) ListWebhooks(ctx context.Context, params *ListWebhooksInput, optFns ...func(*Options)) (*ListWebhooksOutput, error)
- func (c *Client) Options() Options
- func (c *Client) RegisterService(ctx context.Context, params *RegisterServiceInput, optFns ...func(*Options)) (*RegisterServiceOutput, error)
- func (c *Client) SendMessage(ctx context.Context, params *SendMessageInput, optFns ...func(*Options)) (*SendMessageOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateAgentSpace(ctx context.Context, params *UpdateAgentSpaceInput, optFns ...func(*Options)) (*UpdateAgentSpaceOutput, error)
- func (c *Client) UpdateAsset(ctx context.Context, params *UpdateAssetInput, optFns ...func(*Options)) (*UpdateAssetOutput, error)
- func (c *Client) UpdateAssetFile(ctx context.Context, params *UpdateAssetFileInput, optFns ...func(*Options)) (*UpdateAssetFileOutput, error)
- func (c *Client) UpdateAssociation(ctx context.Context, params *UpdateAssociationInput, optFns ...func(*Options)) (*UpdateAssociationOutput, error)
- func (c *Client) UpdateBacklogTask(ctx context.Context, params *UpdateBacklogTaskInput, optFns ...func(*Options)) (*UpdateBacklogTaskOutput, error)
- func (c *Client) UpdateGoal(ctx context.Context, params *UpdateGoalInput, optFns ...func(*Options)) (*UpdateGoalOutput, error)
- func (c *Client) UpdateOperatorAppIdpConfig(ctx context.Context, params *UpdateOperatorAppIdpConfigInput, ...) (*UpdateOperatorAppIdpConfigOutput, error)
- func (c *Client) UpdatePrivateConnectionCertificate(ctx context.Context, params *UpdatePrivateConnectionCertificateInput, ...) (*UpdatePrivateConnectionCertificateOutput, error)
- func (c *Client) UpdateRecommendation(ctx context.Context, params *UpdateRecommendationInput, ...) (*UpdateRecommendationOutput, error)
- func (c *Client) UpdateTrigger(ctx context.Context, params *UpdateTriggerInput, optFns ...func(*Options)) (*UpdateTriggerOutput, error)
- func (c *Client) ValidateAwsAssociations(ctx context.Context, params *ValidateAwsAssociationsInput, ...) (*ValidateAwsAssociationsOutput, error)
- type CreateAgentSpaceInput
- type CreateAgentSpaceOutput
- type CreateAssetFileInput
- type CreateAssetFileOutput
- type CreateAssetInput
- type CreateAssetOutput
- type CreateBacklogTaskInput
- type CreateBacklogTaskOutput
- type CreateChatInput
- type CreateChatOutput
- type CreatePrivateConnectionInput
- type CreatePrivateConnectionOutput
- type CreateTriggerInput
- type CreateTriggerOutput
- type DeleteAgentSpaceInput
- type DeleteAgentSpaceOutput
- type DeleteAssetFileInput
- type DeleteAssetFileOutput
- type DeleteAssetInput
- type DeleteAssetOutput
- type DeletePrivateConnectionInput
- type DeletePrivateConnectionOutput
- type DeleteTriggerInput
- type DeleteTriggerOutput
- type DeregisterServiceInput
- type DeregisterServiceOutput
- type DescribePrivateConnectionInput
- type DescribePrivateConnectionOutput
- type DisableOperatorAppInput
- type DisableOperatorAppOutput
- type DisassociateServiceInput
- type DisassociateServiceOutput
- type EnableOperatorAppInput
- type EnableOperatorAppOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetAccountUsageInput
- type GetAccountUsageOutput
- type GetAgentSpaceInput
- type GetAgentSpaceOutput
- type GetAssetContentInput
- type GetAssetContentOutput
- type GetAssetFileInput
- type GetAssetFileOutput
- type GetAssetInput
- type GetAssetOutput
- type GetAssociationInput
- type GetAssociationOutput
- type GetBacklogTaskInput
- type GetBacklogTaskOutput
- type GetOperatorAppInput
- type GetOperatorAppOutput
- type GetRecommendationInput
- type GetRecommendationOutput
- type GetServiceInput
- type GetServiceOutput
- type GetTriggerInput
- type GetTriggerOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListAgentSpacesAPIClient
- type ListAgentSpacesInput
- type ListAgentSpacesOutput
- type ListAgentSpacesPaginator
- type ListAgentSpacesPaginatorOptions
- type ListAssetFilesAPIClient
- type ListAssetFilesInput
- type ListAssetFilesOutput
- type ListAssetFilesPaginator
- type ListAssetFilesPaginatorOptions
- type ListAssetTypesAPIClient
- type ListAssetTypesInput
- type ListAssetTypesOutput
- type ListAssetTypesPaginator
- type ListAssetTypesPaginatorOptions
- type ListAssetVersionsAPIClient
- type ListAssetVersionsInput
- type ListAssetVersionsOutput
- type ListAssetVersionsPaginator
- type ListAssetVersionsPaginatorOptions
- type ListAssetsAPIClient
- type ListAssetsInput
- type ListAssetsOutput
- type ListAssetsPaginator
- type ListAssetsPaginatorOptions
- type ListAssociationsAPIClient
- type ListAssociationsInput
- type ListAssociationsOutput
- type ListAssociationsPaginator
- type ListAssociationsPaginatorOptions
- type ListBacklogTasksAPIClient
- type ListBacklogTasksInput
- type ListBacklogTasksOutput
- type ListBacklogTasksPaginator
- type ListBacklogTasksPaginatorOptions
- type ListChatsInput
- type ListChatsOutput
- type ListExecutionsAPIClient
- type ListExecutionsInput
- type ListExecutionsOutput
- type ListExecutionsPaginator
- type ListExecutionsPaginatorOptions
- type ListGoalsAPIClient
- type ListGoalsInput
- type ListGoalsOutput
- type ListGoalsPaginator
- type ListGoalsPaginatorOptions
- type ListJournalRecordsAPIClient
- type ListJournalRecordsInput
- type ListJournalRecordsOutput
- type ListJournalRecordsPaginator
- type ListJournalRecordsPaginatorOptions
- type ListPendingMessagesInput
- type ListPendingMessagesOutput
- type ListPrivateConnectionsInput
- type ListPrivateConnectionsOutput
- type ListRecommendationsInput
- type ListRecommendationsOutput
- type ListServicesAPIClient
- type ListServicesInput
- type ListServicesOutput
- type ListServicesPaginator
- type ListServicesPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTriggersAPIClient
- type ListTriggersInput
- type ListTriggersOutput
- type ListTriggersPaginator
- type ListTriggersPaginatorOptions
- type ListWebhooksInput
- type ListWebhooksOutput
- type Options
- type PartialResult
- type RegisterServiceInput
- type RegisterServiceOutput
- type ResolveEndpoint
- type SendMessageEventStream
- type SendMessageEventsReader
- type SendMessageInitialReply
- type SendMessageInput
- type SendMessageOutput
- type TagResourceInput
- type TagResourceOutput
- type UnknownEventMessageError
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateAgentSpaceInput
- type UpdateAgentSpaceOutput
- type UpdateAssetFileInput
- type UpdateAssetFileOutput
- type UpdateAssetInput
- type UpdateAssetOutput
- type UpdateAssociationInput
- type UpdateAssociationOutput
- type UpdateBacklogTaskInput
- type UpdateBacklogTaskOutput
- type UpdateGoalInput
- type UpdateGoalOutput
- type UpdateOperatorAppIdpConfigInput
- type UpdateOperatorAppIdpConfigOutput
- type UpdatePrivateConnectionCertificateInput
- type UpdatePrivateConnectionCertificateOutput
- type UpdateRecommendationInput
- type UpdateRecommendationOutput
- type UpdateTriggerInput
- type UpdateTriggerOutput
- type ValidateAwsAssociationsInput
- type ValidateAwsAssociationsOutput
Constants ¶
const ServiceAPIVersion = "2026-01-01"
const ServiceID = "DevOps Agent"
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 ¶
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 AssociateServiceInput ¶
type AssociateServiceInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// The configuration that directs how AgentSpace interacts with the given service.
//
// This member is required.
Configuration types.ServiceConfiguration
// The unique identifier of the service.
//
// This member is required.
ServiceId *string
// Enabled capabilities for this association.
Capabilities map[string]types.CapabilityConfiguration
// contains filtered or unexported fields
}
Input for creating a new service association within an AgentSpace.
type AssociateServiceOutput ¶
type AssociateServiceOutput struct {
// Represents a service association within an AgentSpace, defining how the agent
// interacts with external services.
//
// This member is required.
Association *types.Association
// Generic webhook configuration
Webhook *types.GenericWebhook
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the newly created association and optional webhook configuration.
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 AWS DevOps Agent Service.
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) AssociateService ¶
func (c *Client) AssociateService(ctx context.Context, params *AssociateServiceInput, optFns ...func(*Options)) (*AssociateServiceOutput, error)
Adds a specific service association to an AgentSpace. It overwrites the existing association of the same service. Returns 201 Created on success.
func (*Client) CreateAgentSpace ¶
func (c *Client) CreateAgentSpace(ctx context.Context, params *CreateAgentSpaceInput, optFns ...func(*Options)) (*CreateAgentSpaceOutput, error)
Creates a new AgentSpace with the specified name and description. Duplicate space names are allowed.
func (*Client) CreateAsset ¶ added in v1.6.0
func (c *Client) CreateAsset(ctx context.Context, params *CreateAssetInput, optFns ...func(*Options)) (*CreateAssetOutput, error)
Creates a new asset in the specified agent space
func (*Client) CreateAssetFile ¶ added in v1.6.0
func (c *Client) CreateAssetFile(ctx context.Context, params *CreateAssetFileInput, optFns ...func(*Options)) (*CreateAssetFileOutput, error)
Creates a file in an asset
func (*Client) CreateBacklogTask ¶
func (c *Client) CreateBacklogTask(ctx context.Context, params *CreateBacklogTaskInput, optFns ...func(*Options)) (*CreateBacklogTaskOutput, error)
Creates a new backlog task in the specified agent space
func (*Client) CreateChat ¶
func (c *Client) CreateChat(ctx context.Context, params *CreateChatInput, optFns ...func(*Options)) (*CreateChatOutput, error)
Creates a new chat execution in the specified agent space
func (*Client) CreatePrivateConnection ¶
func (c *Client) CreatePrivateConnection(ctx context.Context, params *CreatePrivateConnectionInput, optFns ...func(*Options)) (*CreatePrivateConnectionOutput, error)
Creates a Private Connection to a target resource.
func (*Client) CreateTrigger ¶ added in v1.7.0
func (c *Client) CreateTrigger(ctx context.Context, params *CreateTriggerInput, optFns ...func(*Options)) (*CreateTriggerOutput, error)
Creates a new Trigger in the specified agent space
func (*Client) DeleteAgentSpace ¶
func (c *Client) DeleteAgentSpace(ctx context.Context, params *DeleteAgentSpaceInput, optFns ...func(*Options)) (*DeleteAgentSpaceOutput, error)
Deletes an AgentSpace. This operation is idempotent and returns a 204 No Content response on success.
func (*Client) DeleteAsset ¶ added in v1.6.0
func (c *Client) DeleteAsset(ctx context.Context, params *DeleteAssetInput, optFns ...func(*Options)) (*DeleteAssetOutput, error)
Deletes an asset and all its files from the specified agent space
func (*Client) DeleteAssetFile ¶ added in v1.6.0
func (c *Client) DeleteAssetFile(ctx context.Context, params *DeleteAssetFileInput, optFns ...func(*Options)) (*DeleteAssetFileOutput, error)
Deletes a file from an asset
func (*Client) DeletePrivateConnection ¶
func (c *Client) DeletePrivateConnection(ctx context.Context, params *DeletePrivateConnectionInput, optFns ...func(*Options)) (*DeletePrivateConnectionOutput, error)
Deletes a Private Connection. The deletion is asynchronous and returns DELETE_IN_PROGRESS status.
func (*Client) DeleteTrigger ¶ added in v1.7.0
func (c *Client) DeleteTrigger(ctx context.Context, params *DeleteTriggerInput, optFns ...func(*Options)) (*DeleteTriggerOutput, error)
Deletes a Trigger from the specified agent space
func (*Client) DeregisterService ¶
func (c *Client) DeregisterService(ctx context.Context, params *DeregisterServiceInput, optFns ...func(*Options)) (*DeregisterServiceOutput, error)
Deregister a service
func (*Client) DescribePrivateConnection ¶
func (c *Client) DescribePrivateConnection(ctx context.Context, params *DescribePrivateConnectionInput, optFns ...func(*Options)) (*DescribePrivateConnectionOutput, error)
Retrieves details of an existing Private Connection.
func (*Client) DisableOperatorApp ¶
func (c *Client) DisableOperatorApp(ctx context.Context, params *DisableOperatorAppInput, optFns ...func(*Options)) (*DisableOperatorAppOutput, error)
Disable the Operator App for the specified AgentSpace
func (*Client) DisassociateService ¶
func (c *Client) DisassociateService(ctx context.Context, params *DisassociateServiceInput, optFns ...func(*Options)) (*DisassociateServiceOutput, error)
Deletes a specific service association from an AgentSpace. This operation is idempotent and returns a 204 No Content response on success.
func (*Client) EnableOperatorApp ¶
func (c *Client) EnableOperatorApp(ctx context.Context, params *EnableOperatorAppInput, optFns ...func(*Options)) (*EnableOperatorAppOutput, error)
Enable the Operator App to access the given AgentSpace
func (*Client) GetAccountUsage ¶
func (c *Client) GetAccountUsage(ctx context.Context, params *GetAccountUsageInput, optFns ...func(*Options)) (*GetAccountUsageOutput, error)
Retrieves monthly account usage metrics and limits for the AWS account.
func (*Client) GetAgentSpace ¶
func (c *Client) GetAgentSpace(ctx context.Context, params *GetAgentSpaceInput, optFns ...func(*Options)) (*GetAgentSpaceOutput, error)
Retrieves detailed information about a specific AgentSpace.
func (*Client) GetAsset ¶ added in v1.6.0
func (c *Client) GetAsset(ctx context.Context, params *GetAssetInput, optFns ...func(*Options)) (*GetAssetOutput, error)
Gets an asset from the specified agent space
func (*Client) GetAssetContent ¶ added in v1.6.0
func (c *Client) GetAssetContent(ctx context.Context, params *GetAssetContentInput, optFns ...func(*Options)) (*GetAssetContentOutput, error)
Gets an asset's content as a zip bundle
func (*Client) GetAssetFile ¶ added in v1.6.0
func (c *Client) GetAssetFile(ctx context.Context, params *GetAssetFileInput, optFns ...func(*Options)) (*GetAssetFileOutput, error)
Gets a file from an asset
func (*Client) GetAssociation ¶
func (c *Client) GetAssociation(ctx context.Context, params *GetAssociationInput, optFns ...func(*Options)) (*GetAssociationOutput, error)
Retrieves given associations configured for a specific AgentSpace.
func (*Client) GetBacklogTask ¶
func (c *Client) GetBacklogTask(ctx context.Context, params *GetBacklogTaskInput, optFns ...func(*Options)) (*GetBacklogTaskOutput, error)
Gets a backlog task for the specified agent space and task id
func (*Client) GetOperatorApp ¶
func (c *Client) GetOperatorApp(ctx context.Context, params *GetOperatorAppInput, optFns ...func(*Options)) (*GetOperatorAppOutput, error)
Get the full auth configuration of operator including any enabled auth flow
func (*Client) GetRecommendation ¶
func (c *Client) GetRecommendation(ctx context.Context, params *GetRecommendationInput, optFns ...func(*Options)) (*GetRecommendationOutput, error)
Retrieves a specific recommendation by its ID
func (*Client) GetService ¶
func (c *Client) GetService(ctx context.Context, params *GetServiceInput, optFns ...func(*Options)) (*GetServiceOutput, error)
Retrieves given service by it's unique identifier
func (*Client) GetTrigger ¶ added in v1.7.0
func (c *Client) GetTrigger(ctx context.Context, params *GetTriggerInput, optFns ...func(*Options)) (*GetTriggerOutput, error)
Gets a Trigger from the specified agent space
func (*Client) ListAgentSpaces ¶
func (c *Client) ListAgentSpaces(ctx context.Context, params *ListAgentSpacesInput, optFns ...func(*Options)) (*ListAgentSpacesOutput, error)
Lists all AgentSpaces with optional pagination.
func (*Client) ListAssetFiles ¶ added in v1.6.0
func (c *Client) ListAssetFiles(ctx context.Context, params *ListAssetFilesInput, optFns ...func(*Options)) (*ListAssetFilesOutput, error)
Lists files in an asset
func (*Client) ListAssetTypes ¶ added in v1.6.0
func (c *Client) ListAssetTypes(ctx context.Context, params *ListAssetTypesInput, optFns ...func(*Options)) (*ListAssetTypesOutput, error)
Lists the supported asset types
func (*Client) ListAssetVersions ¶ added in v1.6.0
func (c *Client) ListAssetVersions(ctx context.Context, params *ListAssetVersionsInput, optFns ...func(*Options)) (*ListAssetVersionsOutput, error)
Lists versions of an asset in the specified agent space
func (*Client) ListAssets ¶ added in v1.6.0
func (c *Client) ListAssets(ctx context.Context, params *ListAssetsInput, optFns ...func(*Options)) (*ListAssetsOutput, error)
Lists assets in the specified agent space
func (*Client) ListAssociations ¶
func (c *Client) ListAssociations(ctx context.Context, params *ListAssociationsInput, optFns ...func(*Options)) (*ListAssociationsOutput, error)
List all associations for given AgentSpace
func (*Client) ListBacklogTasks ¶
func (c *Client) ListBacklogTasks(ctx context.Context, params *ListBacklogTasksInput, optFns ...func(*Options)) (*ListBacklogTasksOutput, error)
Lists backlog tasks in the specified agent space with optional filtering and sorting
func (*Client) ListChats ¶
func (c *Client) ListChats(ctx context.Context, params *ListChatsInput, optFns ...func(*Options)) (*ListChatsOutput, error)
Retrieves a paginated list of the user's recent chat executions
func (*Client) ListExecutions ¶
func (c *Client) ListExecutions(ctx context.Context, params *ListExecutionsInput, optFns ...func(*Options)) (*ListExecutionsOutput, error)
List executions
func (*Client) ListGoals ¶
func (c *Client) ListGoals(ctx context.Context, params *ListGoalsInput, optFns ...func(*Options)) (*ListGoalsOutput, error)
Lists goals in the specified agent space with optional filtering
func (*Client) ListJournalRecords ¶
func (c *Client) ListJournalRecords(ctx context.Context, params *ListJournalRecordsInput, optFns ...func(*Options)) (*ListJournalRecordsOutput, error)
List journal records for a specific execution
func (*Client) ListPendingMessages ¶
func (c *Client) ListPendingMessages(ctx context.Context, params *ListPendingMessagesInput, optFns ...func(*Options)) (*ListPendingMessagesOutput, error)
List pending messages for a specific execution.
func (*Client) ListPrivateConnections ¶
func (c *Client) ListPrivateConnections(ctx context.Context, params *ListPrivateConnectionsInput, optFns ...func(*Options)) (*ListPrivateConnectionsOutput, error)
Lists all Private Connections in the caller's account.
func (*Client) ListRecommendations ¶
func (c *Client) ListRecommendations(ctx context.Context, params *ListRecommendationsInput, optFns ...func(*Options)) (*ListRecommendationsOutput, error)
Lists recommendations for the specified agent space
func (*Client) ListServices ¶
func (c *Client) ListServices(ctx context.Context, params *ListServicesInput, optFns ...func(*Options)) (*ListServicesOutput, error)
List a list of registered service on the account level.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists tags for the specified AWS DevOps Agent resource.
func (*Client) ListTriggers ¶ added in v1.7.0
func (c *Client) ListTriggers(ctx context.Context, params *ListTriggersInput, optFns ...func(*Options)) (*ListTriggersOutput, error)
Lists Triggers in the specified agent space
func (*Client) ListWebhooks ¶
func (c *Client) ListWebhooks(ctx context.Context, params *ListWebhooksInput, optFns ...func(*Options)) (*ListWebhooksOutput, error)
List all webhooks for given Association
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) RegisterService ¶
func (c *Client) RegisterService(ctx context.Context, params *RegisterServiceInput, optFns ...func(*Options)) (*RegisterServiceOutput, error)
This operation registers the specified service
func (*Client) SendMessage ¶
func (c *Client) SendMessage(ctx context.Context, params *SendMessageInput, optFns ...func(*Options)) (*SendMessageOutput, error)
Sends a chat message and streams the response for the specified agent space execution
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds or overwrites tags for the specified AWS DevOps Agent resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes tags from the specified AWS DevOps Agent resource.
func (*Client) UpdateAgentSpace ¶
func (c *Client) UpdateAgentSpace(ctx context.Context, params *UpdateAgentSpaceInput, optFns ...func(*Options)) (*UpdateAgentSpaceOutput, error)
Updates the information of an existing AgentSpace.
func (*Client) UpdateAsset ¶ added in v1.6.0
func (c *Client) UpdateAsset(ctx context.Context, params *UpdateAssetInput, optFns ...func(*Options)) (*UpdateAssetOutput, error)
Updates an asset in the specified agent space
func (*Client) UpdateAssetFile ¶ added in v1.6.0
func (c *Client) UpdateAssetFile(ctx context.Context, params *UpdateAssetFileInput, optFns ...func(*Options)) (*UpdateAssetFileOutput, error)
Updates a file in an asset
func (*Client) UpdateAssociation ¶
func (c *Client) UpdateAssociation(ctx context.Context, params *UpdateAssociationInput, optFns ...func(*Options)) (*UpdateAssociationOutput, error)
Partially updates the configuration of an existing service association for an AgentSpace. Present fields are fully replaced; absent fields are left unchanged. Returns 200 OK on success.
func (*Client) UpdateBacklogTask ¶
func (c *Client) UpdateBacklogTask(ctx context.Context, params *UpdateBacklogTaskInput, optFns ...func(*Options)) (*UpdateBacklogTaskOutput, error)
Update an existing backlog task.
func (*Client) UpdateGoal ¶
func (c *Client) UpdateGoal(ctx context.Context, params *UpdateGoalInput, optFns ...func(*Options)) (*UpdateGoalOutput, error)
Update an existing goal
func (*Client) UpdateOperatorAppIdpConfig ¶
func (c *Client) UpdateOperatorAppIdpConfig(ctx context.Context, params *UpdateOperatorAppIdpConfigInput, optFns ...func(*Options)) (*UpdateOperatorAppIdpConfigOutput, error)
Update the external Identity Provider configuration for the Operator App
func (*Client) UpdatePrivateConnectionCertificate ¶
func (c *Client) UpdatePrivateConnectionCertificate(ctx context.Context, params *UpdatePrivateConnectionCertificateInput, optFns ...func(*Options)) (*UpdatePrivateConnectionCertificateOutput, error)
Updates the certificate associated with a Private Connection.
func (*Client) UpdateRecommendation ¶
func (c *Client) UpdateRecommendation(ctx context.Context, params *UpdateRecommendationInput, optFns ...func(*Options)) (*UpdateRecommendationOutput, error)
Updates an existing recommendation with new content, status, or metadata
func (*Client) UpdateTrigger ¶ added in v1.7.0
func (c *Client) UpdateTrigger(ctx context.Context, params *UpdateTriggerInput, optFns ...func(*Options)) (*UpdateTriggerOutput, error)
Updates the status of an existing Trigger
func (*Client) ValidateAwsAssociations ¶
func (c *Client) ValidateAwsAssociations(ctx context.Context, params *ValidateAwsAssociationsInput, optFns ...func(*Options)) (*ValidateAwsAssociationsOutput, error)
Validates an aws association and set status and returns a 204 No Content response on success.
type CreateAgentSpaceInput ¶
type CreateAgentSpaceInput struct {
// The name of the AgentSpace.
//
// This member is required.
Name *string
// Client-provided token to ensure request idempotency. When the same token is
// provided in subsequent calls, the same response is returned within a 8-hour
// window.
ClientToken *string
// The description of the AgentSpace.
Description *string
// The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's
// used to encrypt resources.
KmsKeyArn *string
// The locale for the AgentSpace, which determines the language used in agent
// responses.
Locale *string
// Tags to add to the AgentSpace at creation time.
Tags map[string]string
// contains filtered or unexported fields
}
Input for creating a new AgentSpace.
type CreateAgentSpaceOutput ¶
type CreateAgentSpaceOutput struct {
// Represents a complete AgentSpace with all its properties, timestamps,
// encryption settings, and unique identifier.
//
// This member is required.
AgentSpace *types.AgentSpace
// Tags associated with the created AgentSpace.
Tags map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the newly created AgentSpace.
type CreateAssetFileInput ¶ added in v1.6.0
type CreateAssetFileInput struct {
// The unique identifier for the agent space containing the asset
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the asset to create the file in
//
// This member is required.
AssetId *string
// The content of the file to create
//
// This member is required.
Content types.AssetFileBody
// The path of the file within the asset
//
// This member is required.
Path *string
// A unique, case-sensitive identifier used for idempotent asset file creation
ClientToken *string
// Optional metadata describing this file
Metadata document.Interface
// contains filtered or unexported fields
}
Request structure for creating an asset file
type CreateAssetFileOutput ¶ added in v1.6.0
type CreateAssetFileOutput struct {
// The asset file object
//
// This member is required.
File *types.AssetFile
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for creating an asset file
type CreateAssetInput ¶ added in v1.6.0
type CreateAssetInput struct {
// The unique identifier for the agent space where the asset will be created
//
// This member is required.
AgentSpaceId *string
// The type of asset to create
//
// This member is required.
AssetType *string
// The content for the asset. Provide a single file, a zip bundle, or a sourceUrl
// to import from an external source.
//
// This member is required.
Content types.AssetContent
// A unique, case-sensitive identifier used for idempotent asset creation
ClientToken *string
// The metadata describing this asset
Metadata document.Interface
// contains filtered or unexported fields
}
Request structure for creating a new asset
type CreateAssetOutput ¶ added in v1.6.0
type CreateAssetOutput struct {
// The asset object
//
// This member is required.
Asset *types.Asset
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for creating a new asset
type CreateBacklogTaskInput ¶
type CreateBacklogTaskInput struct {
// The unique identifier for the agent space where the task will be created
//
// This member is required.
AgentSpaceId *string
// The priority level of the task
//
// This member is required.
Priority types.Priority
// The type of task being created
//
// This member is required.
TaskType types.TaskType
// The title of the backlog task
//
// This member is required.
Title *string
// Client-provided token for idempotent operations
ClientToken *string
// Optional detailed description of the task
Description *string
// Optional reference information for the task
Reference *types.ReferenceInput
// contains filtered or unexported fields
}
Request structure for creating a new backlog task
type CreateBacklogTaskOutput ¶
type CreateBacklogTaskOutput struct {
// The newly created task object
//
// This member is required.
Task *types.Task
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure containing the created backlog task
type CreateChatInput ¶
type CreateChatInput struct {
// Unique identifier for an agent space (allows alphanumeric characters and
// hyphens; 1-64 characters)
//
// This member is required.
AgentSpaceId *string
// The user identifier for the chat. This field is deprecated and will be ignored
// — the service resolves user identity from the authenticated session.
//
// Deprecated: userId is managed by the service and should not be provided by the
// caller
UserId *string
// The authentication type of the user
UserType types.UserType
// contains filtered or unexported fields
}
Request structure for creating a new chat
type CreateChatOutput ¶
type CreateChatOutput struct {
// Timestamp when the chat was created
//
// This member is required.
CreatedAt *time.Time
// The unique identifier for the created execution
//
// This member is required.
ExecutionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for creating a new chat
type CreatePrivateConnectionInput ¶
type CreatePrivateConnectionInput struct {
// Private Connection mode configuration.
//
// This member is required.
Mode types.PrivateConnectionMode
// Unique name for this Private Connection within the account.
//
// This member is required.
Name *string
// Tags to add to the Private Connection at creation time.
Tags map[string]string
// contains filtered or unexported fields
}
Input for creating a new Private Connection.
type CreatePrivateConnectionOutput ¶
type CreatePrivateConnectionOutput struct {
// The name of the Private Connection.
//
// This member is required.
Name *string
// The status of the Private Connection.
//
// This member is required.
Status types.PrivateConnectionStatus
// The type of the Private Connection.
//
// This member is required.
Type types.PrivateConnectionType
// The expiry time of the certificate associated with the Private Connection. Only
// present when a certificate is associated.
CertificateExpiryTime *time.Time
// DNS resolution mode for the Private Connection's resource gateway.
DnsResolution types.ResourceConfigDnsResolution
// Message describing the reason for a failed Private Connection creation, if
// applicable.
FailureMessage *string
// IP address or DNS name of the target resource. Only present for service-managed
// Private Connections.
HostAddress *string
// The Resource Configuration ARN. Only present for self-managed Private
// Connections.
ResourceConfigurationId *string
// The service-managed Resource Gateway ARN. Only present for service-managed
// Private Connections.
ResourceGatewayId *string
// Tags associated with the created Private Connection.
Tags map[string]string
// VPC identifier of the service-managed Resource Gateway. Only present for
// service-managed Private Connections.
VpcId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the newly created Private Connection summary.
type CreateTriggerInput ¶ added in v1.7.0
type CreateTriggerInput struct {
// The action the new Trigger performs when it fires
//
// This member is required.
Action document.Interface
// The unique identifier for the agent space where the Trigger will be created
//
// This member is required.
AgentSpaceId *string
// The condition that fires the new Trigger
//
// This member is required.
Condition types.TriggerCondition
// How the new Trigger fires
//
// This member is required.
Type *string
// A unique, case-sensitive identifier used for idempotent Trigger creation
ClientToken *string
// The initial status of the Trigger
Status *string
// contains filtered or unexported fields
}
Request structure for creating a new Trigger
type CreateTriggerOutput ¶ added in v1.7.0
type CreateTriggerOutput struct {
// The Trigger object
//
// This member is required.
Trigger *types.Trigger
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for creating a new Trigger
type DeleteAgentSpaceInput ¶
type DeleteAgentSpaceInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// contains filtered or unexported fields
}
Input for deleting an AgentSpace.
type DeleteAgentSpaceOutput ¶
type DeleteAgentSpaceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Empty output for successful AgentSpace deletion.
type DeleteAssetFileInput ¶ added in v1.6.0
type DeleteAssetFileInput struct {
// The unique identifier for the agent space containing the asset
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the asset containing the file
//
// This member is required.
AssetId *string
// The path of the file within the asset to delete
//
// This member is required.
Path *string
// contains filtered or unexported fields
}
Request structure for deleting an asset file
type DeleteAssetFileOutput ¶ added in v1.6.0
type DeleteAssetFileOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for deleting an asset file
type DeleteAssetInput ¶ added in v1.6.0
type DeleteAssetInput struct {
// The unique identifier for the agent space containing the asset
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the asset to delete
//
// This member is required.
AssetId *string
// contains filtered or unexported fields
}
Request structure for deleting an asset
type DeleteAssetOutput ¶ added in v1.6.0
type DeleteAssetOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for deleting an asset
type DeletePrivateConnectionInput ¶
type DeletePrivateConnectionInput struct {
// The name of the Private Connection.
//
// This member is required.
Name *string
// contains filtered or unexported fields
}
Input for deleting an existing Private Connection.
type DeletePrivateConnectionOutput ¶
type DeletePrivateConnectionOutput struct {
// The name of the Private Connection.
//
// This member is required.
Name *string
// The status of the Private Connection.
//
// This member is required.
Status types.PrivateConnectionStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the status of the Private Connection deletion.
type DeleteTriggerInput ¶ added in v1.7.0
type DeleteTriggerInput struct {
// The unique identifier for the agent space containing the Trigger
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the Trigger to delete
//
// This member is required.
TriggerId *string
// contains filtered or unexported fields
}
Request structure for deleting a Trigger
type DeleteTriggerOutput ¶ added in v1.7.0
type DeleteTriggerOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for deleting a Trigger
type DeregisterServiceInput ¶
type DeregisterServiceInput struct {
// The service id to deregister. A service can only be deregistered if it is not
// associated with any AgentSpace.
//
// This member is required.
ServiceId *string
// contains filtered or unexported fields
}
Input for deregistering a service.
type DeregisterServiceOutput ¶
type DeregisterServiceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Empty output for successful service deregistration.
type DescribePrivateConnectionInput ¶
type DescribePrivateConnectionInput struct {
// The name of the Private Connection.
//
// This member is required.
Name *string
// contains filtered or unexported fields
}
Input for describing an existing Private Connection.
type DescribePrivateConnectionOutput ¶
type DescribePrivateConnectionOutput struct {
// The name of the Private Connection.
//
// This member is required.
Name *string
// The status of the Private Connection.
//
// This member is required.
Status types.PrivateConnectionStatus
// The type of the Private Connection.
//
// This member is required.
Type types.PrivateConnectionType
// The expiry time of the certificate associated with the Private Connection. Only
// present when a certificate is associated.
CertificateExpiryTime *time.Time
// DNS resolution mode for the Private Connection's resource gateway.
DnsResolution types.ResourceConfigDnsResolution
// Message describing the reason for a failed Private Connection, if applicable.
FailureMessage *string
// IP address or DNS name of the target resource. Only present for service-managed
// Private Connections.
HostAddress *string
// The Resource Configuration ARN. Only present for self-managed Private
// Connections.
ResourceConfigurationId *string
// The service-managed Resource Gateway ARN. Only present for service-managed
// Private Connections.
ResourceGatewayId *string
// Tags associated with the Private Connection.
Tags map[string]string
// VPC identifier of the service-managed Resource Gateway. Only present for
// service-managed Private Connections.
VpcId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the Private Connection details.
type DisableOperatorAppInput ¶
type DisableOperatorAppInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// The authentication flow configured for the operator App. e.g. idc
AuthFlow types.AuthFlow
// contains filtered or unexported fields
}
Input for disabling the Operator App for an AgentSpace.
type DisableOperatorAppOutput ¶
type DisableOperatorAppOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type DisassociateServiceInput ¶
type DisassociateServiceInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the given association.
//
// This member is required.
AssociationId *string
// contains filtered or unexported fields
}
Input for removing a service association from an AgentSpace.
type DisassociateServiceOutput ¶
type DisassociateServiceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Empty output for successful service disassociation.
type EnableOperatorAppInput ¶
type EnableOperatorAppInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// The authentication flow configured for the operator App. e.g. iam or idc
//
// This member is required.
AuthFlow types.AuthFlow
// The IAM role end users assume to access AIDevOps APIs
//
// This member is required.
OperatorAppRoleArn *string
// The IdC instance Arn used to create an IdC auth application
IdcInstanceArn *string
// The OIDC client ID for the IdP application
IdpClientId *string
// The OIDC client secret for the IdP application
IdpClientSecret *string
// The OIDC issuer URL of the external Identity Provider
IssuerUrl *string
// The Identity Provider name (e.g., Entra, Okta, Google)
Provider *string
// contains filtered or unexported fields
}
Input for enabling the Operator App for an AgentSpace.
type EnableOperatorAppOutput ¶
type EnableOperatorAppOutput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// Configuration for IAM-based authentication flow for the Operator App.
Iam *types.IamAuthConfiguration
// Configuration for AWS Identity Center (IdC) authentication flow for the
// Operator App.
Idc *types.IdcAuthConfiguration
// Configuration for external Identity Provider OIDC authentication flow for the
// Operator App.
Idp *types.IdpAuthConfiguration
// The URL for operators to access the Operator App
OperatorAppUrl *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the enabled Operator App configuration.
type EndpointParameters ¶
type EndpointParameters struct {
// 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
// The AWS region used to dispatch the request.
//
// Parameter is
// required.
//
// AWS::Region
Region *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 GetAccountUsageInput ¶
type GetAccountUsageInput struct {
// contains filtered or unexported fields
}
type GetAccountUsageOutput ¶
type GetAccountUsageOutput struct {
// The end time of the usage tracking period
//
// This member is required.
UsagePeriodEndTime *time.Time
// The start time of the usage tracking period
//
// This member is required.
UsagePeriodStartTime *time.Time
// Monthly evaluation hours usage and limit for an account
MonthlyAccountEvaluationHours *types.UsageMetric
// Monthly investigation hours usage and limit for an account
MonthlyAccountInvestigationHours *types.UsageMetric
// Monthly on-demand hours usage and limit for an account
MonthlyAccountOnDemandHours *types.UsageMetric
// Monthly system learning hours usage and limit for an account
MonthlyAccountSystemLearningHours *types.UsageMetric
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type GetAgentSpaceInput ¶
type GetAgentSpaceInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// contains filtered or unexported fields
}
Input for retrieving a specific AgentSpace by ID.
type GetAgentSpaceOutput ¶
type GetAgentSpaceOutput struct {
// Represents a complete AgentSpace with all its properties, timestamps,
// encryption settings, and unique identifier.
//
// This member is required.
AgentSpace *types.AgentSpace
// Tags associated with the AgentSpace.
Tags map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the requested AgentSpace details.
type GetAssetContentInput ¶ added in v1.6.0
type GetAssetContentInput struct {
// The unique identifier for the agent space containing the asset
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the asset
//
// This member is required.
AssetId *string
// The specific asset version to export. If omitted, the latest version is
// returned.
AssetVersion *int32
// contains filtered or unexported fields
}
Request structure for getting an asset's content as a zip bundle
type GetAssetContentOutput ¶ added in v1.6.0
type GetAssetContentOutput struct {
// The asset content as a zip file
//
// This member is required.
Content *types.AssetZipContent
// The asset version this content belongs to
//
// This member is required.
Version *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for getting an asset's content as a zip bundle
type GetAssetFileInput ¶ added in v1.6.0
type GetAssetFileInput struct {
// The unique identifier for the agent space containing the asset
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the asset containing the file
//
// This member is required.
AssetId *string
// The path of the file within the asset to retrieve
//
// This member is required.
Path *string
// The specific asset version to retrieve the file from. If omitted, the latest
// version is returned.
AssetVersion *int32
// contains filtered or unexported fields
}
Request structure for getting an asset file
type GetAssetFileOutput ¶ added in v1.6.0
type GetAssetFileOutput struct {
// The asset file object
//
// This member is required.
File *types.AssetFile
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for getting an asset file
type GetAssetInput ¶ added in v1.6.0
type GetAssetInput struct {
// The unique identifier for the agent space containing the asset
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the asset to retrieve
//
// This member is required.
AssetId *string
// The specific version of the asset to retrieve. If omitted, the latest version
// is returned.
AssetVersion *int32
// contains filtered or unexported fields
}
Request structure for getting an asset
type GetAssetOutput ¶ added in v1.6.0
type GetAssetOutput struct {
// The asset object
//
// This member is required.
Asset *types.Asset
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for getting an asset
type GetAssociationInput ¶
type GetAssociationInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the given association.
//
// This member is required.
AssociationId *string
// contains filtered or unexported fields
}
Input for retrieving a specific service association.
type GetAssociationOutput ¶
type GetAssociationOutput struct {
// Represents a service association within an AgentSpace, defining how the agent
// interacts with external services.
//
// This member is required.
Association *types.Association
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the requested association details.
type GetBacklogTaskInput ¶
type GetBacklogTaskInput struct {
// The unique identifier for the agent space containing the task
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the task to retrieve
//
// This member is required.
TaskId *string
// contains filtered or unexported fields
}
Request structure for retrieving a specific backlog task
type GetBacklogTaskOutput ¶
type GetBacklogTaskOutput struct {
// The requested task object
//
// This member is required.
Task *types.Task
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure containing the requested backlog task
type GetOperatorAppInput ¶
type GetOperatorAppInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// contains filtered or unexported fields
}
Input for retrieving Operator App configuration.
type GetOperatorAppOutput ¶
type GetOperatorAppOutput struct {
// Configuration for IAM-based authentication flow for the Operator App.
Iam *types.IamAuthConfiguration
// Configuration for AWS Identity Center (IdC) authentication flow for the
// Operator App.
Idc *types.IdcAuthConfiguration
// Configuration for external Identity Provider OIDC authentication flow for the
// Operator App.
Idp *types.IdpAuthConfiguration
// The URL for operators to access the Operator App
OperatorAppUrl *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the Operator App configuration including authentication details.
type GetRecommendationInput ¶
type GetRecommendationInput struct {
// The unique identifier for the agent space containing the recommendation
//
// This member is required.
AgentSpaceId *string
// The unique identifier for the recommendation to retrieve
//
// This member is required.
RecommendationId *string
// Specific version of the recommendation to retrieve. If not specified, returns
// the latest version.
RecommendationVersion *int64
// contains filtered or unexported fields
}
Request structure for retrieving a specific recommendation
type GetRecommendationOutput ¶
type GetRecommendationOutput struct {
// The requested recommendation
//
// This member is required.
Recommendation *types.Recommendation
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure containing the requested recommendation
type GetServiceInput ¶
type GetServiceInput struct {
// The unique identifier of the given service.
//
// This member is required.
ServiceId *string
// contains filtered or unexported fields
}
Input for retrieving a specific service association.
type GetServiceOutput ¶
type GetServiceOutput struct {
// Represents a registered service with its configuration and accessible resources.
//
// This member is required.
Service *types.RegisteredService
// Tags associated with the Service.
Tags map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the requested service details.
type GetTriggerInput ¶ added in v1.7.0
type GetTriggerInput struct {
// The unique identifier for the agent space containing the Trigger
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the Trigger to retrieve
//
// This member is required.
TriggerId *string
// contains filtered or unexported fields
}
Request structure for getting a Trigger
type GetTriggerOutput ¶ added in v1.7.0
type GetTriggerOutput struct {
// The Trigger object
//
// This member is required.
Trigger *types.Trigger
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for getting a Trigger
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListAgentSpacesAPIClient ¶
type ListAgentSpacesAPIClient interface {
ListAgentSpaces(context.Context, *ListAgentSpacesInput, ...func(*Options)) (*ListAgentSpacesOutput, error)
}
ListAgentSpacesAPIClient is a client that implements the ListAgentSpaces operation.
type ListAgentSpacesInput ¶
type ListAgentSpacesInput struct {
// Maximum number of results to return in a single call.
MaxResults *int32
// Token for the next page of results.
NextToken *string
// contains filtered or unexported fields
}
Input for listing AgentSpaces with pagination support.
type ListAgentSpacesOutput ¶
type ListAgentSpacesOutput struct {
// The list of AgentSpaces.
//
// This member is required.
AgentSpaces []types.AgentSpace
// Token to retrieve the next page of results, if there are more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing a list of AgentSpaces and pagination token.
type ListAgentSpacesPaginator ¶
type ListAgentSpacesPaginator struct {
// contains filtered or unexported fields
}
ListAgentSpacesPaginator is a paginator for ListAgentSpaces
func NewListAgentSpacesPaginator ¶
func NewListAgentSpacesPaginator(client ListAgentSpacesAPIClient, params *ListAgentSpacesInput, optFns ...func(*ListAgentSpacesPaginatorOptions)) *ListAgentSpacesPaginator
NewListAgentSpacesPaginator returns a new ListAgentSpacesPaginator
func (*ListAgentSpacesPaginator) HasMorePages ¶
func (p *ListAgentSpacesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAgentSpacesPaginator) NextPage ¶
func (p *ListAgentSpacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAgentSpacesOutput, error)
NextPage retrieves the next ListAgentSpaces page.
type ListAgentSpacesPaginatorOptions ¶
type ListAgentSpacesPaginatorOptions struct {
// Maximum number of results to return in a single call.
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
}
ListAgentSpacesPaginatorOptions is the paginator options for ListAgentSpaces
type ListAssetFilesAPIClient ¶ added in v1.6.0
type ListAssetFilesAPIClient interface {
ListAssetFiles(context.Context, *ListAssetFilesInput, ...func(*Options)) (*ListAssetFilesOutput, error)
}
ListAssetFilesAPIClient is a client that implements the ListAssetFiles operation.
type ListAssetFilesInput ¶ added in v1.6.0
type ListAssetFilesInput struct {
// The unique identifier for the agent space containing the asset
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the asset whose files to list
//
// This member is required.
AssetId *string
// The specific asset version to list files from. If omitted, files from the
// latest version are returned.
AssetVersion *int32
// The maximum number of results to return in a single response
MaxResults *int32
// Pagination token from a previous response to retrieve the next page of results
NextToken *string
// contains filtered or unexported fields
}
Request structure for listing asset files
type ListAssetFilesOutput ¶ added in v1.6.0
type ListAssetFilesOutput struct {
// The list of asset file summaries
//
// This member is required.
Items []types.AssetFileSummary
// Pagination token to retrieve the next page of results. Absent when there are no
// more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for listing asset files
type ListAssetFilesPaginator ¶ added in v1.6.0
type ListAssetFilesPaginator struct {
// contains filtered or unexported fields
}
ListAssetFilesPaginator is a paginator for ListAssetFiles
func NewListAssetFilesPaginator ¶ added in v1.6.0
func NewListAssetFilesPaginator(client ListAssetFilesAPIClient, params *ListAssetFilesInput, optFns ...func(*ListAssetFilesPaginatorOptions)) *ListAssetFilesPaginator
NewListAssetFilesPaginator returns a new ListAssetFilesPaginator
func (*ListAssetFilesPaginator) HasMorePages ¶ added in v1.6.0
func (p *ListAssetFilesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAssetFilesPaginator) NextPage ¶ added in v1.6.0
func (p *ListAssetFilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetFilesOutput, error)
NextPage retrieves the next ListAssetFiles page.
type ListAssetFilesPaginatorOptions ¶ added in v1.6.0
type ListAssetFilesPaginatorOptions struct {
// The 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
}
ListAssetFilesPaginatorOptions is the paginator options for ListAssetFiles
type ListAssetTypesAPIClient ¶ added in v1.6.0
type ListAssetTypesAPIClient interface {
ListAssetTypes(context.Context, *ListAssetTypesInput, ...func(*Options)) (*ListAssetTypesOutput, error)
}
ListAssetTypesAPIClient is a client that implements the ListAssetTypes operation.
type ListAssetTypesInput ¶ added in v1.6.0
type ListAssetTypesInput struct {
// The maximum number of results to return in a single response
MaxResults *int32
// Pagination token from a previous response to retrieve the next page of results
NextToken *string
// contains filtered or unexported fields
}
Request structure for listing asset types
type ListAssetTypesOutput ¶ added in v1.6.0
type ListAssetTypesOutput struct {
// The list of supported asset types
//
// This member is required.
Items []types.AssetTypeSummary
// Pagination token to retrieve the next page of results. Absent when there are no
// more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for listing asset types
type ListAssetTypesPaginator ¶ added in v1.6.0
type ListAssetTypesPaginator struct {
// contains filtered or unexported fields
}
ListAssetTypesPaginator is a paginator for ListAssetTypes
func NewListAssetTypesPaginator ¶ added in v1.6.0
func NewListAssetTypesPaginator(client ListAssetTypesAPIClient, params *ListAssetTypesInput, optFns ...func(*ListAssetTypesPaginatorOptions)) *ListAssetTypesPaginator
NewListAssetTypesPaginator returns a new ListAssetTypesPaginator
func (*ListAssetTypesPaginator) HasMorePages ¶ added in v1.6.0
func (p *ListAssetTypesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAssetTypesPaginator) NextPage ¶ added in v1.6.0
func (p *ListAssetTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetTypesOutput, error)
NextPage retrieves the next ListAssetTypes page.
type ListAssetTypesPaginatorOptions ¶ added in v1.6.0
type ListAssetTypesPaginatorOptions struct {
// The 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
}
ListAssetTypesPaginatorOptions is the paginator options for ListAssetTypes
type ListAssetVersionsAPIClient ¶ added in v1.6.0
type ListAssetVersionsAPIClient interface {
ListAssetVersions(context.Context, *ListAssetVersionsInput, ...func(*Options)) (*ListAssetVersionsOutput, error)
}
ListAssetVersionsAPIClient is a client that implements the ListAssetVersions operation.
type ListAssetVersionsInput ¶ added in v1.6.0
type ListAssetVersionsInput struct {
// The unique identifier for the agent space containing the asset
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the asset whose versions to list
//
// This member is required.
AssetId *string
// The maximum number of results to return in a single response
MaxResults *int32
// Pagination token from a previous response to retrieve the next page of results
NextToken *string
// contains filtered or unexported fields
}
Request structure for listing asset versions
type ListAssetVersionsOutput ¶ added in v1.6.0
type ListAssetVersionsOutput struct {
// The list of version metadata for the asset
//
// This member is required.
Items []types.AssetVersionMetadata
// Pagination token to retrieve the next page of results. Absent when there are no
// more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for listing asset versions
type ListAssetVersionsPaginator ¶ added in v1.6.0
type ListAssetVersionsPaginator struct {
// contains filtered or unexported fields
}
ListAssetVersionsPaginator is a paginator for ListAssetVersions
func NewListAssetVersionsPaginator ¶ added in v1.6.0
func NewListAssetVersionsPaginator(client ListAssetVersionsAPIClient, params *ListAssetVersionsInput, optFns ...func(*ListAssetVersionsPaginatorOptions)) *ListAssetVersionsPaginator
NewListAssetVersionsPaginator returns a new ListAssetVersionsPaginator
func (*ListAssetVersionsPaginator) HasMorePages ¶ added in v1.6.0
func (p *ListAssetVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAssetVersionsPaginator) NextPage ¶ added in v1.6.0
func (p *ListAssetVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetVersionsOutput, error)
NextPage retrieves the next ListAssetVersions page.
type ListAssetVersionsPaginatorOptions ¶ added in v1.6.0
type ListAssetVersionsPaginatorOptions struct {
// The 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
}
ListAssetVersionsPaginatorOptions is the paginator options for ListAssetVersions
type ListAssetsAPIClient ¶ added in v1.6.0
type ListAssetsAPIClient interface {
ListAssets(context.Context, *ListAssetsInput, ...func(*Options)) (*ListAssetsOutput, error)
}
ListAssetsAPIClient is a client that implements the ListAssets operation.
type ListAssetsInput ¶ added in v1.6.0
type ListAssetsInput struct {
// The unique identifier for the agent space to list assets from
//
// This member is required.
AgentSpaceId *string
// Filter results to only assets of this type
AssetType *string
// The maximum number of results to return in a single response
MaxResults *int32
// Pagination token from a previous response to retrieve the next page of results
NextToken *string
// Filter results to only assets updated after this timestamp
UpdatedAfter *time.Time
// Filter results to only assets updated before this timestamp
UpdatedBefore *time.Time
// contains filtered or unexported fields
}
Request structure for listing assets
type ListAssetsOutput ¶ added in v1.6.0
type ListAssetsOutput struct {
// The list of assets for the agent space
//
// This member is required.
Items []types.Asset
// Pagination token to retrieve the next page of results. Absent when there are no
// more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for listing assets
type ListAssetsPaginator ¶ added in v1.6.0
type ListAssetsPaginator struct {
// contains filtered or unexported fields
}
ListAssetsPaginator is a paginator for ListAssets
func NewListAssetsPaginator ¶ added in v1.6.0
func NewListAssetsPaginator(client ListAssetsAPIClient, params *ListAssetsInput, optFns ...func(*ListAssetsPaginatorOptions)) *ListAssetsPaginator
NewListAssetsPaginator returns a new ListAssetsPaginator
func (*ListAssetsPaginator) HasMorePages ¶ added in v1.6.0
func (p *ListAssetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAssetsPaginator) NextPage ¶ added in v1.6.0
func (p *ListAssetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetsOutput, error)
NextPage retrieves the next ListAssets page.
type ListAssetsPaginatorOptions ¶ added in v1.6.0
type ListAssetsPaginatorOptions struct {
// The 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
}
ListAssetsPaginatorOptions is the paginator options for ListAssets
type ListAssociationsAPIClient ¶
type ListAssociationsAPIClient interface {
ListAssociations(context.Context, *ListAssociationsInput, ...func(*Options)) (*ListAssociationsOutput, error)
}
ListAssociationsAPIClient is a client that implements the ListAssociations operation.
type ListAssociationsInput ¶
type ListAssociationsInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// A comma-separated list of service types to filter list associations output
FilterServiceTypes *string
// Maximum number of results to return in a single call.
MaxResults *int32
// Token for the next page of results.
NextToken *string
// contains filtered or unexported fields
}
Input for listing service associations within an AgentSpace.
type ListAssociationsOutput ¶
type ListAssociationsOutput struct {
// The list of associations.
//
// This member is required.
Associations []types.Association
// Token to retrieve the next page of results, if there are more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing a list of service associations and pagination token.
type ListAssociationsPaginator ¶
type ListAssociationsPaginator struct {
// contains filtered or unexported fields
}
ListAssociationsPaginator is a paginator for ListAssociations
func NewListAssociationsPaginator ¶
func NewListAssociationsPaginator(client ListAssociationsAPIClient, params *ListAssociationsInput, optFns ...func(*ListAssociationsPaginatorOptions)) *ListAssociationsPaginator
NewListAssociationsPaginator returns a new ListAssociationsPaginator
func (*ListAssociationsPaginator) HasMorePages ¶
func (p *ListAssociationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAssociationsPaginator) NextPage ¶
func (p *ListAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssociationsOutput, error)
NextPage retrieves the next ListAssociations page.
type ListAssociationsPaginatorOptions ¶
type ListAssociationsPaginatorOptions struct {
// Maximum number of results to return in a single call.
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
}
ListAssociationsPaginatorOptions is the paginator options for ListAssociations
type ListBacklogTasksAPIClient ¶
type ListBacklogTasksAPIClient interface {
ListBacklogTasks(context.Context, *ListBacklogTasksInput, ...func(*Options)) (*ListBacklogTasksOutput, error)
}
ListBacklogTasksAPIClient is a client that implements the ListBacklogTasks operation.
type ListBacklogTasksInput ¶
type ListBacklogTasksInput struct {
// The unique identifier for the agent space containing the tasks
//
// This member is required.
AgentSpaceId *string
// Filter criteria to apply when listing tasks Filtering restrictions: - Each
// filter field list is limited to a single value - Filtering by Priority and
// Status at the same time when not filtering by Type is not permitted - Timestamp
// filters (createdAfter, createdBefore) can be combined with other filters when
// not sorting by priority
Filter *types.TaskFilter
// Maximum number of tasks to return in a single response (1-1000, default: 100)
Limit *int32
// Token for retrieving the next page of results
NextToken *string
// Sort order for the tasks based on sortField (default: DESC)
Order types.TaskSortOrder
// Field to sort by Sorting restrictions: - Only sorting on createdAt is supported
// when using priority or status filters alone. - Sorting by priority is not
// supported when using Timestamp filters (createdAfter, createdBefore)
SortField types.TaskSortField
// contains filtered or unexported fields
}
Request structure for listing backlog tasks with filtering, sorting, and pagination support
type ListBacklogTasksOutput ¶
type ListBacklogTasksOutput struct {
// List of backlog tasks
//
// This member is required.
Tasks []types.Task
// Token for retrieving the next page of results, if more results are available
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure containing a list of backlog tasks
type ListBacklogTasksPaginator ¶
type ListBacklogTasksPaginator struct {
// contains filtered or unexported fields
}
ListBacklogTasksPaginator is a paginator for ListBacklogTasks
func NewListBacklogTasksPaginator ¶
func NewListBacklogTasksPaginator(client ListBacklogTasksAPIClient, params *ListBacklogTasksInput, optFns ...func(*ListBacklogTasksPaginatorOptions)) *ListBacklogTasksPaginator
NewListBacklogTasksPaginator returns a new ListBacklogTasksPaginator
func (*ListBacklogTasksPaginator) HasMorePages ¶
func (p *ListBacklogTasksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListBacklogTasksPaginator) NextPage ¶
func (p *ListBacklogTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBacklogTasksOutput, error)
NextPage retrieves the next ListBacklogTasks page.
type ListBacklogTasksPaginatorOptions ¶
type ListBacklogTasksPaginatorOptions struct {
// Maximum number of tasks to return in a single response (1-1000, default: 100)
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
}
ListBacklogTasksPaginatorOptions is the paginator options for ListBacklogTasks
type ListChatsInput ¶
type ListChatsInput struct {
// Unique identifier for an agent space (allows alphanumeric characters and
// hyphens; 1-64 characters)
//
// This member is required.
AgentSpaceId *string
// Maximum number of results to return
MaxResults *int32
// Token for pagination
NextToken *string
// The user identifier to list chats for. This field is deprecated and will be
// ignored — the service resolves user identity from the authenticated session.
//
// Deprecated: userId is managed by the service and should not be provided by the
// caller
UserId *string
// contains filtered or unexported fields
}
Request structure for listing chats
type ListChatsOutput ¶
type ListChatsOutput struct {
// List of recent chat executions
//
// This member is required.
Executions []types.ChatExecution
// Token for retrieving the next page of results
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for listing chats
type ListExecutionsAPIClient ¶
type ListExecutionsAPIClient interface {
ListExecutions(context.Context, *ListExecutionsInput, ...func(*Options)) (*ListExecutionsOutput, error)
}
ListExecutionsAPIClient is a client that implements the ListExecutions operation.
type ListExecutionsInput ¶
type ListExecutionsInput struct {
// The unique identifier for the agent space
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the task whose executions to retrieve
//
// This member is required.
TaskId *string
// Maximum number of executions to return
Limit *int32
// Token for pagination to retrieve the next set of results
NextToken *string
// contains filtered or unexported fields
}
Request structure for listing executions
type ListExecutionsOutput ¶
type ListExecutionsOutput struct {
// List of executions
//
// This member is required.
Executions []types.Execution
// Token for retrieving the next page of results, if available
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure containing executions
type ListExecutionsPaginator ¶
type ListExecutionsPaginator struct {
// contains filtered or unexported fields
}
ListExecutionsPaginator is a paginator for ListExecutions
func NewListExecutionsPaginator ¶
func NewListExecutionsPaginator(client ListExecutionsAPIClient, params *ListExecutionsInput, optFns ...func(*ListExecutionsPaginatorOptions)) *ListExecutionsPaginator
NewListExecutionsPaginator returns a new ListExecutionsPaginator
func (*ListExecutionsPaginator) HasMorePages ¶
func (p *ListExecutionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListExecutionsPaginator) NextPage ¶
func (p *ListExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExecutionsOutput, error)
NextPage retrieves the next ListExecutions page.
type ListExecutionsPaginatorOptions ¶
type ListExecutionsPaginatorOptions struct {
// Maximum number of executions to return
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListExecutionsPaginatorOptions is the paginator options for ListExecutions
type ListGoalsAPIClient ¶
type ListGoalsAPIClient interface {
ListGoals(context.Context, *ListGoalsInput, ...func(*Options)) (*ListGoalsOutput, error)
}
ListGoalsAPIClient is a client that implements the ListGoals operation.
type ListGoalsInput ¶
type ListGoalsInput struct {
// The unique identifier for the agent space
//
// This member is required.
AgentSpaceId *string
// Filter goals by goal type
GoalType types.GoalType
// Maximum number of goals to return
Limit *int32
// Pagination token for the next set of results
NextToken *string
// Filter goals by goal status
Status types.GoalStatus
// contains filtered or unexported fields
}
Request structure for listing goals
type ListGoalsOutput ¶
type ListGoalsOutput struct {
// List of goals matching the criteria
//
// This member is required.
Goals []types.Goal
// Pagination token for the next set of results
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure containing the list of goals
type ListGoalsPaginator ¶
type ListGoalsPaginator struct {
// contains filtered or unexported fields
}
ListGoalsPaginator is a paginator for ListGoals
func NewListGoalsPaginator ¶
func NewListGoalsPaginator(client ListGoalsAPIClient, params *ListGoalsInput, optFns ...func(*ListGoalsPaginatorOptions)) *ListGoalsPaginator
NewListGoalsPaginator returns a new ListGoalsPaginator
func (*ListGoalsPaginator) HasMorePages ¶
func (p *ListGoalsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListGoalsPaginator) NextPage ¶
func (p *ListGoalsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGoalsOutput, error)
NextPage retrieves the next ListGoals page.
type ListGoalsPaginatorOptions ¶
type ListGoalsPaginatorOptions struct {
// Maximum number of goals to return
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListGoalsPaginatorOptions is the paginator options for ListGoals
type ListJournalRecordsAPIClient ¶
type ListJournalRecordsAPIClient interface {
ListJournalRecords(context.Context, *ListJournalRecordsInput, ...func(*Options)) (*ListJournalRecordsOutput, error)
}
ListJournalRecordsAPIClient is a client that implements the ListJournalRecords operation.
type ListJournalRecordsInput ¶
type ListJournalRecordsInput struct {
// The unique identifier for the agent space containing the execution
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the execution whose journal records to retrieve
//
// This member is required.
ExecutionId *string
// Maximum number of records to return in a single response (1-100, default: 100)
Limit *int32
// Token for retrieving the next page of results
NextToken *string
// Sort order for the records based on timestamp (default: DESC)
Order types.OrderType
// Filter records by type (empty string returns all types)
RecordType *string
// contains filtered or unexported fields
}
Request structure for listing journal records with filtering and pagination support
type ListJournalRecordsOutput ¶
type ListJournalRecordsOutput struct {
// List of journal records matching the request criteria
//
// This member is required.
Records []types.JournalRecord
// Token for retrieving the next page of results, if more results are available
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure containing a list of journal records
type ListJournalRecordsPaginator ¶
type ListJournalRecordsPaginator struct {
// contains filtered or unexported fields
}
ListJournalRecordsPaginator is a paginator for ListJournalRecords
func NewListJournalRecordsPaginator ¶
func NewListJournalRecordsPaginator(client ListJournalRecordsAPIClient, params *ListJournalRecordsInput, optFns ...func(*ListJournalRecordsPaginatorOptions)) *ListJournalRecordsPaginator
NewListJournalRecordsPaginator returns a new ListJournalRecordsPaginator
func (*ListJournalRecordsPaginator) HasMorePages ¶
func (p *ListJournalRecordsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListJournalRecordsPaginator) NextPage ¶
func (p *ListJournalRecordsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJournalRecordsOutput, error)
NextPage retrieves the next ListJournalRecords page.
type ListJournalRecordsPaginatorOptions ¶
type ListJournalRecordsPaginatorOptions struct {
// Maximum number of records to return in a single response (1-100, default: 100)
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
}
ListJournalRecordsPaginatorOptions is the paginator options for ListJournalRecords
type ListPendingMessagesInput ¶
type ListPendingMessagesInput struct {
// Unique identifier for an agent space (allows alphanumeric characters and
// hyphens; 1-64 characters)
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the execution whose journal records to retrieve
//
// This member is required.
ExecutionId *string
// contains filtered or unexported fields
}
Request structure for listing pending messages with filtering and pagination support
type ListPendingMessagesOutput ¶
type ListPendingMessagesOutput struct {
// Unique identifier for an agent space (allows alphanumeric characters and
// hyphens; 1-64 characters)
//
// This member is required.
AgentSpaceId *string
// Timestamp when the pending messages were created.
//
// This member is required.
CreatedAt *time.Time
// The unique identifier for the execution.
//
// This member is required.
ExecutionId *string
// The list of pending messages for the execution.
//
// This member is required.
Messages []types.PendingMessage
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure containing a list of pending messages
type ListPrivateConnectionsInput ¶
type ListPrivateConnectionsInput struct {
// contains filtered or unexported fields
}
Input for listing Private Connections in the caller's account.
type ListPrivateConnectionsOutput ¶
type ListPrivateConnectionsOutput struct {
// The list of Private Connections.
//
// This member is required.
PrivateConnections []types.PrivateConnectionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the list of Private Connections.
type ListRecommendationsInput ¶
type ListRecommendationsInput struct {
// The unique identifier for the agent space containing the recommendations
//
// This member is required.
AgentSpaceId *string
// Optional goal ID to filter recommendations by specific goal
GoalId *string
// Maximum number of recommendations to return in a single response
Limit *int32
// Token for retrieving the next page of results
NextToken *string
// Optional priority to filter recommendations by priority level
Priority types.RecommendationPriority
// Optional status to filter recommendations by their current status
Status types.RecommendationStatus
// Optional task ID to filter recommendations by specific task
TaskId *string
// contains filtered or unexported fields
}
Request structure for listing recommendations with filtering and pagination support
type ListRecommendationsOutput ¶
type ListRecommendationsOutput struct {
// List of recommendations matching the request criteria
//
// This member is required.
Recommendations []types.Recommendation
// Token for retrieving the next page of results, if more results are available
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure containing a list of recommendations
type ListServicesAPIClient ¶
type ListServicesAPIClient interface {
ListServices(context.Context, *ListServicesInput, ...func(*Options)) (*ListServicesOutput, error)
}
ListServicesAPIClient is a client that implements the ListServices operation.
type ListServicesInput ¶
type ListServicesInput struct {
// Optional filter to list only services of a specific type.
FilterServiceType types.Service
// Maximum number of results to return in a single call.
MaxResults *int32
// Token for the next page of results.
NextToken *string
// contains filtered or unexported fields
}
Input for listing registered services with optional filtering by service type.
type ListServicesOutput ¶
type ListServicesOutput struct {
// List of registered services.
//
// This member is required.
Services []types.RegisteredService
// Token to retrieve the next page of results, if there are more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing a list of registered services and pagination token.
type ListServicesPaginator ¶
type ListServicesPaginator struct {
// contains filtered or unexported fields
}
ListServicesPaginator is a paginator for ListServices
func NewListServicesPaginator ¶
func NewListServicesPaginator(client ListServicesAPIClient, params *ListServicesInput, optFns ...func(*ListServicesPaginatorOptions)) *ListServicesPaginator
NewListServicesPaginator returns a new ListServicesPaginator
func (*ListServicesPaginator) HasMorePages ¶
func (p *ListServicesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListServicesPaginator) NextPage ¶
func (p *ListServicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListServicesOutput, error)
NextPage retrieves the next ListServices page.
type ListServicesPaginatorOptions ¶
type ListServicesPaginatorOptions struct {
// Maximum number of results to return in a single call.
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
}
ListServicesPaginatorOptions is the paginator options for ListServices
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct {
// The ARN of the resource.
//
// This member is required.
ResourceArn *string
// contains filtered or unexported fields
}
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct {
// Tags associated with the resource.
//
// This member is required.
Tags map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListTriggersAPIClient ¶ added in v1.7.0
type ListTriggersAPIClient interface {
ListTriggers(context.Context, *ListTriggersInput, ...func(*Options)) (*ListTriggersOutput, error)
}
ListTriggersAPIClient is a client that implements the ListTriggers operation.
type ListTriggersInput ¶ added in v1.7.0
type ListTriggersInput struct {
// The unique identifier for the agent space whose Triggers should be listed
//
// This member is required.
AgentSpaceId *string
// The maximum number of results to return in a single response
MaxResults *int32
// Pagination token from a previous response to retrieve the next page of results
NextToken *string
// Filter results to Triggers in this status
Status *string
// contains filtered or unexported fields
}
Request structure for listing Triggers in an agent space
type ListTriggersOutput ¶ added in v1.7.0
type ListTriggersOutput struct {
// The list of Triggers
//
// This member is required.
Items []types.Trigger
// Pagination token to retrieve the next page of results
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for listing Triggers
type ListTriggersPaginator ¶ added in v1.7.0
type ListTriggersPaginator struct {
// contains filtered or unexported fields
}
ListTriggersPaginator is a paginator for ListTriggers
func NewListTriggersPaginator ¶ added in v1.7.0
func NewListTriggersPaginator(client ListTriggersAPIClient, params *ListTriggersInput, optFns ...func(*ListTriggersPaginatorOptions)) *ListTriggersPaginator
NewListTriggersPaginator returns a new ListTriggersPaginator
func (*ListTriggersPaginator) HasMorePages ¶ added in v1.7.0
func (p *ListTriggersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTriggersPaginator) NextPage ¶ added in v1.7.0
func (p *ListTriggersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTriggersOutput, error)
NextPage retrieves the next ListTriggers page.
type ListTriggersPaginatorOptions ¶ added in v1.7.0
type ListTriggersPaginatorOptions struct {
// The 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
}
ListTriggersPaginatorOptions is the paginator options for ListTriggers
type ListWebhooksInput ¶
type ListWebhooksInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the given association.
//
// This member is required.
AssociationId *string
// contains filtered or unexported fields
}
Input for listing service webhooks within an association.
type ListWebhooksOutput ¶
type ListWebhooksOutput struct {
// The list of association webhooks.
//
// This member is required.
Webhooks []types.Webhook
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing a list of service association webhooks.
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
// 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 ¶
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 RegisterServiceInput ¶
type RegisterServiceInput struct {
// Services that can be registered via the post-registration API (excludes OAuth
// 3LO services).
//
// This member is required.
Service types.PostRegisterServiceSupportedService
// Service-specific authorization configuration parameters
//
// This member is required.
ServiceDetails types.ServiceDetails
// The name of the private connection to use for OAuth token exchange requests
// only. Cannot be specified when privateConnectionName is provided.
ExchangeUrlPrivateConnectionName *string
// The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's
// used to encrypt resources.
KmsKeyArn *string
// The display name for the service registration.
Name *string
// The name of the private connection to use for VPC connectivity.
PrivateConnectionName *string
// Tags to add to the Service at registration time.
Tags map[string]string
// The name of the private connection to use for API calls (target URL) only.
// Cannot be specified when privateConnectionName is provided.
TargetUrlPrivateConnectionName *string
// contains filtered or unexported fields
}
Input for registering a new service with the platform.
type RegisterServiceOutput ¶
type RegisterServiceOutput struct {
// Indicates if additional steps are required to complete service registration
// (e.g., 3-legged OAuth)
AdditionalStep types.AdditionalServiceRegistrationStep
// The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's
// used to encrypt resources.
KmsKeyArn *string
// Service ID - present when registration is complete, absent when additional
// steps are required
ServiceId *string
// Tags associated with the registered Service.
Tags map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the service ID and any additional steps required for registration.
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 SendMessageEventStream ¶
type SendMessageEventStream struct {
// SendMessageEventsReader is the EventStream reader for the SendMessageEvents
// 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 SendMessageEventsReader
// contains filtered or unexported fields
}
SendMessageEventStream provides the event stream handling for the SendMessage operation.
For testing and mocking the event stream this type should be initialized via the NewSendMessageEventStream constructor function. Using the functional options to pass in nested mock behavior.
func NewSendMessageEventStream ¶
func NewSendMessageEventStream(optFns ...func(*SendMessageEventStream)) *SendMessageEventStream
NewSendMessageEventStream initializes an SendMessageEventStream. This function should only be used for testing and mocking the SendMessageEventStream stream within your application.
The Reader member must be set before reading events from the stream.
func (*SendMessageEventStream) Close ¶
func (es *SendMessageEventStream) 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 (*SendMessageEventStream) Err ¶
func (es *SendMessageEventStream) 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 (*SendMessageEventStream) Events ¶
func (es *SendMessageEventStream) Events() <-chan types.SendMessageEvents
Events returns a channel to read events from.
type SendMessageEventsReader ¶
type SendMessageEventsReader interface {
Events() <-chan types.SendMessageEvents
Close() error
Err() error
}
SendMessageEventsReader provides the interface for reading events from a stream.
The writer's Close method must allow multiple concurrent calls.
type SendMessageInitialReply ¶
type SendMessageInitialReply struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for sending chat message events
type SendMessageInput ¶
type SendMessageInput struct {
// The agent space identifier
//
// This member is required.
AgentSpaceId *string
// The user message content
//
// This member is required.
Content *string
// The execution identifier for the chat session
//
// This member is required.
ExecutionId *string
// Optional list of asset identifiers to attach to the message
AssetIds []string
// Optional context for the message
Context *types.SendMessageContext
// User identifier. This field is deprecated and will be ignored — the service
// resolves user identity from the authenticated session.
//
// Deprecated: userId is managed by the service and should not be provided by the
// caller
UserId *string
// contains filtered or unexported fields
}
Request structure for sending a chat message
type SendMessageOutput ¶
type SendMessageOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for sending chat message events
func (*SendMessageOutput) GetInitialReply ¶
func (o *SendMessageOutput) GetInitialReply() <-chan SendMessageInitialReply
func (*SendMessageOutput) GetStream ¶
func (o *SendMessageOutput) GetStream() *SendMessageEventStream
GetStream returns the type to interact with the event stream.
type TagResourceInput ¶
type TagResourceOutput ¶
type TagResourceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
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 UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type UpdateAgentSpaceInput ¶
type UpdateAgentSpaceInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// The updated description of the AgentSpace.
Description *string
// The updated locale for the AgentSpace, which determines the language used in
// agent responses.
Locale *string
// The updated name of the AgentSpace.
Name *string
// contains filtered or unexported fields
}
Input for updating an existing AgentSpace's properties. All fields except agentSpaceId are optional for partial updates.
type UpdateAgentSpaceOutput ¶
type UpdateAgentSpaceOutput struct {
// Represents a complete AgentSpace with all its properties, timestamps,
// encryption settings, and unique identifier.
//
// This member is required.
AgentSpace *types.AgentSpace
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the updated AgentSpace.
type UpdateAssetFileInput ¶ added in v1.6.0
type UpdateAssetFileInput struct {
// The unique identifier for the agent space containing the asset
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the asset containing the file
//
// This member is required.
AssetId *string
// The path of the file within the asset to update
//
// This member is required.
Path *string
// A unique, case-sensitive identifier used for idempotent asset file update
ClientToken *string
// Updated file content. If omitted, the existing content is unchanged.
Content types.AssetFileBody
// Metadata fields to update. Only the fields present in this document are
// updated. Omitted fields retain their current values.
Metadata document.Interface
// contains filtered or unexported fields
}
Request structure for updating an asset file
type UpdateAssetFileOutput ¶ added in v1.6.0
type UpdateAssetFileOutput struct {
// The asset file object
//
// This member is required.
File *types.AssetFile
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for updating an asset file
type UpdateAssetInput ¶ added in v1.6.0
type UpdateAssetInput struct {
// The unique identifier for the agent space containing the asset
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the asset to update
//
// This member is required.
AssetId *string
// A unique, case-sensitive identifier used for idempotent asset update
ClientToken *string
// Optional content update. A single file adds or replaces one file; a zip
// replaces all files; a sourceUrl re-syncs from the original source.
Content types.AssetContent
// Metadata fields to update. Only the fields present in this document are
// updated. Omitted fields retain their current values.
Metadata document.Interface
// contains filtered or unexported fields
}
Request structure for updating an asset
type UpdateAssetOutput ¶ added in v1.6.0
type UpdateAssetOutput struct {
// The asset object
//
// This member is required.
Asset *types.Asset
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for updating an asset
type UpdateAssociationInput ¶
type UpdateAssociationInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the given association.
//
// This member is required.
AssociationId *string
// The configuration that directs how AgentSpace interacts with the given service.
// The entire configuration is replaced on update.
//
// This member is required.
Configuration types.ServiceConfiguration
// Enabled capabilities for this association.
Capabilities map[string]types.CapabilityConfiguration
// contains filtered or unexported fields
}
Input for updating an existing service association. Present fields are fully replaced; absent fields are left unchanged.
type UpdateAssociationOutput ¶
type UpdateAssociationOutput struct {
// Represents a service association within an AgentSpace, defining how the agent
// interacts with external services.
//
// This member is required.
Association *types.Association
// Generic webhook configuration
Webhook *types.GenericWebhook
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the updated association and optional webhook configuration.
type UpdateBacklogTaskInput ¶
type UpdateBacklogTaskInput struct {
// The unique identifier for the agent space containing the task
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the task to update
//
// This member is required.
TaskId *string
// Client-provided token for idempotent operations
ClientToken *string
// Updated task status
TaskStatus types.TaskStatus
// contains filtered or unexported fields
}
Request structure for updating a task
type UpdateBacklogTaskOutput ¶
type UpdateBacklogTaskOutput struct {
// The updated task object
//
// This member is required.
Task *types.Task
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure containing the updated task
type UpdateGoalInput ¶
type UpdateGoalInput struct {
// The unique identifier for the agent space containing the goal
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the goal to update
//
// This member is required.
GoalId *string
// Client-provided token for idempotent operations
ClientToken *string
// Update goal schedule state
EvaluationSchedule *types.GoalScheduleInput
// contains filtered or unexported fields
}
Request structure for updating a goal
type UpdateGoalOutput ¶
type UpdateGoalOutput struct {
// The updated goal object
//
// This member is required.
Goal *types.Goal
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure containing the updated goal
type UpdateOperatorAppIdpConfigInput ¶
type UpdateOperatorAppIdpConfigInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// The OIDC client secret for the IdP application
IdpClientSecret *string
// contains filtered or unexported fields
}
Input for updating the external Identity Provider configuration for the Operator App.
type UpdateOperatorAppIdpConfigOutput ¶
type UpdateOperatorAppIdpConfigOutput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// Configuration for external Identity Provider OIDC authentication flow for the
// Operator App.
//
// This member is required.
Idp *types.IdpAuthConfiguration
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the updated IdP configuration.
type UpdatePrivateConnectionCertificateInput ¶
type UpdatePrivateConnectionCertificateInput struct {
// The new certificate for the Private Connection.
//
// This member is required.
Certificate *string
// The name of the Private Connection.
//
// This member is required.
Name *string
// contains filtered or unexported fields
}
Input for updating the certificate of a Private Connection.
type UpdatePrivateConnectionCertificateOutput ¶
type UpdatePrivateConnectionCertificateOutput struct {
// The name of the Private Connection.
//
// This member is required.
Name *string
// The status of the Private Connection.
//
// This member is required.
Status types.PrivateConnectionStatus
// The type of the Private Connection.
//
// This member is required.
Type types.PrivateConnectionType
// The expiry time of the certificate associated with the Private Connection. Only
// present when a certificate is associated.
CertificateExpiryTime *time.Time
// DNS resolution mode for the Private Connection's resource gateway.
DnsResolution types.ResourceConfigDnsResolution
// Message describing the reason for a failed Private Connection update, if
// applicable.
FailureMessage *string
// IP address or DNS name of the target resource. Only present for service-managed
// Private Connections.
HostAddress *string
// The Resource Configuration ARN. Only present for self-managed Private
// Connections.
ResourceConfigurationId *string
// The service-managed Resource Gateway ARN. Only present for service-managed
// Private Connections.
ResourceGatewayId *string
// VPC identifier of the service-managed Resource Gateway. Only present for
// service-managed Private Connections.
VpcId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output containing the updated Private Connection summary.
type UpdateRecommendationInput ¶
type UpdateRecommendationInput struct {
// The unique identifier for the agent space containing the recommendation
//
// This member is required.
AgentSpaceId *string
// The unique identifier for the recommendation to update
//
// This member is required.
RecommendationId *string
// Additional context for recommendation
AdditionalContext *string
// A unique token that ensures idempotency of the request
ClientToken *string
// Current status of the recommendation
Status types.RecommendationStatus
// contains filtered or unexported fields
}
Request structure for updating an existing recommendation
type UpdateRecommendationOutput ¶
type UpdateRecommendationOutput struct {
// The updated recommendation
//
// This member is required.
Recommendation *types.Recommendation
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure containing the updated recommendation
type UpdateTriggerInput ¶ added in v1.7.0
type UpdateTriggerInput struct {
// The unique identifier for the agent space containing the Trigger
//
// This member is required.
AgentSpaceId *string
// The unique identifier of the Trigger to update
//
// This member is required.
TriggerId *string
// A unique, case-sensitive identifier used for idempotent Trigger update
ClientToken *string
// The new status for the Trigger
Status *string
// contains filtered or unexported fields
}
Request structure for updating a Trigger
type UpdateTriggerOutput ¶ added in v1.7.0
type UpdateTriggerOutput struct {
// The Trigger object
//
// This member is required.
Trigger *types.Trigger
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Response structure for updating a Trigger
type ValidateAwsAssociationsInput ¶
type ValidateAwsAssociationsInput struct {
// The unique identifier of the AgentSpace
//
// This member is required.
AgentSpaceId *string
// contains filtered or unexported fields
}
Input for validating an aws association
type ValidateAwsAssociationsOutput ¶
type ValidateAwsAssociationsOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Empty Output for successful validating an aws association
Source Files
¶
- api_client.go
- api_op_AssociateService.go
- api_op_CreateAgentSpace.go
- api_op_CreateAsset.go
- api_op_CreateAssetFile.go
- api_op_CreateBacklogTask.go
- api_op_CreateChat.go
- api_op_CreatePrivateConnection.go
- api_op_CreateTrigger.go
- api_op_DeleteAgentSpace.go
- api_op_DeleteAsset.go
- api_op_DeleteAssetFile.go
- api_op_DeletePrivateConnection.go
- api_op_DeleteTrigger.go
- api_op_DeregisterService.go
- api_op_DescribePrivateConnection.go
- api_op_DisableOperatorApp.go
- api_op_DisassociateService.go
- api_op_EnableOperatorApp.go
- api_op_GetAccountUsage.go
- api_op_GetAgentSpace.go
- api_op_GetAsset.go
- api_op_GetAssetContent.go
- api_op_GetAssetFile.go
- api_op_GetAssociation.go
- api_op_GetBacklogTask.go
- api_op_GetOperatorApp.go
- api_op_GetRecommendation.go
- api_op_GetService.go
- api_op_GetTrigger.go
- api_op_ListAgentSpaces.go
- api_op_ListAssetFiles.go
- api_op_ListAssetTypes.go
- api_op_ListAssetVersions.go
- api_op_ListAssets.go
- api_op_ListAssociations.go
- api_op_ListBacklogTasks.go
- api_op_ListChats.go
- api_op_ListExecutions.go
- api_op_ListGoals.go
- api_op_ListJournalRecords.go
- api_op_ListPendingMessages.go
- api_op_ListPrivateConnections.go
- api_op_ListRecommendations.go
- api_op_ListServices.go
- api_op_ListTagsForResource.go
- api_op_ListTriggers.go
- api_op_ListWebhooks.go
- api_op_RegisterService.go
- api_op_SendMessage.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateAgentSpace.go
- api_op_UpdateAsset.go
- api_op_UpdateAssetFile.go
- api_op_UpdateAssociation.go
- api_op_UpdateBacklogTask.go
- api_op_UpdateGoal.go
- api_op_UpdateOperatorAppIdpConfig.go
- api_op_UpdatePrivateConnectionCertificate.go
- api_op_UpdateRecommendation.go
- api_op_UpdateTrigger.go
- api_op_ValidateAwsAssociations.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- eventstream.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go