aws-sdk-go: github.com/aws/aws-sdk-go/service/augmentedairuntime Index | Files | Directories

package augmentedairuntime

import "github.com/aws/aws-sdk-go/service/augmentedairuntime"

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://docs.aws.amazon.com/rekognition/latest/dg/API_Reference.html), Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/API_Reference.html), and Amazon Textract (https://docs.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

Package Files

api.go doc.go errors.go service.go

Constants

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

    // ContentClassifierFreeOfAdultContent is a ContentClassifier enum value
    ContentClassifierFreeOfAdultContent = "FreeOfAdultContent"
)
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"
)
const (
    // SortOrderAscending is a SortOrder enum value
    SortOrderAscending = "Ascending"

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

    // ErrCodeConflictException for service response error code
    // "ConflictException".
    //
    // Your request has the same name as another active human loop but has different
    // input data. You cannot start two human loops with the same name and different
    // input data.
    ErrCodeConflictException = "ConflictException"

    // 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"
)
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

type AugmentedAIRuntime Uses

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 Uses

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 Uses

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 Types:

* ValidationException
Your request was not valid. Check the syntax and try again.

* ResourceNotFoundException
We were unable to find the requested resource.

* ThrottlingException
Your request has exceeded the allowed amount of requests.

* 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 Uses

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 Uses

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 Uses

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 Types:

* ValidationException
Your request was not valid. Check the syntax and try again.

* ResourceNotFoundException
We were unable to find the requested resource.

* ThrottlingException
Your request has exceeded the allowed amount of requests.

* 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 Uses

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 Uses

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 Uses

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. If a human loop was deleted, it will not be included.

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 Types:

* ValidationException
Your request was not valid. Check the syntax and try again.

* ThrottlingException
Your request has exceeded the allowed amount of requests.

* 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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Types:

* ValidationException
Your request was not valid. Check the syntax and try again.

* ThrottlingException
Your request has exceeded the allowed amount of requests.

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

* InternalServerException
Your request could not be processed.

* ConflictException
Your request has the same name as another active human loop but has different
input data. You cannot start two human loops with the same name and different
input data.

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

func (*AugmentedAIRuntime) StartHumanLoopRequest Uses

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 Uses

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 Uses

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 Types:

* ValidationException
Your request was not valid. Check the syntax and try again.

* ResourceNotFoundException
We were unable to find the requested resource.

* ThrottlingException
Your request has exceeded the allowed amount of requests.

* 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 Uses

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 Uses

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 ConflictException Uses

type ConflictException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

Your request has the same name as another active human loop but has different input data. You cannot start two human loops with the same name and different input data.

func (*ConflictException) Code Uses

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error Uses

func (s *ConflictException) Error() string

func (ConflictException) GoString Uses

func (s ConflictException) GoString() string

GoString returns the string representation

func (*ConflictException) Message Uses

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr Uses

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID Uses

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode Uses

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String Uses

func (s ConflictException) String() string

String returns the string representation

type DeleteHumanLoopInput Uses

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 Uses

func (s DeleteHumanLoopInput) GoString() string

GoString returns the string representation

func (*DeleteHumanLoopInput) SetHumanLoopName Uses

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

SetHumanLoopName sets the HumanLoopName field's value.

func (DeleteHumanLoopInput) String Uses

func (s DeleteHumanLoopInput) String() string

String returns the string representation

func (*DeleteHumanLoopInput) Validate Uses

func (s *DeleteHumanLoopInput) Validate() error

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

type DeleteHumanLoopOutput Uses

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

func (DeleteHumanLoopOutput) GoString Uses

func (s DeleteHumanLoopOutput) GoString() string

GoString returns the string representation

func (DeleteHumanLoopOutput) String Uses

func (s DeleteHumanLoopOutput) String() string

String returns the string representation

type DescribeHumanLoopInput Uses

