package sagemakera2iruntime
import "github.com/aws/aws-sdk-go-v2/service/sagemakera2iruntime"
Package sagemakera2iruntime 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 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
- type Client
- func New(config aws.Config) *Client
- func (c *Client) DeleteHumanLoopRequest(input *DeleteHumanLoopInput) DeleteHumanLoopRequest
- func (c *Client) DescribeHumanLoopRequest(input *DescribeHumanLoopInput) DescribeHumanLoopRequest
- func (c *Client) ListHumanLoopsRequest(input *ListHumanLoopsInput) ListHumanLoopsRequest
- func (c *Client) StartHumanLoopRequest(input *StartHumanLoopInput) StartHumanLoopRequest
- func (c *Client) StopHumanLoopRequest(input *StopHumanLoopInput) StopHumanLoopRequest
- type ContentClassifier
- func (enum ContentClassifier) MarshalValue() (string, error)
- func (enum ContentClassifier) MarshalValueBuf(b []byte) ([]byte, error)
- type DeleteHumanLoopInput
- func (s DeleteHumanLoopInput) MarshalFields(e protocol.FieldEncoder) error
- func (s DeleteHumanLoopInput) String() string
- func (s *DeleteHumanLoopInput) Validate() error
- type DeleteHumanLoopOutput
- func (s DeleteHumanLoopOutput) MarshalFields(e protocol.FieldEncoder) error
- func (s DeleteHumanLoopOutput) String() string
- type DeleteHumanLoopRequest
- type DeleteHumanLoopResponse
- type DescribeHumanLoopInput
- func (s DescribeHumanLoopInput) MarshalFields(e protocol.FieldEncoder) error
- func (s DescribeHumanLoopInput) String() string
- func (s *DescribeHumanLoopInput) Validate() error
- type DescribeHumanLoopOutput
- func (s DescribeHumanLoopOutput) MarshalFields(e protocol.FieldEncoder) error
- func (s DescribeHumanLoopOutput) String() string
- type DescribeHumanLoopRequest
- type DescribeHumanLoopResponse
- type HumanLoopActivationReason
- func (s HumanLoopActivationReason) MarshalFields(e protocol.FieldEncoder) error
- func (s HumanLoopActivationReason) String() string
- type HumanLoopActivationResults
- func (s HumanLoopActivationResults) MarshalFields(e protocol.FieldEncoder) error
- func (s HumanLoopActivationResults) String() string
- type HumanLoopInputContent
- func (s HumanLoopInputContent) MarshalFields(e protocol.FieldEncoder) error
- func (s HumanLoopInputContent) String() string
- func (s *HumanLoopInputContent) Validate() error
- type HumanLoopOutputContent
- func (s HumanLoopOutputContent) MarshalFields(e protocol.FieldEncoder) error
- func (s HumanLoopOutputContent) String() string
- type HumanLoopStatus
- func (enum HumanLoopStatus) MarshalValue() (string, error)
- func (enum HumanLoopStatus) MarshalValueBuf(b []byte) ([]byte, error)
- type HumanLoopSummary
- func (s HumanLoopSummary) MarshalFields(e protocol.FieldEncoder) error
- func (s HumanLoopSummary) String() string
- type HumanReviewDataAttributes
- func (s HumanReviewDataAttributes) MarshalFields(e protocol.FieldEncoder) error
- func (s HumanReviewDataAttributes) String() string
- func (s *HumanReviewDataAttributes) Validate() error
- type ListHumanLoopsInput
- func (s ListHumanLoopsInput) MarshalFields(e protocol.FieldEncoder) error
- func (s ListHumanLoopsInput) String() string
- func (s *ListHumanLoopsInput) Validate() error
- type ListHumanLoopsOutput
- func (s ListHumanLoopsOutput) MarshalFields(e protocol.FieldEncoder) error
- func (s ListHumanLoopsOutput) String() string
- type ListHumanLoopsPaginator
- func NewListHumanLoopsPaginator(req ListHumanLoopsRequest) ListHumanLoopsPaginator
- func (p *ListHumanLoopsPaginator) CurrentPage() *ListHumanLoopsOutput
- type ListHumanLoopsRequest
- type ListHumanLoopsResponse
- type SortOrder
- func (enum SortOrder) MarshalValue() (string, error)
- func (enum SortOrder) MarshalValueBuf(b []byte) ([]byte, error)
- type StartHumanLoopInput
- func (s StartHumanLoopInput) MarshalFields(e protocol.FieldEncoder) error
- func (s StartHumanLoopInput) String() string
- func (s *StartHumanLoopInput) Validate() error
- type StartHumanLoopOutput
- func (s StartHumanLoopOutput) MarshalFields(e protocol.FieldEncoder) error
- func (s StartHumanLoopOutput) String() string
- type StartHumanLoopRequest
- type StartHumanLoopResponse
- type StopHumanLoopInput
- func (s StopHumanLoopInput) MarshalFields(e protocol.FieldEncoder) error
- func (s StopHumanLoopInput) String() string
- func (s *StopHumanLoopInput) Validate() error
- type StopHumanLoopOutput
- func (s StopHumanLoopOutput) MarshalFields(e protocol.FieldEncoder) error
- func (s StopHumanLoopOutput) String() string
- type StopHumanLoopRequest
- type StopHumanLoopResponse
Constants ¶
const ( ServiceName = "Amazon Augmented AI Runtime" // Service's name ServiceID = "SageMakerA2IRuntime" // Service's identifier EndpointsID = "a2i-runtime.sagemaker" // Service's Endpoint identifier )
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" )
Types ¶
type 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 ¶
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.
// 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 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. // // 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 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 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 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) MarshalFields ¶
func (s HumanLoopActivationReason) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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) MarshalFields ¶
func (s HumanLoopActivationResults) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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) MarshalFields ¶
func (s HumanLoopInputContent) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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) MarshalFields ¶
func (s HumanLoopOutputContent) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (HumanLoopOutputContent) String ¶
func (s HumanLoopOutputContent) 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 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 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 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 []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 (HumanReviewDataAttributes) MarshalFields ¶
func (s HumanReviewDataAttributes) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 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 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) 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 ¶
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
Enum values for SortOrder
func (SortOrder) MarshalValue ¶
func (SortOrder) MarshalValueBuf ¶
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) 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 { // 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) 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 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 ¶
api_client.go api_doc.go api_enums.go api_errors.go api_op_DeleteHumanLoop.go api_op_DescribeHumanLoop.go api_op_ListHumanLoops.go api_op_StartHumanLoop.go api_op_StopHumanLoop.go api_types.go
Directories ¶
Path | Synopsis |
---|---|
service/sagemakera2iruntime/sagemakera2iruntimeiface | Package sagemakera2iruntimeiface provides an interface to enable mocking the Amazon Augmented AI Runtime service client for testing your code. |
- Version
- v0.19.0
- Published
- Jan 30, 2020
- Platform
- windows/amd64
- Imports
- 7 packages
- Last checked
- 17 minutes ago –
Tools for package owners.