augmentedairuntime

package
v1.27.0 Latest Latest
Warning

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

 Go to latest Published: Jan 2, 2020 License: Apache-2.0 Imports: 9 Imported by: 14

Documentation

Overview

Package augmentedairuntime provides the client and types for making API requests to Amazon Augmented AI Runtime.

Amazon Augmented AI (Augmented AI) (Preview) is a service that adds human judgment to any machine learning application. Human reviewers can take over when an AI application can't evaluate data with a high degree of confidence.

From fraudulent bank transaction identification to document processing to image analysis, machine learning models can be trained to make decisions as well as or better than a human. Nevertheless, some decisions require contextual interpretation, such as when you need to decide whether an image is appropriate for a given audience. Content moderation guidelines are nuanced and highly dependent on context, and they vary between countries. When trying to apply AI in these situations, you can be forced to choose between "ML only" systems with unacceptably high error rates or "human only" systems that are expensive and difficult to scale, and that slow down decision making.

This API reference includes information about API actions and data types you can use to interact with Augmented AI programmatically.

You can create a flow definition against the Augmented AI API. Provide the Amazon Resource Name (ARN) of a flow definition to integrate AI service APIs, such as Textract.AnalyzeDocument and Rekognition.DetectModerationLabels. These AI services, in turn, invoke the StartHumanLoop API, which evaluates conditions under which humans will be invoked. If humans are required, Augmented AI creates a human loop. Results of human work are available asynchronously in Amazon Simple Storage Service (Amazon S3). You can use Amazon CloudWatch Events to detect human work results.

You can find additional Augmented AI API documentation in the following reference guides: Amazon Rekognition (https://aws.amazon.com/rekognition/latest/dg/API_Reference.html), Amazon SageMaker (https://aws.amazon.com/sagemaker/latest/dg/API_Reference.html), and Amazon Textract (https://aws.amazon.com/textract/latest/dg/API_Reference.html).

See https://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07 for more information on this service.

See augmentedairuntime package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/augmentedairuntime/

Using the Client

To contact Amazon Augmented AI Runtime with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Augmented AI Runtime client AugmentedAIRuntime for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/augmentedairuntime/#New

Index

Constants

View Source 
const (
	// ContentClassifierFreeOfPersonallyIdentifiableInformation is a ContentClassifier enum value
	ContentClassifierFreeOfPersonallyIdentifiableInformation = "FreeOfPersonallyIdentifiableInformation"

	// ContentClassifierFreeOfAdultContent is a ContentClassifier enum value
	ContentClassifierFreeOfAdultContent = "FreeOfAdultContent"
)
View Source 
const (
	// HumanLoopStatusInProgress is a HumanLoopStatus enum value
	HumanLoopStatusInProgress = "InProgress"

	// HumanLoopStatusFailed is a HumanLoopStatus enum value
	HumanLoopStatusFailed = "Failed"

	// HumanLoopStatusCompleted is a HumanLoopStatus enum value
	HumanLoopStatusCompleted = "Completed"

	// HumanLoopStatusStopped is a HumanLoopStatus enum value
	HumanLoopStatusStopped = "Stopped"

	// HumanLoopStatusStopping is a HumanLoopStatus enum value
	HumanLoopStatusStopping = "Stopping"
)
View Source 
const (
	// SortOrderAscending is a SortOrder enum value
	SortOrderAscending = "Ascending"

	// SortOrderDescending is a SortOrder enum value
	SortOrderDescending = "Descending"
)
View Source 
const (

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Your request could not be processed.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// We were unable to find the requested resource.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// You have exceeded your service quota. To perform the requested action, remove
	// some of the relevant resources, or request a service quota increase.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Your request has exceeded the allowed amount of requests.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Your request was not valid. Check the syntax and try again.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "SageMaker A2I Runtime" // Name of service.
	EndpointsID = "a2i-runtime.sagemaker" // ID to lookup a service endpoint with.
	ServiceID   = "SageMaker A2I Runtime" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AugmentedAIRuntime 

type AugmentedAIRuntime struct {
	*client.Client
}

AugmentedAIRuntime provides the API operation methods for making requests to Amazon Augmented AI Runtime. See this package's package overview docs for details on the service.

AugmentedAIRuntime methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *AugmentedAIRuntime

New creates a new instance of the AugmentedAIRuntime client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a AugmentedAIRuntime client from just a session.
svc := augmentedairuntime.New(mySession)

// Create a AugmentedAIRuntime client with additional configuration
svc := augmentedairuntime.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*AugmentedAIRuntime) DeleteHumanLoop 

func (c *AugmentedAIRuntime) DeleteHumanLoop(input *DeleteHumanLoopInput) (*DeleteHumanLoopOutput, error)

DeleteHumanLoop API operation for Amazon Augmented AI Runtime.

Deletes the specified human loop for a flow definition.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Augmented AI Runtime's API operation DeleteHumanLoop for usage and error information.

Returned Error Codes:

  • ErrCodeValidationException "ValidationException" Your request was not valid. Check the syntax and try again.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We were unable to find the requested resource.

  • ErrCodeThrottlingException "ThrottlingException" Your request has exceeded the allowed amount of requests.

  • ErrCodeInternalServerException "InternalServerException" Your request could not be processed.

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/DeleteHumanLoop

func (*AugmentedAIRuntime) DeleteHumanLoopRequest 

func (c *AugmentedAIRuntime) DeleteHumanLoopRequest(input *DeleteHumanLoopInput) (req *request.Request, output *DeleteHumanLoopOutput)

DeleteHumanLoopRequest generates a "aws/request.Request" representing the client's request for the DeleteHumanLoop operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteHumanLoop for more information on using the DeleteHumanLoop API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteHumanLoopRequest method.
req, resp := client.DeleteHumanLoopRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/DeleteHumanLoop

func (*AugmentedAIRuntime) DeleteHumanLoopWithContext 

func (c *AugmentedAIRuntime) DeleteHumanLoopWithContext(ctx aws.Context, input *DeleteHumanLoopInput, opts ...request.Option) (*DeleteHumanLoopOutput, error)

DeleteHumanLoopWithContext is the same as DeleteHumanLoop with the addition of the ability to pass a context and additional request options.

See DeleteHumanLoop for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AugmentedAIRuntime) DescribeHumanLoop 

