Documentation

Overview

    Package sagemakera2iruntime provides the API client, operations, and parameter types for Amazon Augmented AI Runtime.

    Amazon Augmented AI is in preview release and is subject to change. We do not recommend using this product in production environments. Amazon Augmented AI (Amazon A2I) adds the benefit of human judgment to any machine learning application. When an AI application can't evaluate data with a high degree of confidence, human reviewers can take over. This human review is called a human review workflow. To create and start a human review workflow, you need three resources: a worker task template, a flow definition, and a human loop. For information about these resources and prerequisites for using Amazon A2I, see Get Started with Amazon Augmented AI (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-getting-started.html) in the Amazon SageMaker Developer Guide. This API reference includes information about API actions and data types that you can use to interact with Amazon A2I programmatically. Use this guide to:

    * Start a human loop with the StartHumanLoop operation when using Amazon A2I with a custom task type. To learn more about the difference between custom and built-in task types, see Use Task Types (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-task-types-general.html). To learn how to start a human loop using this API, see Create and Start a Human Loop for a Custom Task Type (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-start-human-loop.html#a2i-instructions-starthumanloop) in the Amazon SageMaker Developer Guide.

    * Manage your human loops. You can list all human loops that you have created, describe individual human loops, and stop and delete human loops. To learn more, see Monitor and Manage Your Human Loop (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-monitor-humanloop-results.html) in the Amazon SageMaker Developer Guide.

    Amazon A2I integrates APIs from various AWS services to create and start human review workflows for those services. To learn how Amazon A2I uses these APIs, see Use APIs in Amazon A2I (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-api-references.html) in the Amazon SageMaker Developer Guide.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2019-11-07"
    View Source
    const ServiceID = "SageMaker A2I Runtime"

    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

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

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

            Client provides the API client to make operations call for Amazon Augmented AI Runtime.

            func New

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

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

              func NewFromConfig

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

                NewFromConfig returns a new client from the provided config.

                func (*Client) DeleteHumanLoop

                func (c *Client) DeleteHumanLoop(ctx context.Context, params *DeleteHumanLoopInput, optFns ...func(*Options)) (*DeleteHumanLoopOutput, error)

                  Deletes the specified human loop for a flow definition.

                  func (*Client) DescribeHumanLoop

                  func (c *Client) DescribeHumanLoop(ctx context.Context, params *DescribeHumanLoopInput, optFns ...func(*Options)) (*DescribeHumanLoopOutput, error)

                    Returns information about the specified human loop.

                    func (*Client) ListHumanLoops

                    func (c *Client) ListHumanLoops(ctx context.Context, params *ListHumanLoopsInput, optFns ...func(*Options)) (*ListHumanLoopsOutput, error)

                      Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.

                      func (*Client) StartHumanLoop

                      func (c *Client) StartHumanLoop(ctx context.Context, params *StartHumanLoopInput, optFns ...func(*Options)) (*StartHumanLoopOutput, error)

                        Starts a human loop, provided that at least one activation condition is met.

                        func (*Client) StopHumanLoop

                        func (c *Client) StopHumanLoop(ctx context.Context, params *StopHumanLoopInput, optFns ...func(*Options)) (*StopHumanLoopOutput, error)

                          Stops the specified human loop.

                          type DeleteHumanLoopInput

                          type DeleteHumanLoopInput struct {
                          
                          	// The name of the human loop that you want to delete.
                          	//
                          	// This member is required.
                          	HumanLoopName *string
                          }

                          type DeleteHumanLoopOutput

                          type DeleteHumanLoopOutput struct {
                          	// Metadata pertaining to the operation's result.
                          	ResultMetadata middleware.Metadata
                          }

                          type DescribeHumanLoopInput

                          type DescribeHumanLoopInput struct {
                          
                          	// The name of the human loop that you want information about.
                          	//
                          	// This member is required.
                          	HumanLoopName *string
                          }

                          type DescribeHumanLoopOutput

                          type DescribeHumanLoopOutput struct {
                          
                          	// The creation time when Amazon Augmented AI created the human loop.
                          	//
                          	// This member is required.
                          	CreationTime *time.Time
                          
                          	// The Amazon Resource Name (ARN) of the flow definition.
                          	//
                          	// This member is required.
                          	FlowDefinitionArn *string
                          
                          	// The Amazon Resource Name (ARN) of the human loop.
                          	//
                          	// This member is required.
                          	HumanLoopArn *string
                          
                          	// The name of the human loop. The name must be lowercase, unique within the Region
                          	// in your account, and can have up to 63 characters. Valid characters: a-z, 0-9,
                          	// and - (hyphen).
                          	//
                          	// This member is required.
                          	HumanLoopName *string
                          
                          	// The status of the human loop.
                          	//
                          	// This member is required.
                          	HumanLoopStatus types.HumanLoopStatus
                          
                          	// A failure code that identifies the type of failure.
                          	FailureCode *string
                          
                          	// The reason why a human loop failed. The failure reason is returned when the
                          	// status of the human loop is Failed.
                          	FailureReason *string
                          
                          	// An object that contains information about the output of the human loop.
                          	HumanLoopOutput *types.HumanLoopOutput
                          
                          	// Metadata pertaining to the operation's result.
                          	ResultMetadata middleware.Metadata
                          }

                          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 HTTPClient

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

                                  type HTTPSignerV4

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

                                  type ListHumanLoopsAPIClient

                                  type ListHumanLoopsAPIClient interface {
                                  	ListHumanLoops(context.Context, *ListHumanLoopsInput, ...func(*Options)) (*ListHumanLoopsOutput, error)
                                  }

                                    ListHumanLoopsAPIClient is a client that implements the ListHumanLoops operation.

                                    type ListHumanLoopsInput

                                    type ListHumanLoopsInput struct {
                                    
                                    	// The Amazon Resource Name (ARN) of a flow definition.
                                    	//
                                    	// This member is required.
                                    	FlowDefinitionArn *string
                                    
                                    	// (Optional) The timestamp of the date when you want the human loops to begin in
                                    	// ISO 8601 format. For example, 2020-02-24.
                                    	CreationTimeAfter *time.Time
                                    
                                    	// (Optional) The timestamp of the date before which you want the human loops to
                                    	// begin in ISO 8601 format. For example, 2020-02-24.
                                    	CreationTimeBefore *time.Time
                                    
                                    	// The total number of items to return. If the total number of available items is
                                    	// more than the value specified in MaxResults, then a NextToken is returned in the
                                    	// output. You can use this token to display the next page of results.
                                    	MaxResults int32
                                    
                                    	// A token to display the next page of results.
                                    	NextToken *string
                                    
                                    	// Optional. The order for displaying results. Valid values: Ascending and
                                    	// Descending.
                                    	SortOrder types.SortOrder
                                    }

                                    type ListHumanLoopsOutput

                                    type ListHumanLoopsOutput struct {
                                    
                                    	// An array of objects that contain information about the human loops.
                                    	//
                                    	// This member is required.
                                    	HumanLoopSummaries []types.HumanLoopSummary
                                    
                                    	// A token to display the next page of results.
                                    	NextToken *string
                                    
                                    	// Metadata pertaining to the operation's result.
                                    	ResultMetadata middleware.Metadata
                                    }

                                    type ListHumanLoopsPaginator

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

                                      ListHumanLoopsPaginator is a paginator for ListHumanLoops

                                      func NewListHumanLoopsPaginator

                                      func NewListHumanLoopsPaginator(client ListHumanLoopsAPIClient, params *ListHumanLoopsInput, optFns ...func(*ListHumanLoopsPaginatorOptions)) *ListHumanLoopsPaginator

                                        NewListHumanLoopsPaginator returns a new ListHumanLoopsPaginator

                                        func (*ListHumanLoopsPaginator) HasMorePages

                                        func (p *ListHumanLoopsPaginator) HasMorePages() bool

                                          HasMorePages returns a boolean indicating whether more pages are available

                                          func (*ListHumanLoopsPaginator) NextPage

                                          func (p *ListHumanLoopsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListHumanLoopsOutput, error)

                                            NextPage retrieves the next ListHumanLoops page.

                                            type ListHumanLoopsPaginatorOptions

                                            type ListHumanLoopsPaginatorOptions struct {
                                            	// The total number of items to return. If the total number of available items is
                                            	// more than the value specified in MaxResults, then a NextToken is returned in the
                                            	// output. You can use this token to display the next page of results.
                                            	Limit int32
                                            
                                            	// Set to true if pagination should stop if the service returns a pagination token
                                            	// that matches the most recent token provided to the service.
                                            	StopOnDuplicateToken bool
                                            }

                                              ListHumanLoopsPaginatorOptions is the paginator options for ListHumanLoops

                                              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
                                              
                                              	// 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 endpoint options to be used when attempting to resolve an endpoint.
                                              	EndpointOptions EndpointResolverOptions
                                              
                                              	// The service endpoint resolver.
                                              	EndpointResolver EndpointResolver
                                              
                                              	// Signature Version 4 (SigV4) Signer
                                              	HTTPSignerV4 HTTPSignerV4
                                              
                                              	// The logger writer interface to write logging messages to.
                                              	Logger logging.Logger
                                              
                                              	// The region to send requests to. (Required)
                                              	Region string
                                              
                                              	// Retryer guides how HTTP requests should be retried in case of recoverable
                                              	// failures. When nil the API client will use a default retryer.
                                              	Retryer aws.Retryer
                                              
                                              	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                              	// implementation if nil.
                                              	HTTPClient HTTPClient
                                              }

                                              func (Options) Copy

                                              func (o Options) Copy() Options

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

                                                type ResolveEndpoint

                                                type ResolveEndpoint struct {
                                                	Resolver EndpointResolver
                                                	Options  EndpointResolverOptions
                                                }

                                                func (*ResolveEndpoint) HandleSerialize

                                                func (*ResolveEndpoint) ID

                                                func (*ResolveEndpoint) ID() string

                                                type StartHumanLoopInput

                                                type StartHumanLoopInput struct {
                                                
                                                	// The Amazon Resource Name (ARN) of the flow definition associated with this human
                                                	// loop.
                                                	//
                                                	// This member is required.
                                                	FlowDefinitionArn *string
                                                
                                                	// An object that contains information about the human loop.
                                                	//
                                                	// This member is required.
                                                	HumanLoopInput *types.HumanLoopInput
                                                
                                                	// The name of the human loop.
                                                	//
                                                	// This member is required.
                                                	HumanLoopName *string
                                                
                                                	// Attributes of the specified data. Use DataAttributes to specify if your data is
                                                	// free of personally identifiable information and/or free of adult content.
                                                	DataAttributes *types.HumanLoopDataAttributes
                                                }

                                                type StartHumanLoopOutput

                                                type StartHumanLoopOutput struct {
                                                
                                                	// The Amazon Resource Name (ARN) of the human loop.
                                                	HumanLoopArn *string
                                                
                                                	// Metadata pertaining to the operation's result.
                                                	ResultMetadata middleware.Metadata
                                                }

                                                type StopHumanLoopInput

                                                type StopHumanLoopInput struct {
                                                
                                                	// The name of the human loop that you want to stop.
                                                	//
                                                	// This member is required.
                                                	HumanLoopName *string
                                                }

                                                type StopHumanLoopOutput

                                                type StopHumanLoopOutput struct {
                                                	// Metadata pertaining to the operation's result.
                                                	ResultMetadata middleware.Metadata
                                                }

                                                Directories

                                                Path Synopsis
                                                internal