sagemakera2iruntime

package
v0.23.2 Latest Latest
Warning

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

 Go to latest Published: Jun 25, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

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

Amazon Augmented AI is in preview release and is subject to change. We do not recommend using this product in production environments.

Amazon Augmented AI (Amazon A2I) adds the benefit of human judgment to any machine learning application. When an AI application can't evaluate data with a high degree of confidence, human reviewers can take over. This human review is called a human review workflow. To create and start a human review workflow, you need three resources: a worker task template, a flow definition, and a human loop.

For information about these resources and prerequisites for using Amazon A2I, see Get Started with Amazon Augmented AI (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-getting-started.html) in the Amazon SageMaker Developer Guide.

This API reference includes information about API actions and data types that you can use to interact with Amazon A2I programmatically. Use this guide to:

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

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

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

Using the Client

To use 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 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/sagemakera2iruntime/#New

Index

Constants

View Source 
const (
	ServiceName = "Amazon Augmented AI Runtime" // Service's name
	ServiceID   = "SageMakerA2IRuntime"         // Service's identifier
	EndpointsID = "a2i-runtime.sagemaker"       // Service's Endpoint identifier
)
View Source 
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".
	//
	// We couldn't process your request because of an issue with the server. Try
	// again later.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// We couldn't find the requested resource.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// You exceeded your service quota. Delete some resources or request an increase
	// in your service quota.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// You exceeded the maximum number of requests.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The request isn't valid. Check the syntax and try again.
	ErrCodeValidationException = "ValidationException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	*aws.Client
}

Client 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.

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := sagemakera2iruntime.New(myConfig)

func (*Client) DeleteHumanLoopRequest 

func (c *Client) DeleteHumanLoopRequest(input *DeleteHumanLoopInput) DeleteHumanLoopRequest

DeleteHumanLoopRequest returns a request value for making API operation for Amazon Augmented AI Runtime.

Deletes the specified human loop for a flow definition. 

// Example sending a request using DeleteHumanLoopRequest.
req := client.DeleteHumanLoopRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeHumanLoopRequest 

func (c *Client) DescribeHumanLoopRequest(input *DescribeHumanLoopInput) DescribeHumanLoopRequest

DescribeHumanLoopRequest returns a request value for making API operation for Amazon Augmented AI Runtime.

Returns information about the specified human loop. 

// Example sending a request using DescribeHumanLoopRequest.
req := client.DescribeHumanLoopRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListHumanLoopsRequest 

func (c *Client) ListHumanLoopsRequest(input *ListHumanLoopsInput) ListHumanLoopsRequest

ListHumanLoopsRequest returns a request value for making 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. 

// Example sending a request using ListHumanLoopsRequest.
req := client.ListHumanLoopsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) StartHumanLoopRequest 

func (c *Client) StartHumanLoopRequest(input *StartHumanLoopInput) StartHumanLoopRequest

StartHumanLoopRequest returns a request value for making API operation for Amazon Augmented AI Runtime.

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

// Example sending a request using StartHumanLoopRequest.
req := client.StartHumanLoopRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) StopHumanLoopRequest 

func (c *Client) StopHumanLoopRequest(input *StopHumanLoopInput) StopHumanLoopRequest

StopHumanLoopRequest returns a request value for making API operation for Amazon Augmented AI Runtime.

Stops the specified human loop. 

// Example sending a request using StopHumanLoopRequest.
req := client.StopHumanLoopRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

type ContentClassifier 

type ContentClassifier string
const (
	ContentClassifierFreeOfPersonallyIdentifiableInformation ContentClassifier = "FreeOfPersonallyIdentifiableInformation"
	ContentClassifierFreeOfAdultContent                      ContentClassifier = "FreeOfAdultContent"
)

Enum values for ContentClassifier

func (ContentClassifier) MarshalValue 

func (enum ContentClassifier) MarshalValue() (string, error)

func (ContentClassifier) MarshalValueBuf 

func (enum ContentClassifier) MarshalValueBuf(b []byte) ([]byte, error)

type DeleteHumanLoopInput 