func (c *AugmentedAIRuntime) DescribeHumanLoop(input *DescribeHumanLoopInput) (*DescribeHumanLoopOutput, error)

DescribeHumanLoop API operation for Amazon Augmented AI Runtime.

Returns information about the specified human loop.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Augmented AI Runtime's API operation DescribeHumanLoop for usage and error information.

Returned Error Codes:

  • ErrCodeValidationException "ValidationException" Your request was not valid. Check the syntax and try again.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We were unable to find the requested resource.

  • ErrCodeThrottlingException "ThrottlingException" Your request has exceeded the allowed amount of requests.

  • ErrCodeInternalServerException "InternalServerException" Your request could not be processed.

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/DescribeHumanLoop

func (*AugmentedAIRuntime) DescribeHumanLoopRequest 

func (c *AugmentedAIRuntime) DescribeHumanLoopRequest(input *DescribeHumanLoopInput) (req *request.Request, output *DescribeHumanLoopOutput)

DescribeHumanLoopRequest generates a "aws/request.Request" representing the client's request for the DescribeHumanLoop operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeHumanLoop for more information on using the DescribeHumanLoop API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeHumanLoopRequest method.
req, resp := client.DescribeHumanLoopRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/DescribeHumanLoop

func (*AugmentedAIRuntime) DescribeHumanLoopWithContext 

func (c *AugmentedAIRuntime) DescribeHumanLoopWithContext(ctx aws.Context, input *DescribeHumanLoopInput, opts ...request.Option) (*DescribeHumanLoopOutput, error)

DescribeHumanLoopWithContext is the same as DescribeHumanLoop with the addition of the ability to pass a context and additional request options.

See DescribeHumanLoop for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AugmentedAIRuntime) ListHumanLoops 

func (c *AugmentedAIRuntime) ListHumanLoops(input *ListHumanLoopsInput) (*ListHumanLoopsOutput, error)

ListHumanLoops API operation for Amazon Augmented AI Runtime.

Returns information about human loops, given the specified parameters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Augmented AI Runtime's API operation ListHumanLoops for usage and error information.