type DescribeHumanLoopInput struct {

    // The unique 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 Uses

func (s DescribeHumanLoopInput) GoString() string

GoString returns the string representation

func (*DescribeHumanLoopInput) SetHumanLoopName Uses

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

SetHumanLoopName sets the HumanLoopName field's value.

func (DescribeHumanLoopInput) String Uses

func (s DescribeHumanLoopInput) String() string

String returns the string representation

func (*DescribeHumanLoopInput) Validate Uses

func (s *DescribeHumanLoopInput) Validate() error

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

type DescribeHumanLoopOutput Uses

type DescribeHumanLoopOutput struct {

    // The creation time when Amazon Augmented AI created the human loop.
    //
    // CreationTime is a required field
    CreationTime *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"`

    // 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 *HumanLoopOutput `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 Uses

func (s DescribeHumanLoopOutput) GoString() string

GoString returns the string representation

func (*DescribeHumanLoopOutput) SetCreationTime Uses

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

SetCreationTime sets the CreationTime field's value.

func (*DescribeHumanLoopOutput) SetFailureCode Uses

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

SetFailureCode sets the FailureCode field's value.

func (*DescribeHumanLoopOutput) SetFailureReason Uses

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

SetFailureReason sets the FailureReason field's value.

func (*DescribeHumanLoopOutput) SetFlowDefinitionArn Uses

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

SetFlowDefinitionArn sets the FlowDefinitionArn field's value.

func (*DescribeHumanLoopOutput) SetHumanLoopArn Uses

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

SetHumanLoopArn sets the HumanLoopArn field's value.

func (*DescribeHumanLoopOutput) SetHumanLoopName Uses

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

SetHumanLoopName sets the HumanLoopName field's value.

func (*DescribeHumanLoopOutput) SetHumanLoopOutput Uses

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

SetHumanLoopOutput sets the HumanLoopOutput field's value.

func (*DescribeHumanLoopOutput) SetHumanLoopStatus Uses

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

SetHumanLoopStatus sets the HumanLoopStatus field's value.

func (DescribeHumanLoopOutput) String Uses

func (s DescribeHumanLoopOutput) String() string

String returns the string representation

type HumanLoopDataAttributes Uses

type HumanLoopDataAttributes struct {

    // Declares that your content is free of personally identifiable information
    // or adult content.
    //
    // Amazon SageMaker can restrict the Amazon Mechanical Turk workers who 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 (HumanLoopDataAttributes) GoString Uses

func (s HumanLoopDataAttributes) GoString() string

GoString returns the string representation

func (*HumanLoopDataAttributes) SetContentClassifiers Uses

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

SetContentClassifiers sets the ContentClassifiers field's value.

func (HumanLoopDataAttributes) String Uses

func (s HumanLoopDataAttributes) String() string

String returns the string representation

func (*HumanLoopDataAttributes) Validate Uses

func (s *HumanLoopDataAttributes) Validate() error

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

type HumanLoopInput Uses

type HumanLoopInput struct {

    // Serialized input from the human loop. The input must be a string representation
    // of a file in JSON format.
    //
    // InputContent is a required field
    InputContent *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

An object containing the human loop input in JSON format.

func (HumanLoopInput) GoString Uses

func (s HumanLoopInput) GoString() string

GoString returns the string representation

func (*HumanLoopInput) SetInputContent Uses

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

SetInputContent sets the InputContent field's value.

func (HumanLoopInput) String Uses

func (s HumanLoopInput) String() string

String returns the string representation

func (*HumanLoopInput) Validate Uses

func (s *HumanLoopInput) Validate() error

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

type HumanLoopOutput Uses

type HumanLoopOutput struct {

    // The location of the Amazon S3 object where Amazon Augmented AI stores your
    // human loop output.
    //
    // 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 (HumanLoopOutput) GoString Uses

func (s HumanLoopOutput) GoString() string

GoString returns the string representation

func (*HumanLoopOutput) SetOutputS3Uri Uses

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

SetOutputS3Uri sets the OutputS3Uri field's value.

func (HumanLoopOutput) String Uses

func (s HumanLoopOutput) String() string

String returns the string representation

type HumanLoopSummary Uses

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 Uses

func (s HumanLoopSummary) GoString() string

GoString returns the string representation

func (*HumanLoopSummary) SetCreationTime Uses

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

SetCreationTime sets the CreationTime field's value.

func (*HumanLoopSummary) SetFailureReason Uses

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

SetFailureReason sets the FailureReason field's value.

func (*HumanLoopSummary) SetFlowDefinitionArn Uses

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

SetFlowDefinitionArn sets the FlowDefinitionArn field's value.

func (*HumanLoopSummary) SetHumanLoopName Uses

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

SetHumanLoopName sets the HumanLoopName field's value.

func (*HumanLoopSummary) SetHumanLoopStatus Uses

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

SetHumanLoopStatus sets the HumanLoopStatus field's value.

func (HumanLoopSummary) String Uses

func (s HumanLoopSummary) String() string

String returns the string representation

type InternalServerException Uses

type InternalServerException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

Your request could not be processed.

func (*InternalServerException) Code Uses

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error Uses

func (s *InternalServerException) Error() string

func (InternalServerException) GoString Uses

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message Uses

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr Uses

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID Uses

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode Uses

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String Uses

func (s InternalServerException) String() string

String returns the string representation

type ListHumanLoopsInput Uses

type ListHumanLoopsInput struct {

    // (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 `location:"querystring" locationName:"CreationTimeAfter" type:"timestamp"`

    // (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 `location:"querystring" locationName:"CreationTimeBefore" type:"timestamp"`

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

    // 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 Uses

func (s ListHumanLoopsInput) GoString() string

GoString returns the string representation

func (*ListHumanLoopsInput) SetCreationTimeAfter Uses

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

SetCreationTimeAfter sets the CreationTimeAfter field's value.

func (*ListHumanLoopsInput) SetCreationTimeBefore Uses

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

SetCreationTimeBefore sets the CreationTimeBefore field's value.

func (*ListHumanLoopsInput) SetFlowDefinitionArn Uses

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

SetFlowDefinitionArn sets the FlowDefinitionArn field's value.

func (*ListHumanLoopsInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListHumanLoopsInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListHumanLoopsInput) SetSortOrder Uses

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

SetSortOrder sets the SortOrder field's value.

func (ListHumanLoopsInput) String Uses

func (s ListHumanLoopsInput) String() string

String returns the string representation

func (*ListHumanLoopsInput) Validate Uses

func (s *ListHumanLoopsInput) Validate() error

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

type ListHumanLoopsOutput Uses

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 Uses

func (s ListHumanLoopsOutput) GoString() string

GoString returns the string representation

func (*ListHumanLoopsOutput) SetHumanLoopSummaries Uses

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

SetHumanLoopSummaries sets the HumanLoopSummaries field's value.

func (*ListHumanLoopsOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListHumanLoopsOutput) String Uses

func (s ListHumanLoopsOutput) String() string

String returns the string representation

type ResourceNotFoundException Uses

type ResourceNotFoundException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

We were unable to find the requested resource.

func (*ResourceNotFoundException) Code Uses

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error Uses

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString Uses

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message Uses

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr Uses

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID Uses

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode Uses

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String Uses

func (s ResourceNotFoundException) String() string

String returns the string representation

type ServiceQuotaExceededException Uses

type ServiceQuotaExceededException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

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

func (*ServiceQuotaExceededException) Code Uses

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error Uses

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString Uses

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation

func (*ServiceQuotaExceededException) Message Uses

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr Uses

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID Uses

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode Uses

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String Uses

func (s ServiceQuotaExceededException) String() string

String returns the string representation

type StartHumanLoopInput Uses

type StartHumanLoopInput struct {

    // Attributes of the data specified by the customer.
    DataAttributes *HumanLoopDataAttributes `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 *HumanLoopInput `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 Uses

func (s StartHumanLoopInput) GoString() string

GoString returns the string representation

func (*StartHumanLoopInput) SetDataAttributes Uses

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

SetDataAttributes sets the DataAttributes field's value.

func (*StartHumanLoopInput) SetFlowDefinitionArn Uses

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

SetFlowDefinitionArn sets the FlowDefinitionArn field's value.

func (*StartHumanLoopInput) SetHumanLoopInput Uses

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

SetHumanLoopInput sets the HumanLoopInput field's value.

func (*StartHumanLoopInput) SetHumanLoopName Uses

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

SetHumanLoopName sets the HumanLoopName field's value.

func (StartHumanLoopInput) String Uses

func (s StartHumanLoopInput) String() string

String returns the string representation

func (*StartHumanLoopInput) Validate Uses

func (s *StartHumanLoopInput) Validate() error

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

type StartHumanLoopOutput Uses

type StartHumanLoopOutput struct {

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

func (StartHumanLoopOutput) GoString Uses

func (s StartHumanLoopOutput) GoString() string

GoString returns the string representation

func (*StartHumanLoopOutput) SetHumanLoopArn Uses

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

SetHumanLoopArn sets the HumanLoopArn field's value.

func (StartHumanLoopOutput) String Uses

func (s StartHumanLoopOutput) String() string

String returns the string representation

type StopHumanLoopInput Uses

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 Uses

func (s StopHumanLoopInput) GoString() string

GoString returns the string representation

func (*StopHumanLoopInput) SetHumanLoopName Uses

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

SetHumanLoopName sets the HumanLoopName field's value.

func (StopHumanLoopInput) String Uses

func (s StopHumanLoopInput) String() string

String returns the string representation

func (*StopHumanLoopInput) Validate Uses

func (s *StopHumanLoopInput) Validate() error

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

type StopHumanLoopOutput Uses

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

func (StopHumanLoopOutput) GoString Uses

func (s StopHumanLoopOutput) GoString() string

GoString returns the string representation

func (StopHumanLoopOutput) String Uses

func (s StopHumanLoopOutput) String() string

String returns the string representation

type ThrottlingException Uses

type ThrottlingException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

Your request has exceeded the allowed amount of requests.

func (*ThrottlingException) Code Uses

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error Uses

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString Uses

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message Uses

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr Uses

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID Uses

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode Uses

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String Uses

func (s ThrottlingException) String() string

String returns the string representation

type ValidationException Uses

type ValidationException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

Your request was not valid. Check the syntax and try again.

func (*ValidationException) Code Uses

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error Uses

func (s *ValidationException) Error() string

func (ValidationException) GoString Uses

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message Uses

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr Uses

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID Uses

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode Uses

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String Uses

func (s ValidationException) String() string

String returns the string representation

Directories

PathSynopsis
augmentedairuntimeifacePackage augmentedairuntimeiface provides an interface to enable mocking the Amazon Augmented AI Runtime service client for testing your code.

Package augmentedairuntime imports 10 packages (graph) and is imported by 6 packages. Updated 2020-03-31. Refresh now. Tools for package owners.