type DeleteHumanLoopInput struct {

	// The name of the human loop that 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) MarshalFields 

func (s DeleteHumanLoopInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields 

func (s DeleteHumanLoopOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteHumanLoopOutput) String 

func (s DeleteHumanLoopOutput) String() string

String returns the string representation

type DeleteHumanLoopRequest 

type DeleteHumanLoopRequest struct {
	*aws.Request
	Input *DeleteHumanLoopInput
	Copy  func(*DeleteHumanLoopInput) DeleteHumanLoopRequest
}

DeleteHumanLoopRequest is the request type for the DeleteHumanLoop API operation.

func (DeleteHumanLoopRequest) Send 

func (r DeleteHumanLoopRequest) Send(ctx context.Context) (*DeleteHumanLoopResponse, error)

Send marshals and sends the DeleteHumanLoop API request.

type DeleteHumanLoopResponse 

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

DeleteHumanLoopResponse is the response type for the DeleteHumanLoop API operation.

func (*DeleteHumanLoopResponse) SDKResponseMetdata 

func (r *DeleteHumanLoopResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteHumanLoop request.

type DescribeHumanLoopInput 

type DescribeHumanLoopInput struct {

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

func (DescribeHumanLoopInput) MarshalFields 

func (s DescribeHumanLoopInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 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 that identifies the type of failure.
	FailureCode *string `type:"string"`

	// The reason why a human loop failed. The failure reason is returned when the
	// status of the human loop 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. The name must be lowercase, unique within the
	// Region in your account, and can have up to 63 characters. Valid characters:
	// a-z, 0-9, and - (hyphen).
	//
	// HumanLoopName is a required field
	HumanLoopName *string `min:"1" type:"string" required:"true"`

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

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

func (DescribeHumanLoopOutput) MarshalFields 

func (s DescribeHumanLoopOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeHumanLoopOutput) String 

func (s DescribeHumanLoopOutput) String() string

String returns the string representation

type DescribeHumanLoopRequest 

type DescribeHumanLoopRequest struct {
	*aws.Request
	Input *DescribeHumanLoopInput
	Copy  func(*DescribeHumanLoopInput) DescribeHumanLoopRequest
}

DescribeHumanLoopRequest is the request type for the DescribeHumanLoop API operation.

func (DescribeHumanLoopRequest) Send 

func (r DescribeHumanLoopRequest) Send(ctx context.Context) (*DescribeHumanLoopResponse, error)

Send marshals and sends the DescribeHumanLoop API request.

type DescribeHumanLoopResponse 

type DescribeHumanLoopResponse struct {
	*DescribeHumanLoopOutput
	// contains filtered or unexported fields
}

DescribeHumanLoopResponse is the response type for the DescribeHumanLoop API operation.

func (*DescribeHumanLoopResponse) SDKResponseMetdata 

func (r *DescribeHumanLoopResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeHumanLoop request.

type HumanLoopDataAttributes 

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 []ContentClassifier `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) MarshalFields 

func (s HumanLoopDataAttributes) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HumanLoopDataAttributes) String 

func (s HumanLoopDataAttributes) String() string

String returns the string representation

func (*HumanLoopDataAttributes) Validate 

func (s *HumanLoopDataAttributes) Validate() error

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

type HumanLoopInput 

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) MarshalFields 

func (s HumanLoopInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HumanLoopInput) String 

func (s HumanLoopInput) String() string

String returns the string representation

func (*HumanLoopInput) Validate 

func (s *HumanLoopInput) Validate() error

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

type HumanLoopOutput 

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) MarshalFields 

func (s HumanLoopOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HumanLoopOutput) String 

func (s HumanLoopOutput) String() string

String returns the string representation

type HumanLoopStatus 

type HumanLoopStatus string
const (
	HumanLoopStatusInProgress HumanLoopStatus = "InProgress"
	HumanLoopStatusFailed     HumanLoopStatus = "Failed"
	HumanLoopStatusCompleted  HumanLoopStatus = "Completed"
	HumanLoopStatusStopped    HumanLoopStatus = "Stopped"
	HumanLoopStatusStopping   HumanLoopStatus = "Stopping"
)

Enum values for HumanLoopStatus

func (HumanLoopStatus) MarshalValue 

func (enum HumanLoopStatus) MarshalValue() (string, error)

func (HumanLoopStatus) MarshalValueBuf 

func (enum HumanLoopStatus) MarshalValueBuf(b []byte) ([]byte, error)

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 when the
	// status of the human loop is Failed.
	FailureReason *string `type:"string"`

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

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

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

Summary information about the human loop.

func (HumanLoopSummary) MarshalFields 

func (s HumanLoopSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HumanLoopSummary) String 

func (s HumanLoopSummary) String() string

String returns the string representation

type ListHumanLoopsInput 

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 is returned
	// in the output. You can use this token to display the next page of results.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// A token to display the next page of results.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// Optional. The order for displaying results. Valid values: Ascending and Descending.
	SortOrder SortOrder `location:"querystring" locationName:"SortOrder" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (ListHumanLoopsInput) MarshalFields 

func (s ListHumanLoopsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 that contain information about the human loops.
	//
	// HumanLoopSummaries is a required field
	HumanLoopSummaries []HumanLoopSummary `type:"list" required:"true"`

	// A token to display the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListHumanLoopsOutput) MarshalFields 

func (s ListHumanLoopsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListHumanLoopsOutput) String 

func (s ListHumanLoopsOutput) String() string

String returns the string representation

type ListHumanLoopsPaginator 

type ListHumanLoopsPaginator struct {
	aws.Pager
}

ListHumanLoopsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListHumanLoopsPaginator 

func NewListHumanLoopsPaginator(req ListHumanLoopsRequest) ListHumanLoopsPaginator

NewListHumanLoopsRequestPaginator returns a paginator for ListHumanLoops. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListHumanLoopsRequest(input)
p := sagemakera2iruntime.NewListHumanLoopsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListHumanLoopsPaginator) CurrentPage 

func (p *ListHumanLoopsPaginator) CurrentPage() *ListHumanLoopsOutput

type ListHumanLoopsRequest 

type ListHumanLoopsRequest struct {
	*aws.Request
	Input *ListHumanLoopsInput
	Copy  func(*ListHumanLoopsInput) ListHumanLoopsRequest
}

ListHumanLoopsRequest is the request type for the ListHumanLoops API operation.

func (ListHumanLoopsRequest) Send 

func (r ListHumanLoopsRequest) Send(ctx context.Context) (*ListHumanLoopsResponse, error)

Send marshals and sends the ListHumanLoops API request.

type ListHumanLoopsResponse 

type ListHumanLoopsResponse struct {
	*ListHumanLoopsOutput
	// contains filtered or unexported fields
}

ListHumanLoopsResponse is the response type for the ListHumanLoops API operation.

func (*ListHumanLoopsResponse) SDKResponseMetdata 

func (r *ListHumanLoopsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListHumanLoops request.

type SortOrder 

type SortOrder string
const (
	SortOrderAscending  SortOrder = "Ascending"
	SortOrderDescending SortOrder = "Descending"
)

Enum values for SortOrder

func (SortOrder) MarshalValue 

func (enum SortOrder) MarshalValue() (string, error)

func (SortOrder) MarshalValueBuf 

func (enum SortOrder) MarshalValueBuf(b []byte) ([]byte, error)

type StartHumanLoopInput 

type StartHumanLoopInput struct {

	// Attributes of the specified data. Use DataAttributes to specify if your data
	// is free of personally identifiable information and/or free of adult content.
	DataAttributes *HumanLoopDataAttributes `type:"structure"`

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

	// An object that contains 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) MarshalFields 

func (s StartHumanLoopInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 {

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

func (StartHumanLoopOutput) MarshalFields 

func (s StartHumanLoopOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartHumanLoopOutput) String 

func (s StartHumanLoopOutput) String() string

String returns the string representation

type StartHumanLoopRequest 

type StartHumanLoopRequest struct {
	*aws.Request
	Input *StartHumanLoopInput
	Copy  func(*StartHumanLoopInput) StartHumanLoopRequest
}

StartHumanLoopRequest is the request type for the StartHumanLoop API operation.

func (StartHumanLoopRequest) Send 

func (r StartHumanLoopRequest) Send(ctx context.Context) (*StartHumanLoopResponse, error)

Send marshals and sends the StartHumanLoop API request.

type StartHumanLoopResponse 

type StartHumanLoopResponse struct {
	*StartHumanLoopOutput
	// contains filtered or unexported fields
}

StartHumanLoopResponse is the response type for the StartHumanLoop API operation.

func (*StartHumanLoopResponse) SDKResponseMetdata 

func (r *StartHumanLoopResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartHumanLoop request.

type StopHumanLoopInput 

type StopHumanLoopInput struct {

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

func (StopHumanLoopInput) MarshalFields 

func (s StopHumanLoopInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields 

func (s StopHumanLoopOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StopHumanLoopOutput) String 

func (s StopHumanLoopOutput) String() string

String returns the string representation

type StopHumanLoopRequest 

type StopHumanLoopRequest struct {
	*aws.Request
	Input *StopHumanLoopInput
	Copy  func(*StopHumanLoopInput) StopHumanLoopRequest
}

StopHumanLoopRequest is the request type for the StopHumanLoop API operation.

func (StopHumanLoopRequest) Send 

func (r StopHumanLoopRequest) Send(ctx context.Context) (*StopHumanLoopResponse, error)

Send marshals and sends the StopHumanLoop API request.

type StopHumanLoopResponse 

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

StopHumanLoopResponse is the response type for the StopHumanLoop API operation.

func (*StopHumanLoopResponse) SDKResponseMetdata 

func (r *StopHumanLoopResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopHumanLoop request.

Source Files

View all Source files

Directories

Path Synopsis
Package sagemakera2iruntimeiface provides an interface to enable mocking the Amazon Augmented AI Runtime service client for testing your code.
 Package sagemakera2iruntimeiface 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.