Returned Error Codes:

  • ErrCodeValidationException "ValidationException" Your request was not valid. Check the syntax and try again.

  • ErrCodeThrottlingException "ThrottlingException" Your request has exceeded the allowed amount of requests.

  • ErrCodeInternalServerException "InternalServerException" Your request could not be processed.

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/ListHumanLoops

func (*AugmentedAIRuntime) ListHumanLoopsPages 

func (c *AugmentedAIRuntime) ListHumanLoopsPages(input *ListHumanLoopsInput, fn func(*ListHumanLoopsOutput, bool) bool) error

ListHumanLoopsPages iterates over the pages of a ListHumanLoops operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListHumanLoops method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListHumanLoops operation.
pageNum := 0
err := client.ListHumanLoopsPages(params,
    func(page *augmentedairuntime.ListHumanLoopsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*AugmentedAIRuntime) ListHumanLoopsPagesWithContext 

func (c *AugmentedAIRuntime) ListHumanLoopsPagesWithContext(ctx aws.Context, input *ListHumanLoopsInput, fn func(*ListHumanLoopsOutput, bool) bool, opts ...request.Option) error

ListHumanLoopsPagesWithContext same as ListHumanLoopsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AugmentedAIRuntime) ListHumanLoopsRequest 

func (c *AugmentedAIRuntime) ListHumanLoopsRequest(input *ListHumanLoopsInput) (req *request.Request, output *ListHumanLoopsOutput)

ListHumanLoopsRequest generates a "aws/request.Request" representing the client's request for the ListHumanLoops operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListHumanLoops for more information on using the ListHumanLoops API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListHumanLoopsRequest method.
req, resp := client.ListHumanLoopsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/ListHumanLoops

func (*AugmentedAIRuntime) ListHumanLoopsWithContext 

func (c *AugmentedAIRuntime) ListHumanLoopsWithContext(ctx aws.Context, input *ListHumanLoopsInput, opts ...request.Option) (*ListHumanLoopsOutput, error)

ListHumanLoopsWithContext is the same as ListHumanLoops with the addition of the ability to pass a context and additional request options.

See ListHumanLoops for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AugmentedAIRuntime) StartHumanLoop 

func (c *AugmentedAIRuntime) StartHumanLoop(input *StartHumanLoopInput) (*StartHumanLoopOutput, error)

StartHumanLoop API operation for Amazon Augmented AI Runtime.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Augmented AI Runtime's API operation StartHumanLoop for usage and error information.

Returned Error Codes:

  • ErrCodeValidationException "ValidationException" Your request was not valid. Check the syntax and try again.

  • ErrCodeThrottlingException "ThrottlingException" Your request has exceeded the allowed amount of requests.

  • ErrCodeServiceQuotaExceededException "ServiceQuotaExceededException" You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or request a service quota increase.

  • ErrCodeInternalServerException "InternalServerException" Your request could not be processed.

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/StartHumanLoop

func (*AugmentedAIRuntime) StartHumanLoopRequest 

func (c *AugmentedAIRuntime) StartHumanLoopRequest(input *StartHumanLoopInput) (req *request.Request, output *StartHumanLoopOutput)

StartHumanLoopRequest generates a "aws/request.Request" representing the client's request for the StartHumanLoop operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartHumanLoop for more information on using the StartHumanLoop API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartHumanLoopRequest method.
req, resp := client.StartHumanLoopRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/StartHumanLoop

func (*AugmentedAIRuntime) StartHumanLoopWithContext 

func (c *AugmentedAIRuntime) StartHumanLoopWithContext(ctx aws.Context, input *StartHumanLoopInput, opts ...request.Option) (*StartHumanLoopOutput, error)

StartHumanLoopWithContext is the same as StartHumanLoop with the addition of the ability to pass a context and additional request options.

See StartHumanLoop for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AugmentedAIRuntime) StopHumanLoop 

func (c *AugmentedAIRuntime) StopHumanLoop(input *StopHumanLoopInput) (*StopHumanLoopOutput, error)

StopHumanLoop API operation for Amazon Augmented AI Runtime.

Stops the specified human loop.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Augmented AI Runtime's API operation StopHumanLoop for usage and error information.

Returned Error Codes:

  • ErrCodeValidationException "ValidationException" Your request was not valid. Check the syntax and try again.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We were unable to find the requested resource.

  • ErrCodeThrottlingException "ThrottlingException" Your request has exceeded the allowed amount of requests.

  • ErrCodeInternalServerException "InternalServerException" Your request could not be processed.

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/StopHumanLoop

func (*AugmentedAIRuntime) StopHumanLoopRequest 

func (c *AugmentedAIRuntime) StopHumanLoopRequest(input *StopHumanLoopInput) (req *request.Request, output *StopHumanLoopOutput)

StopHumanLoopRequest generates a "aws/request.Request" representing the client's request for the StopHumanLoop operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopHumanLoop for more information on using the StopHumanLoop API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopHumanLoopRequest method.
req, resp := client.StopHumanLoopRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/StopHumanLoop

func (*AugmentedAIRuntime) StopHumanLoopWithContext 

func (c *AugmentedAIRuntime) StopHumanLoopWithContext(ctx aws.Context, input *StopHumanLoopInput, opts ...request.Option) (*StopHumanLoopOutput, error)

StopHumanLoopWithContext is the same as StopHumanLoop with the addition of the ability to pass a context and additional request options.

See StopHumanLoop for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type DeleteHumanLoopInput 

type DeleteHumanLoopInput struct {

	// The name of the human loop you want to delete.
	//
	// HumanLoopName is a required field
	HumanLoopName *string `location:"uri" locationName:"HumanLoopName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteHumanLoopInput) GoString 

func (s DeleteHumanLoopInput) GoString() string

GoString returns the string representation

func (*DeleteHumanLoopInput) SetHumanLoopName 

func (s *DeleteHumanLoopInput) SetHumanLoopName(v string) *DeleteHumanLoopInput

SetHumanLoopName sets the HumanLoopName field's value.

func (DeleteHumanLoopInput) String 

func (s DeleteHumanLoopInput) String() string

String returns the string representation

func (*DeleteHumanLoopInput) Validate 

func (s *DeleteHumanLoopInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteHumanLoopOutput 

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

func (DeleteHumanLoopOutput) GoString 

func (s DeleteHumanLoopOutput) GoString() string

GoString returns the string representation

func (DeleteHumanLoopOutput) String 

func (s DeleteHumanLoopOutput) String() string

String returns the string representation

type DescribeHumanLoopInput 

type DescribeHumanLoopInput struct {

	// The name of the human loop.
	//
	// HumanLoopName is a required field
	HumanLoopName *string `location:"uri" locationName:"HumanLoopName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeHumanLoopInput) GoString 

func (s DescribeHumanLoopInput) GoString() string

GoString returns the string representation

func (*DescribeHumanLoopInput) SetHumanLoopName 

func (s *DescribeHumanLoopInput) SetHumanLoopName(v string) *DescribeHumanLoopInput

SetHumanLoopName sets the HumanLoopName field's value.

func (DescribeHumanLoopInput) String 

func (s DescribeHumanLoopInput) String() string

String returns the string representation

func (*DescribeHumanLoopInput) Validate 

func (s *DescribeHumanLoopInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeHumanLoopOutput 

type DescribeHumanLoopOutput struct {

	// The timestamp when Amazon Augmented AI created the human loop.
	//
	// CreationTimestamp is a required field
	CreationTimestamp *time.Time `type:"timestamp" required:"true"`

	// A failure code denoting a specific type of failure.
	FailureCode *string `type:"string"`

	// The reason why a human loop has failed. The failure reason is returned when
	// the human loop status is Failed.
	FailureReason *string `type:"string"`

	// The Amazon Resource Name (ARN) of the flow definition.
	//
	// FlowDefinitionArn is a required field
	FlowDefinitionArn *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the human loop.
	//
	// HumanLoopArn is a required field
	HumanLoopArn *string `type:"string" required:"true"`

	// An object containing information about the human loop input.
	//
	// HumanLoopInput is a required field
	HumanLoopInput *HumanLoopInputContent `type:"structure" required:"true"`

	// The name of the human loop.
	//
	// HumanLoopName is a required field
	HumanLoopName *string `min:"1" type:"string" required:"true"`

	// An object containing information about the output of the human loop.
	HumanLoopOutput *HumanLoopOutputContent `type:"structure"`

	// The status of the human loop. Valid values:
	//
	// HumanLoopStatus is a required field
	HumanLoopStatus *string `type:"string" required:"true" enum:"HumanLoopStatus"`
	// contains filtered or unexported fields
}

func (DescribeHumanLoopOutput) GoString 

func (s DescribeHumanLoopOutput) GoString() string

GoString returns the string representation

func (*DescribeHumanLoopOutput) SetCreationTimestamp 

func (s *DescribeHumanLoopOutput) SetCreationTimestamp(v time.Time) *DescribeHumanLoopOutput

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*DescribeHumanLoopOutput) SetFailureCode 

func (s *DescribeHumanLoopOutput) SetFailureCode(v string) *DescribeHumanLoopOutput

SetFailureCode sets the FailureCode field's value.

func (*DescribeHumanLoopOutput) SetFailureReason 

func (s *DescribeHumanLoopOutput) SetFailureReason(v string) *DescribeHumanLoopOutput

SetFailureReason sets the FailureReason field's value.

func (*DescribeHumanLoopOutput) SetFlowDefinitionArn 

func (s *DescribeHumanLoopOutput) SetFlowDefinitionArn(v string) *DescribeHumanLoopOutput

SetFlowDefinitionArn sets the FlowDefinitionArn field's value.

func (*DescribeHumanLoopOutput) SetHumanLoopArn 

func (s *DescribeHumanLoopOutput) SetHumanLoopArn(v string) *DescribeHumanLoopOutput

SetHumanLoopArn sets the HumanLoopArn field's value.

func (*DescribeHumanLoopOutput) SetHumanLoopInput 

func (s *DescribeHumanLoopOutput) SetHumanLoopInput(v *HumanLoopInputContent) *DescribeHumanLoopOutput

SetHumanLoopInput sets the HumanLoopInput field's value.

func (*DescribeHumanLoopOutput) SetHumanLoopName 

func (s *DescribeHumanLoopOutput) SetHumanLoopName(v string) *DescribeHumanLoopOutput

SetHumanLoopName sets the HumanLoopName field's value.

func (*DescribeHumanLoopOutput) SetHumanLoopOutput 

func (s *DescribeHumanLoopOutput) SetHumanLoopOutput(v *HumanLoopOutputContent) *DescribeHumanLoopOutput

SetHumanLoopOutput sets the HumanLoopOutput field's value.

func (*DescribeHumanLoopOutput) SetHumanLoopStatus 

func (s *DescribeHumanLoopOutput) SetHumanLoopStatus(v string) *DescribeHumanLoopOutput

SetHumanLoopStatus sets the HumanLoopStatus field's value.

func (DescribeHumanLoopOutput) String 

func (s DescribeHumanLoopOutput) String() string

String returns the string representation

type HumanLoopActivationReason 

type HumanLoopActivationReason struct {

	// True if the specified conditions were matched to trigger the human loop.
	ConditionsMatched *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Contains information about why a human loop was triggered. If at least one activation reason is evaluated to be true, the human loop is activated.

func (HumanLoopActivationReason) GoString 

func (s HumanLoopActivationReason) GoString() string

GoString returns the string representation

func (*HumanLoopActivationReason) SetConditionsMatched 

func (s *HumanLoopActivationReason) SetConditionsMatched(v bool) *HumanLoopActivationReason

SetConditionsMatched sets the ConditionsMatched field's value.

func (HumanLoopActivationReason) String 

func (s HumanLoopActivationReason) String() string

String returns the string representation

type HumanLoopActivationResults 

type HumanLoopActivationResults struct {

	// A copy of the human loop activation conditions of the flow definition, augmented
	// with the results of evaluating those conditions on the input provided to
	// the StartHumanLoop operation.
	HumanLoopActivationConditionsEvaluationResults *string `type:"string"`

	// An object containing information about why a human loop was triggered.
	HumanLoopActivationReason *HumanLoopActivationReason `type:"structure"`
	// contains filtered or unexported fields
}

Information about the corresponding flow definition's human loop activation condition evaluation. Null if StartHumanLoop was invoked directly.

func (HumanLoopActivationResults) GoString 

func (s HumanLoopActivationResults) GoString() string

GoString returns the string representation

func (*HumanLoopActivationResults) SetHumanLoopActivationConditionsEvaluationResults 

func (s *HumanLoopActivationResults) SetHumanLoopActivationConditionsEvaluationResults(v string) *HumanLoopActivationResults

SetHumanLoopActivationConditionsEvaluationResults sets the HumanLoopActivationConditionsEvaluationResults field's value.

func (*HumanLoopActivationResults) SetHumanLoopActivationReason 

func (s *HumanLoopActivationResults) SetHumanLoopActivationReason(v *HumanLoopActivationReason) *HumanLoopActivationResults

SetHumanLoopActivationReason sets the HumanLoopActivationReason field's value.

func (HumanLoopActivationResults) String 

func (s HumanLoopActivationResults) String() string

String returns the string representation

type HumanLoopInputContent 

type HumanLoopInputContent struct {

	// Serialized input from the human loop.
	//
	// InputContent is a required field
	InputContent *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object containing the input.

func (HumanLoopInputContent) GoString 

func (s HumanLoopInputContent) GoString() string

GoString returns the string representation

func (*HumanLoopInputContent) SetInputContent 

func (s *HumanLoopInputContent) SetInputContent(v string) *HumanLoopInputContent

SetInputContent sets the InputContent field's value.

func (HumanLoopInputContent) String 

func (s HumanLoopInputContent) String() string

String returns the string representation

func (*HumanLoopInputContent) Validate 

func (s *HumanLoopInputContent) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type HumanLoopOutputContent 

type HumanLoopOutputContent struct {

	// The location of the Amazon S3 object where Amazon Augmented AI stores your
	// human loop output. The output is stored at the following location: s3://S3OutputPath/HumanLoopName/CreationTime/output.json.
	//
	// OutputS3Uri is a required field
	OutputS3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about where the human output will be stored.

func (HumanLoopOutputContent) GoString 

func (s HumanLoopOutputContent) GoString() string

GoString returns the string representation

func (*HumanLoopOutputContent) SetOutputS3Uri 

func (s *HumanLoopOutputContent) SetOutputS3Uri(v string) *HumanLoopOutputContent

SetOutputS3Uri sets the OutputS3Uri field's value.

func (HumanLoopOutputContent) String 

func (s HumanLoopOutputContent) String() string

String returns the string representation

type HumanLoopSummary 

type HumanLoopSummary struct {

	// When Amazon Augmented AI created the human loop.
	CreationTime *time.Time `type:"timestamp"`

	// The reason why the human loop failed. A failure reason is returned only when
	// the status of the human loop is Failed.
	FailureReason *string `type:"string"`

	// The Amazon Resource Name (ARN) of the flow definition.
	FlowDefinitionArn *string `type:"string"`

	// The name of the human loop.
	HumanLoopName *string `min:"1" type:"string"`

	// The status of the human loop. Valid values:
	HumanLoopStatus *string `type:"string" enum:"HumanLoopStatus"`
	// contains filtered or unexported fields
}

Summary information about the human loop.

func (HumanLoopSummary) GoString 

func (s HumanLoopSummary) GoString() string

GoString returns the string representation

func (*HumanLoopSummary) SetCreationTime 

func (s *HumanLoopSummary) SetCreationTime(v time.Time) *HumanLoopSummary

SetCreationTime sets the CreationTime field's value.

func (*HumanLoopSummary) SetFailureReason 

func (s *HumanLoopSummary) SetFailureReason(v string) *HumanLoopSummary

SetFailureReason sets the FailureReason field's value.

func (*HumanLoopSummary) SetFlowDefinitionArn 

func (s *HumanLoopSummary) SetFlowDefinitionArn(v string) *HumanLoopSummary

SetFlowDefinitionArn sets the FlowDefinitionArn field's value.

func (*HumanLoopSummary) SetHumanLoopName 

func (s *HumanLoopSummary) SetHumanLoopName(v string) *HumanLoopSummary

SetHumanLoopName sets the HumanLoopName field's value.

func (*HumanLoopSummary) SetHumanLoopStatus 

func (s *HumanLoopSummary) SetHumanLoopStatus(v string) *HumanLoopSummary

SetHumanLoopStatus sets the HumanLoopStatus field's value.

func (HumanLoopSummary) String 

func (s HumanLoopSummary) String() string

String returns the string representation

type HumanReviewDataAttributes 

type HumanReviewDataAttributes struct {

	// Declares that your content is free of personally identifiable information
	// or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk
	// workers that can view your task based on this information.
	//
	// ContentClassifiers is a required field
	ContentClassifiers []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Attributes of the data specified by the customer. Use these to describe the data to be labeled.

func (HumanReviewDataAttributes) GoString 

func (s HumanReviewDataAttributes) GoString() string

GoString returns the string representation

func (*HumanReviewDataAttributes) SetContentClassifiers 

func (s *HumanReviewDataAttributes) SetContentClassifiers(v []*string) *HumanReviewDataAttributes

SetContentClassifiers sets the ContentClassifiers field's value.

func (HumanReviewDataAttributes) String 

func (s HumanReviewDataAttributes) String() string

String returns the string representation

func (*HumanReviewDataAttributes) Validate 

func (s *HumanReviewDataAttributes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListHumanLoopsInput 

type ListHumanLoopsInput struct {

	// (Optional) The timestamp of the date when you want the human loops to begin.
	// For example, 1551000000.
	CreationTimeAfter *time.Time `location:"querystring" locationName:"CreationTimeAfter" type:"timestamp"`

	// (Optional) The timestamp of the date before which you want the human loops
	// to begin. For example, 1550000000.
	CreationTimeBefore *time.Time `location:"querystring" locationName:"CreationTimeBefore" type:"timestamp"`

	// 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 will be
	// provided in the output that you can use to resume pagination.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// A token to resume pagination.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// An optional value that specifies whether you want the results sorted in Ascending
	// or Descending order.
	SortOrder *string `location:"querystring" locationName:"SortOrder" type:"string" enum:"SortOrder"`
	// contains filtered or unexported fields
}

func (ListHumanLoopsInput) GoString 

func (s ListHumanLoopsInput) GoString() string

GoString returns the string representation

func (*ListHumanLoopsInput) SetCreationTimeAfter 

func (s *ListHumanLoopsInput) SetCreationTimeAfter(v time.Time) *ListHumanLoopsInput

SetCreationTimeAfter sets the CreationTimeAfter field's value.

func (*ListHumanLoopsInput) SetCreationTimeBefore 

func (s *ListHumanLoopsInput) SetCreationTimeBefore(v time.Time) *ListHumanLoopsInput

SetCreationTimeBefore sets the CreationTimeBefore field's value.

func (*ListHumanLoopsInput) SetMaxResults 

func (s *ListHumanLoopsInput) SetMaxResults(v int64) *ListHumanLoopsInput

SetMaxResults sets the MaxResults field's value.

func (*ListHumanLoopsInput) SetNextToken 

func (s *ListHumanLoopsInput) SetNextToken(v string) *ListHumanLoopsInput

SetNextToken sets the NextToken field's value.

func (*ListHumanLoopsInput) SetSortOrder 

func (s *ListHumanLoopsInput) SetSortOrder(v string) *ListHumanLoopsInput

SetSortOrder sets the SortOrder field's value.

func (ListHumanLoopsInput) String 

func (s ListHumanLoopsInput) String() string

String returns the string representation

func (*ListHumanLoopsInput) Validate 

func (s *ListHumanLoopsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListHumanLoopsOutput 

type ListHumanLoopsOutput struct {

	// An array of objects containing information about the human loops.
	//
	// HumanLoopSummaries is a required field
	HumanLoopSummaries []*HumanLoopSummary `type:"list" required:"true"`

	// A token to resume pagination.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListHumanLoopsOutput) GoString 

func (s ListHumanLoopsOutput) GoString() string

GoString returns the string representation

func (*ListHumanLoopsOutput) SetHumanLoopSummaries 

func (s *ListHumanLoopsOutput) SetHumanLoopSummaries(v []*HumanLoopSummary) *ListHumanLoopsOutput

SetHumanLoopSummaries sets the HumanLoopSummaries field's value.

func (*ListHumanLoopsOutput) SetNextToken 

func (s *ListHumanLoopsOutput) SetNextToken(v string) *ListHumanLoopsOutput

SetNextToken sets the NextToken field's value.

func (ListHumanLoopsOutput) String 

func (s ListHumanLoopsOutput) String() string

String returns the string representation

type StartHumanLoopInput 

type StartHumanLoopInput struct {

	// Attributes of the data specified by the customer.
	DataAttributes *HumanReviewDataAttributes `type:"structure"`

	// The Amazon Resource Name (ARN) of the flow definition.
	//
	// FlowDefinitionArn is a required field
	FlowDefinitionArn *string `type:"string" required:"true"`

	// An object containing information about the human loop.
	//
	// HumanLoopInput is a required field
	HumanLoopInput *HumanLoopInputContent `type:"structure" required:"true"`

	// The name of the human loop.
	//
	// HumanLoopName is a required field
	HumanLoopName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartHumanLoopInput) GoString 

func (s StartHumanLoopInput) GoString() string

GoString returns the string representation

func (*StartHumanLoopInput) SetDataAttributes 

func (s *StartHumanLoopInput) SetDataAttributes(v *HumanReviewDataAttributes) *StartHumanLoopInput

SetDataAttributes sets the DataAttributes field's value.

func (*StartHumanLoopInput) SetFlowDefinitionArn 

func (s *StartHumanLoopInput) SetFlowDefinitionArn(v string) *StartHumanLoopInput

SetFlowDefinitionArn sets the FlowDefinitionArn field's value.

func (*StartHumanLoopInput) SetHumanLoopInput 

func (s *StartHumanLoopInput) SetHumanLoopInput(v *HumanLoopInputContent) *StartHumanLoopInput

SetHumanLoopInput sets the HumanLoopInput field's value.

func (*StartHumanLoopInput) SetHumanLoopName 

func (s *StartHumanLoopInput) SetHumanLoopName(v string) *StartHumanLoopInput

SetHumanLoopName sets the HumanLoopName field's value.

func (StartHumanLoopInput) String 

func (s StartHumanLoopInput) String() string

String returns the string representation

func (*StartHumanLoopInput) Validate 

func (s *StartHumanLoopInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartHumanLoopOutput 

type StartHumanLoopOutput struct {

	// An object containing information about the human loop activation.
	HumanLoopActivationResults *HumanLoopActivationResults `type:"structure"`

	// The Amazon Resource Name (ARN) of the human loop.
	HumanLoopArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartHumanLoopOutput) GoString 

func (s StartHumanLoopOutput) GoString() string

GoString returns the string representation

func (*StartHumanLoopOutput) SetHumanLoopActivationResults 

func (s *StartHumanLoopOutput) SetHumanLoopActivationResults(v *HumanLoopActivationResults) *StartHumanLoopOutput

SetHumanLoopActivationResults sets the HumanLoopActivationResults field's value.

func (*StartHumanLoopOutput) SetHumanLoopArn 

func (s *StartHumanLoopOutput) SetHumanLoopArn(v string) *StartHumanLoopOutput

SetHumanLoopArn sets the HumanLoopArn field's value.

func (StartHumanLoopOutput) String 

func (s StartHumanLoopOutput) String() string

String returns the string representation

type StopHumanLoopInput 

type StopHumanLoopInput struct {

	// The name of the human loop you want to stop.
	//
	// HumanLoopName is a required field
	HumanLoopName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopHumanLoopInput) GoString 

func (s StopHumanLoopInput) GoString() string

GoString returns the string representation

func (*StopHumanLoopInput) SetHumanLoopName 

func (s *StopHumanLoopInput) SetHumanLoopName(v string) *StopHumanLoopInput

SetHumanLoopName sets the HumanLoopName field's value.

func (StopHumanLoopInput) String 

func (s StopHumanLoopInput) String() string

String returns the string representation

func (*StopHumanLoopInput) Validate 

func (s *StopHumanLoopInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopHumanLoopOutput 

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

func (StopHumanLoopOutput) GoString 

func (s StopHumanLoopOutput) GoString() string

GoString returns the string representation

func (StopHumanLoopOutput) String 

func (s StopHumanLoopOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package augmentedairuntimeiface provides an interface to enable mocking the Amazon Augmented AI Runtime service client for testing your code.
 Package augmentedairuntimeiface provides an interface to enable mocking the Amazon Augmented AI Runtime service client for testing your code.

Jump to

Keyboard shortcuts

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